DIAL.CALLFLOW - API REQUEST

DIAL.CALLFLOW - Initiate Anveo^® Call Flow on demand.

Description

DIAL.CALLFLOW API Action is used to dial a phone number and initiate Anveo^® Call Flow.

Arguments

TEST
Optional. Set this parameter to TRUE when submitting a test API Action.

PHONENUMBER
Required. Phone number to be dialed. The phone number should include country code and it should only contain digits without any spaces or other special characters.

CALLERID
Required. CallerID to be used when dialing a phone number. CallerID number should be valid and verified via Phone Number Verification Process.

CALLFLOW
Required. Anveo Call Flow API Key that can be obtained via Call Flow Builder screen in the Call Flow Details section.

VARIABLE
Optional. VARIABLE is used to pass a data into Call Flow and to Call Flow Variable. Multiple VARIABLEs can be passed.

DELAY
Optional. To schedule a call in the future you can specify a delay in minutes. Delay is a numeric value from 0 to 86400 ( 60 days ).

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="CALLERID">12157010680</PARAMETER>
<PARAMETER NAME="CALLFLOW">a3348f81491bfb538cd2dbbda9e3c43c1e88ab22</PARAMETER>
<PARAMETER NAME="DELAY">1440</PARAMETER> (24 hours delay)
<PARAMETER NAME="MEMO">Some notes</PARAMETER>
<PARAMETER NAME="BILLINGCODE">123456</PARAMETER>

Passing Variables example:
2 Call Flow variables with names ACCOUNTID and VERIFICATIONCODE with values 8732123 and 1453 will be passed into Call Flow
<PARAMETER NAME="VARIABLE" VARIABLENAME="ACCOUNTID">8732123</PARAMETER>
<PARAMETER NAME="VARIABLE" VARIABLENAME="VERIFICATIONCODE">1453</PARAMETER>

Response

When no errors were found Anveo will return REQUESTID value that can be used later to CANCEL this request, to retrieve Call Flow Result or to obtain call progress information.

API Request Example

<?xml version="1.0" standalone="no" ?>
<REQUEST>
	<USERTOKEN>
		<USERKEY>df141891e2e883904b0b294dc5bq79c1c1c13f6d</USERKEY>
	</USERTOKEN>
	<ACTION NAME="DIAL.CALLFLOW">
		<PARAMETER NAME="PHONENUMBER">12152152152</PARAMETER>
		<PARAMETER NAME="CALLERID">12157010680</PARAMETER>
		<PARAMETER NAME="CALLFLOW">a3348f81491bfbd30cd2dbbda9e3c43c1e88ab22</PARAMETER>
		<PARAMETER NAME="VARIABLE" VARIABLENAME="ACCOUNTID">8732123</PARAMETER>
		<PARAMETER NAME="VARIABLE" VARIABLENAME="VERIFICATIONCODE">1453</PARAMETER>
		<PARAMETER NAME="DELAY">1440</PARAMETER>
		<PARAMETER NAME="MEMO">DIAL.CALLFLOW API Action example with 2 Call Flow VARIABLES|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>