|
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.
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.
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.
MAXCALLDURATION
Optional. Maximum call duration time in minutes. When specified Anveo will end the call at the time provided.
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.
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 ).
ASKCONFIRMATION
Optional. Ask the called party to confirm the call by pressing 1. Possible values are: TRUE,FALSE.
MEMO
Optional. Some notes.
BILLINGCODE
Optional. Your internal billing code. Using BILLINGCODE you will be able to distinguish Anveo® fees associated with this API request.
|
|
|
Example:
<PARAMETER NAME="TEST">TRUE</PARAMETER>
<PARAMETER NAME="PHONENUMBER">12157010680</PARAMETER> where 1 is USA country Code, 215 - Area Code, 7010680 is local phone number.
<PARAMETER NAME="DESTPHONENUMBER">12157010680</PARAMETER> where 1 is USA country Code, 215 - Area Code, 7010680 is local phone number.
<PARAMETER NAME="MAXCALLDURATION">20</PARAMETER>
<PARAMETER NAME="CALLERID">12157010680</PARAMETER>
<PARAMETER NAME="DELAY">1440</PARAMETER> (24 hours delay)
<PARAMETER NAME="ASKCONFIRMATION">TRUE</PARAMETER> (for call confirmation)
<PARAMETER NAME="MEMO">Some notes for myself</PARAMETER>
<PARAMETER NAME="BILLINGCODE">123456</PARAMETER>
|
|
Example:
param[TEST]=true
param[PHONENUMBER]=12157010680
param[DESTPHONENUMBER]=12157010680
param[MAXCALLDURATION]=20
param[CALLERID]=12157010680
param[DELAY]=1440
param[ASKCONFIRMATION]=true
param[MEMO]=some%20notes
param[BILLINGCODE]=123456
|
|
|
Each parameter value needs to be URL Encoded separately.
|
|
|
|
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>
|
|
https://www.anveo.com/api/v2.asp?userkey=YOURAPIKEY&action=DIAL.CONNECT¶m[PHONENUMBER]=12157010680¶m[DESTPHONENUMBER]=12157010680¶m[MAXCALLDURATION]=20¶m[CALLERID]=12157010680¶m[DELAY]=1440¶m[ASKCONFIRMATION]=true¶m[MEMO]=some%20notes¶m[BILLINGCODE]=123456
|
|
|
Each parameter value needs to be URL Encoded separately.
|
|
|
|
Response Example
|
<?xml version="1.0" standalone="no" ?>
<RESPONSE>
<RESULT>SUCCESS</RESULT>
<VALUE NAME="REQUESTID">a3348f81491bfb538cd2dbbda9e3c43c1e88ab11</VALUE>
</RESPONSE>
|
|
|
