Telephone Number

Update destination of telephone number

Update the destination that gets calls from this telephone number.<br/><br/> One example destination is an END_USER, which results in the user's devices ringing and potentially connecting a call. Another potential destination is one of our automated systems handling the incoming call.<br/><br/> If an END_USER is the destination, and the assignAsCallerId value is "true", this call also updates the enduser calleridConfig with the phone number and sets the visibility to true.<br/><br/> This is just a convenience method, the same thing can be accomplished using <a href="#/~operation/Telephone%20Number/updateTelephoneNumberOnAccount">updateTelephoneNumberOnAccount</a>, but which requires the full telephone number account object.

put/v2/partition/{partitionId}/account/{accountId}/telephonenumber/{tn}/destination

Request

Path parameters

accountIdstring required

ID of account. Refers to <a href="#/~schema/TelephoneNumberAccountV2X">telephoneNumberAccount.accountId</a>, which refers to <a href="#/~schema/Account">account.id</a>

partitionIdstring required

ID of partition. Refers to <a href="#/~schema/TelephoneNumberAccountV2X">telephoneNumberAccount.partitionId</a>, which refers to <a href="#/~schema/PartitionX">partition.id</a>

tnstring required

Telephone number, 11 digits no spaces or dashes (include country code). Refers to <a href="#/~schema/TelephoneNumberAccountV2X">telephoneNumberAccount.phoneNumber</a>

Request body

partitionIdstring
accountIdstring
telephoneNumberstring
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.

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.

ringType'StandardRing' | 'Ring1' | 'Ring2' | 'Ring3' | 'Ring4' | 'Ring5' | 'Ring6' | 'Ring7'
assignAsCallerIdboolean
idstring

Response

Successful operation

partitionIdstring
accountIdstring
telephoneNumberstring
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.

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.

ringType'StandardRing' | 'Ring1' | 'Ring2' | 'Ring3' | 'Ring4' | 'Ring5' | 'Ring6' | 'Ring7'
assignAsCallerIdboolean
idstring

Changes

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