ALalianza
Telephone Number

Retrieve all telephone numbers on an account

Use to retrieve all telephone numbers on an account. limitedData is provided to enable large result sets to be retrieved without long retrieval times

get/v2/partition/{partitionId}/account/{accountId}/telephonenumber

Request

Path parameters

accountIdstring required

ID of account, refers to <a href="#/~schema/Account">account.id</a>

partitionIdstring required

ID of partition, reference to <a href="#/~schema/Account">account.partitionId</a>

Query parameters

limitedDataboolean

Set to true to enable large result sets to be returned.

Response

Successful operation

phoneNumberstring
referenceType'SIP_TRUNK' | 'END_USER' | 'IVR' | 'LINE_APPEARANCE' | 'LINE_HUNTGROUP' | 'TELEPHONE' | 'VFAX' | 'BUSINESS_LINE' | 'BUSINESS_LINE_HUNT_GROUP' | 'CALL_GROUP' | 'CALL_QUEUE' | 'AUTO_ATTENDANT' | 'SPECIALTY_LINE' | 'CONTACT_CENTER'

What kind of destination gets calls from this number.

referenceIdstring

The id of the destination which gets calls from this number. You can think of this as a variable refkey; what it points to depends on the referenceType.

functionType'ELS' | 'TollFree' | 'TemporaryNumber' | 'SPTN'
canAcceptSMSboolean
operationalStatus'ACTIVE' | 'STAGED'
portIdstring
servicePackageType'Usage' | 'PrimaryLocalFlatRate' | 'PrimaryLocalAndDomesticLDFlatRate' | 'SecondaryLocalFlatRate' | 'SecondaryLocalAndDomesticLDFlatRate'
accountIdstring
partitionIdstring
carrierStatus'ACTIVE' | 'ACTIVATION_ON_HOLD' | 'ACTIVATION_PENDING' | 'PORT_PENDING' | 'CANCEL_PORT' | 'CANCEL_PORT_EXPIDITED' | 'DELETE_PENDING' | 'DELETED' | 'CANCEL_PORT_COMPLETE' | 'PORT_REJECTED' | 'INVENTORY' | 'INVENTORY_CLAIMED' | 'COOLDOWN' | 'RECOVERED'
orderVersionstring
temporaryNumberstring
assignAsCallerIdboolean
byotnCarrierIdstring
ringType'StandardRing' | 'Ring1' | 'Ring2' | 'Ring3' | 'Ring4' | 'Ring5' | 'Ring6' | 'Ring7'

Default ringtype for this phone

carrierIdstring
tollFreeboolean
idstring
tagsstring[]

Optional tags for categorizing the telephone number (e.g., location, service type). Tags are stored as attributes in the Attribute Service. Format is lowercase with hyphens replacing spaces. Maximum 10 tags per number.

Changes

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