TelAPI

REST Documentation

View InboundXML Docs

Update Incoming Number

Many resource properties of a TelAPI incoming phone number can easily be updated via the REST API.

Request URI

Phone number properties can be updated using the HTTP POST method. The format of the URI used to make the POST request is below.

POST https://api.telapi.com/v1/Accounts/{AccountSid}/IncomingPhoneNumbers/{IncomingPhoneNumberSid}

Parameters

The following case-sensitive parameters can be used to specify the phone number property you wish to update using POST.

Parameter Description
FriendlyName
optional
User generated name for the incoming number.
VoiceUrl
optional
The URL returning InboundXML incoming calls should execute when connected.
VoiceMethod
optional
Specifies the HTTP method used to request the VoiceUrl once incoming call connects.
Default Value:
POST
Allowed Value:
POST or GET
VoiceFallbackUrl
optional
URL used if any errors occur during execution of InboundXML on a call or at initial request of the VoiceUrl.
VoiceFallbackMethod
optional
Specifies the HTTP method used to request the VoiceFallbackUrl once incoming call connects.
Default Value:
POST
Allowed Value:
POST or GET
VoiceCallerIdLookup
optional
lookup the caller's caller ID name from the CNAM database (additional charges apply).
Default Value:
false
Allowed Value:
true or false
SmsUrl
optional
The URL returning InboundXML incoming phone numbers should execute when receiving an SMS.
SmsMethod
optional
Specifies the HTTP method used to request the SmsUrl once an incoming SMS is received.
Default Value:
POST
Allowed Value:
POST or GET
SmsFallbackUrl
optional
URL used if any errors occur during execution of InboundXML from an SMS or at initial request of the SmsUrl.
SmsFallbackMethod
optional
Specifies the HTTP method used to request the SmsFallbackUrl.
Default Value:
POST
Allowed Value:
POST or GET
HeartbeatUrl
optional
URL that can be used to monitor the phone number.
HeartbeatMethod
optional
The HTTP method TelAPI will use when requesting the HeartbeatURL.
Default Value:
POST
Allowed Value:
POST or GET
HangupCallback
optional
URL that can be requested to receive notification when and how incoming call has ended.
HangupCallbackMethod
optional
The HTTP method TelAPI will use when requesting the HangupCallback URL.
Default Value:
POST
Allowed Value:
POST or GET
FaxUrl
optional
The URL returning InboundXML incoming phone numbers should execute when receiving a fax.
FaxMethod
optional
Specifies the HTTP method used to request the FaxUrl once an incoming fax is received.
Default Value:
POST
Allowed Value:
POST or GET

Example Response

Below is an what a response may look like when updating one of your TelAPI numbers.



Helper Example

Our helper libraries simplify the task of making REST API calls while programming. The code below will perform a request to TelAPI.