ProvisioningStatus by PhoneNumber resource

(new)

Private Beta

ProvisioningStatus resources are currently available as a Private Beta product and the information contained in this document is subject to change. This means that some features aren't yet implemented and others may be changed before the product is declared as Generally Available. Private Beta products aren't covered by a SLA.

The ProvisioningStatus by PhoneNumber resource lets you retrieve the provisioning status of a phone number across all Voice Trust Bundles. You can view detailed carrier-level provisioning information.

Properties

Name	Type	Description	PII
`account_sid`	string	The SID of the account. Pattern: `^AC[0-9a-fA-F]{32}$` Min length: 34 Max length: 34	Not PII
`bundle_sid`	string	A SID of the Voice Trust Bundle.	Not PII
`carriers`	array of strings	The list of carriers supported for the provided Voice Trust Bundle.	Not PII
`carrier_errors`	array of strings	A list of errors encountered during the provisioning of a phone number with the specified carrier.	Not PII
`carrier_name`	string	The name of the carrier where the phone number provisioning was attempted.	Not PII
`carrier_status`	string	The provisioning status of the phone number with the specified carrier. Possible values: `active`, `rejected`, `in-progress`	Not PII
`date_created`	string	The date and time when the provisioning request was initially sent to the carrier.	Not PII
`date_updated`	string	The date and time when the provisioning request was last updated by the carrier.	Not PII
`errors`	array of strings	A list of Twilio error codes associated with a phone number provisioning failure. For more information, see Twilio Error Codes. Note: The error codes might change in the future.	Not PII
`phone_number`	string	The phone number in E.164 format.	Not PII
`pn_sid`	string	The SID of the phone number subject to provisioning.	Not PII
`provisioning_status`	string	The overall provisioning status of the phone number, aggregated across all carriers in the Carriers array. Possible values: `TWILIO_REJECTED`, `TWILIO_APPROVED`, `IN_PROGRESS`	Not PII
`provisioning_type`	string	The type of Voice Trust Bundle associated with the phone number. Possible values: `US Voice Integrity`, `US Basic Branded Calling`, `US Enhanced Branded Calling`	Not PII
`regulation_sid`	string	The SID for the Voice Trust Bundle type. Possible values: `RNca63d1066fbd5e44eac02d0b3cf6d019` (US Basic Branded Calling), `RNa0b74679be7511921f4d2e3094fa6d23` (US Enhanced Branded Calling), `RN5b3660f9598883b1df4e77f77acefba0` (Voice Integrity)	Not PII

Retrieve provisioning status by phone number

GET https://voice.twilio.com/v2/PhoneNumber/{pnSidOrDid}/ProvisioningStatus

Path parameters

Name	Type	Required	Description	PII
`pnSidOrDid`	string	Yes	The phone number in E.164 format or the SID of the phone number.	Not PII

Query parameters

Name	Type	Required	Description	PII
`ProvisioningStatus`	string	No	The provisioning status of the phone number. Possible values: `TWILIO_REJECTED`, `TWILIO_APPROVED`, `IN_PROGRESS`.	Not PII

(information)

Info

The ProvisioningStatus of the phone number is an aggregate of the statuses across all carriers listed in the Carriers array. For example:

If all carrier statuses are active, the overall ProvisioningStatus is TWILIO_APPROVED.
If one or more carriers have a status of IN_PROGRESS or REJECTED, the aggregated ProvisioningStatus reflects IN_PROGRESS or TWILIO_REJECTED accordingly.

Retrieve the phone number provisioning status by phone number

1curl -X GET "https://voice.twilio.com/v2/PhoneNumber/{pnSidOrDid}/ProvisioningStatus" \
2    -u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN

Output

1{
2  "meta": {
3    "next_page_url": null,
4    "page_size": 2,
5    "previous_page_url": null
6  },
7  "results": [
8    {
9      "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
10      "bundle_sid": "BU1XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
11      "carriers": [
12        {
13          "carrier_errors": [],
14          "carrier_name": "T-Mobile",
15          "carrier_status": "active",
16          "date_created": "2025-09-03T08:51:39Z",
17          "date_updated": "2025-09-03T08:51:39Z"
18        },
19        {
20          "carrier_errors": [],
21          "carrier_name": "Verizon",
22          "carrier_status": "active",
23          "date_created": "2025-09-03T08:51:39Z",
24          "date_updated": "2025-09-03T08:51:39Z"
25        }
26      ],
27      "errors": [],
28      "phone_number": "+15082051738",
29      "pn_sid": "PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
30      "provisioning_status": "TWILIO_APPROVED",
31      "provisioning_type": "US Basic Branded Calling",
32      "regulation_sid": "RNca63d1066fbd5e44eac02d0b3cf6d019"
33    },
34    {
35      "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
36      "bundle_sid": "BU2XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
37      "carriers": [
38        {
39          "carrier_errors": [],
40          "carrier_name": "T-Mobile",
41          "carrier_status": "active",
42          "date_created": "2025-09-03T08:51:39Z",
43          "date_updated": "2025-09-03T08:51:39Z"
44        },
45        {
46          "carrier_errors": [],
47          "carrier_name": "Verizon",
48          "carrier_status": "in-progress",
49          "date_created": "2025-09-03T08:51:39Z",
50          "date_updated": "2025-09-03T08:51:39Z"
51        },
52        {
53          "carrier_errors": [],
54          "carrier_name": "AT&T",
55          "carrier_status": "active",
56          "date_created": "2025-09-03T08:51:39Z",
57          "date_updated": "2025-09-03T08:51:39Z"
58        }
59      ],
60      "errors": [],
61      "phone_number": "+15082051738",
62      "pn_sid": "PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
63      "provisioning_status": "IN_PROGRESS",
64      "provisioning_type": "US Voice Integrity",
65      "regulation_sid": "RN5b3660f9598883b1df4e77f77acefba0"
66    }
67  ]
68}