TWtwilio
NumbersV1PortingPortability

Check if a single phone number can be ported to Twilio

Changed on

Check if a single phone number can be ported to Twilio

get/v1/Porting/Portability/PhoneNumber/{PhoneNumber}

Request

  • Base URL
    https://numbers.twilio.com
  • URL
    https://numbers.twilio.com/v1/Porting/Portability/PhoneNumber/{PhoneNumber}
  • Auth
    HTTP basic

Path parameters

PhoneNumberstring phone-number required

Phone number to check portability in e164 format.

Query parameters

TargetAccountSidstring

Account Sid to which the number will be ported. This can be used to determine if a sub account already has the number in its inventory or a different sub account. If this is not provided, the authenticated account will be assumed to be the target account.

AddressSidstring

Address Sid of customer to which the number will be ported.

Response

OK

phone_numberstring phone-number nullable

The phone number which portability is to be checked. Phone numbers are in E.164 format (e.g. +16175551212).

account_sidstring nullable

Account Sid that the phone number belongs to in Twilio. This is only returned for phone numbers that already exist in Twilio’s inventory and belong to your account or sub account.

portableboolean nullable

Boolean flag indicates if the phone number can be ported into Twilio through the Porting API or not.

pin_and_account_number_requiredboolean nullable

Indicates if the port in process will require a personal identification number (PIN) and an account number for this phone number. If this is true you will be required to submit both a PIN and account number from the losing carrier for this number when opening a port in request. These fields will be required in order to complete the port in process to Twilio.

not_portable_reasonstring nullable

Reason why the phone number cannot be ported into Twilio, null otherwise.

not_portable_reason_codeinteger nullable

The Portability Reason Code for the phone number if it cannot be ported into Twilio, null otherwise.

number_type'LOCAL' | 'UNKNOWN' | 'MOBILE' | 'TOLL-FREE'

The type of the requested phone number. One of LOCAL, UNKNOWN, MOBILE, TOLL-FREE.

countrystring iso-country-code nullable

Country the phone number belongs to.

urlstring uri nullable

This is the url of the request that you're trying to reach out to locate the resource.

Changes

  • v1fa37c78c3645Revision changes
    • info

      added the new optional query request parameter AddressSid

  • v1770aee798b51Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status