Telephone Number

Retrieve telephone number availability

Use to retrieve information about telephone number availability.<br/><br/> This does NOT check whether a telephone number is currently in use somewhere in the system, with the aim of determining it can be assigned; rather, it checks that the partition is configured to work with the rate center to which the telephone number belongs. If this reports no availability, but you are sure that the partition should be able to support the telephone number, please check the partition rate center setup.<br/><br/> This is most likely to be used in pre-validation of a telephone number port request; however, the porting flow documentation recommends use of another endpoint which accomplishes the same thing. While this endpoint is not officially deprecated, we do recommend you reference and use the other endpoint <a href="#/~operation/Rate%20Center%20Inventory/getRateCenter">here</a>.

get/v2/partition/{partitionId}/telephonenumber/{tn}/availability

Request

Path parameters

partitionIdstring required

ID of partition, refers to <a href="#/~schema/PartitionX">Partition.id</a>

tnstring required

Telephone number, 11 digits no spaces or dashes (include country code)

Response

Successful operation

prefixstring
reorderNamestring
originalReorderNamestring
namestring
abbrNamestring
msastring
zipsstring[]
wirelessboolean
statestring
countrystring
portableboolean
serviceAvailableboolean
inboundCarrierType'LEVEL_3' | 'NO_API' | 'E911' | 'TELUS' | 'TELUS_API' | 'TELUS_ONEVOICE' | 'PROVTEL' | 'VERIZON_CARIANZA' | 'ONVOY_CARIANZA' | 'LEVEL3_CARIANZA' | 'BANDWIDTH' | 'LUMEN_IMS' | 'LUMEN_VOICE_LI_ELS' | 'SINCH' | 'SERVICE_PROVIDER_CARRIER'

Changes

No recorded changes to this operation across all 1 revision of this API.