DID.UDPATE - API REQUEST

DID.UPDATE - Places an order for a DID(s).

Description

DID.UPDATE API Action is used to update DID configuration including call and sms forwarding options.

Filter Arguments

ACCOUNT_NUMBER
Optional. When updating DIDs from a sub-account then account number must be specified.

FILTER.DID_TYPE
Optional. Include DIDs matching DID_TYPE.

FILTER.E164
Optional. Include DIDs matching E164.

FILTER.SMS_EMAIL
Optional. Include DIDs matching SMS_EMAIL.

FILTER.SMS_URL
Optional. Include DIDs matching SMS_URL.

FILTER.CALL_FORWARD_TYPE
Optional. Include DIDs matching CALL_FORWARD_TYPE.

FILTER.CALL_FORWARD_TO
Optional. Include DIDs matching FILTER.CALL_FORWARD_TO.

FILTER.TITLE
Optional. Include DIDs with a given TITLE.

SMS Options Arguments

SMS_EMAIL
Optional. Email address where all incoming SMS messages should be forwarded. If SMS_EMAIL is not set then 'sms to email' feature is disabled. SMS_URL
Optional. HTTP URL where incoming messages should be delivered. If SMS_URL is not set then HTTP SMS delivery is disabled. SMS_PHONE
Optional. Phone Number where incoming messages will be forwarded. Phone Number format is COUNTRY CODE + AREA CODE + PHONE NUMBER. For example: 12151234564 ( forward to 1 (USA), 215(AREA CODE) and 1234564(phone number))

Call Options Arguments

CALL_FORWARD_TYPE
Optional. CALL_FORWARD_TYPE is used to specify how incoming calls should be handeled.
CALL_FORWARD_TYPE can be one of the following:
SIP_URI - is used to forward incoming calls to external SIP URI. A primary and backup SIP URI can also be specified.
CALLFLOW - is used to handle incoming calls with Anveo Call Flow.
PHONE - is used to forward incoming calls to another phone number.
SIP_REGISTERED - is used to forward incoming calls to SIP device registered with Anveo.
TRUNK - [ANVEO DIRECT ONLY] is used to forward incoming calls to SIP Trunk configured at Anveo Direct account.

CALL_FORWARD_TO
Optional. CALL_FORWARD_TO specifies the destination for CALL_FORWARD_TYPE option specified.
The format depends on the CALL_FORWARD_TO as following:

* SIP_URI - SIP URI where calls should be forwarded to. You can use $[E164]$ placeholder in SIP URI string which will be replaced with the actual Anveo phone number.It is possible specify primary and backup SIP URIs separated by comma. For example: $[e164]$@primarydomain.com,$[e164]$@seconarydomain.com
SIP URI string may contain a port as following $[E164]$@domain.com:5060

* CALLFLOW - API KEY for Anveo call flow.

* PHONE - phone number in the following format: COUNTRY CODE + AREA CODE + PHONE NUMBER. For example: 12151234564 ( forward to 1 (USA), 215(AREA CODE) and 1234564(phone number))

* SIP_REGISTERED - 'ACCOUNT' when Account Number remote party should be called (like the most SIP phones requre) or 'E164' when Anveo Phone Number remote party should be called (when forwarding to soft-switch like Asterisk and others).

* TRUNK - TRUNK ID from Anveo Direct portal.

Incoming Channels Options Arguments

CHANNELS_LIMIT
Optional. Set a limit on the number of concurrent calls for the phone number.

CHANNELS_ONDEMAND
Optional. Sets a number of 'On Demand' Channels the phone number can use. The maximum number of 'On-Demand' Channels is 5.

Example:
<PARAMETER NAME="ACCOUNT_NUMBER">3432343234</PARAMETER>
<PARAMETER NAME="FILTER.DID_TYPE">GEOGRAPHIC</PARAMETER>
<PARAMETER NAME="FILTER.E164">12129535456</PARAMETER>
<PARAMETER NAME="FILTER.SMS_EMAIL">sms@ddd.com</PARAMETER>
<PARAMETER NAME="FILTER.SMS_URL">http://api.server.com/smshandler</PARAMETER>
<PARAMETER NAME="FILTER.CALL_FORWARD_TYPE">CALLFLOW</PARAMETER>
<PARAMETER NAME="FILTER.CALL_FORWARD_TO">asd7sd8as9fsfg7fd8gg7gffsd7</PARAMETER>
<PARAMETER NAME="FILTER.TITLE">ABCDEF</PARAMETER>
<PARAMETER NAME="SMS_EMAIL">john@domain.com</PARAMETER>
<PARAMETER NAME="SMS_URL">http://www.domain.com/smshandler?from=$[from]$&message=$[message]$</PARAMETER>
<PARAMETER NAME="SMS_PHONE">12157010680</PARAMETER>
<PARAMETER NAME="CALL_FORWARD_TYPE">SIP_URI</PARAMETER>
<PARAMETER NAME="CALL_FORWARD_TO">$[e164]$@primary.com,$[e164]$@seconary.com</PARAMETER>
<PARAMETER NAME="CHANNELS_LIMIT">10</PARAMETER>
<PARAMETER NAME="CHANNELS_ONDEMAND">4</PARAMETER>

Response

Success when action was processed successfully.

API Request Example

<?xml version="1.0" standalone="no" ?>
<REQUEST>
  <USERTOKEN>
    <USERKEY>df141891e2e883904b0b294dc5bq79c1c1c13f6d</USERKEY>
  </USERTOKEN>
  <ACTION NAME="DID.UPDATE">
    <PARAMETER NAME="FILTER.E164">ALL</PARAMETER>
    <PARAMETER NAME="SMS_EMAIL">sms@domain.com</PARAMETER>
    <PARAMETER NAME="CALL_FORWARD_TYPE">SIP_URI</PARAMETER>
    <PARAMETER NAME="CALL_FORWARD_TO">$[e164]$@primary.com,$[e164]$@seconary.com</PARAMETER>
  </ACTION>
</REQUEST>

Response Example

<?xml version="1.0" standalone="no" ?>
<RESPONSE>
	<RESULT>SUCCESS</RESULT>
</RESPONSE>