|
DIAL.CONNECT - API REQUEST
|
|
|
DIAL.CONNECT - dial two phone numbers and connect them together.
|
| |
|
|
|
Description
|
|
|
DIAL.CONNECT API Action is used to dial two phone numbers and connect them together in a way similar to initiating Anveo® Web Call.
|
|
|
Arguments
|
|
TEST
Optional. Set this parameter to TRUE to submit test request.
|
|
Example:
<PARAMETER NAME="TEST">TRUE</PARAMETER>
|
|
PHONENUMBER
Required. Phone number to be called first. The phone number should include country code and it should only contain digits without any spaces or other special characters.
|
|
Example:
<PARAMETER NAME="PHONENUMBER">12157010680</PARAMETER> where 1 is USA country Code, 215 - Area Code, 7010680 is local phone number.
|
|
DESTPHONENUMBER
Required. Destination phone number to be called second. The phone number should include country code and it should only contain digits without any spaces or other special characters.
|
|
Example:
<PARAMETER NAME="DESTPHONENUMBER">12157010680</PARAMETER> where 1 is USA country Code, 215 - Area Code, 7010680 is local phone number.
|
|
MAXCALLDURATION
Optional. Maximum call duration time in minutes. When specified Anveo will end the call at the time provided.
|
|
Example:
<PARAMETER NAME="MAXCALLDURATION">20</PARAMETER>
|
|
CALLERID
Optional. CallerID to be used when calling a second phone number. CallerID number should be valid and verified via Phone Number Verification Process. If no custom CallerID was specified a first phone number will be used as CallerID.
|
|
Example:
<PARAMETER NAME="CALLERID">12157010680</PARAMETER>
|
|
DELAY
Optional. To schedule a call in the future you can specify a delay in minutes. Delay value should be numeric in range 0 to 86400 ( 60 days ).
|
|
Example:
<PARAMETER NAME="DELAY">1440</PARAMETER> (24 hours delay)
|
|
MEMO
Optional. Some notes.
|
|
Example:
<PARAMETER NAME="MEMO">Some notes for myself</PARAMETER>
|
|
BILLINGCODE
Optional. Your internal billing code. Using BILLINGCODE you will be able to distinguish Anveo® fees associated with this API request.
|
|
Example:
<PARAMETER NAME="BILLINGCODE">123456</PARAMETER>
|
|
|
Response
|
|
|
When no errors were found Anveo® will return REQUESTID value that can be used later to CANCEL this request or to obtain call progress information.
|
|
|
API Request Example
|
<?xml version="1.0" standalone="no" ?>
<REQUEST>
<USERTOKEN>
<USERKEY>df141891e2e883904b0b294dc5bq79c1c1c13f6d</USERKEY>
</USERTOKEN>
<ACTION NAME="DIAL.CONNECT">
<PARAMETER NAME="PHONENUMBER">1215215215</PARAMETER>
<PARAMETER NAME="DESTPHONENUMBER">1212121212</PARAMETER>
<PARAMETER NAME="CALLERID">12157010680</PARAMETER>
<PARAMETER NAME="DELAY">1440</PARAMETER>
<PARAMETER NAME="MEMO">DIAL.CONNECT API Action example to connect 1215215215
with 1212121212 delayed by 24 hours</PARAMETER>
</ACTION>
</REQUEST>
|
|
|
|
Response Example
|
<?xml version="1.0" standalone="no" ?>
<RESPONSE>
<RESULT>SUCCESS</RESULT>
<VALUE NAME="REQUESTID">a3348f81491bfb538cd2dbbda9e3c43c1e88ab11</VALUE>
</RESPONSE>
|
|
|
|
