|
CALLFLOW.VARIABLES.PRESET - API REQUEST
|
|
|
CALLFLOW.VARIABLES.PRESET - preset some call flow variables.
|
|
|
|
Description
|
|
|
CALLFLOW.VARIABLES.PRESET API Action is used to preset some call flow variables.
|
|
This is a very useful API action for automated call flow provisioning when a number of call flow variables need to be preset to a certain value every time a given call flow is executed by Anveo.
For example. You have a call flow (like a template) which uses CUSTOMERID variable. You need to make a new call flow copy of that "template" for every customer. Instead of modifying each new call flow manually to replace CUSTOMERID variable with the actual ID of the customer you can use CALLFLOW.VARIABLES.PRESET action to preset CUSTOMERID variable for a given call flow.
|
|
|
Arguments
|
|
CALLFLOW
Required. API KEY of an existing call flow to be copied.
ACCOUNT_NUMBER
Optional. Account number only required when call flows belongs to a sub account.
VARIABLE
Optional. VARIABLE specifies call flow variable which needs to be pre-set. Multiple VARIABLE parameters are supported. VARIABLENAME attribute is required and it specifies Call Flow Variable Name.
|
|
|
Example:
<PARAMETER NAME="CALLFLOW">fdd89f89df9f7d8s9df</PARAMETER>
<PARAMETER NAME="ACCOUNT_NUMBER">123456789</PARAMETER>
A call flow is using CUSTOMERID and VERIFICATIONCODE variables which need to be preset to 123456789 and 99887 respectively everytime time the call flow is executed.
You can initiate CALLFLOW.PRESETVARIABLES API action and pass the following:
<PARAMETER NAME="VARIABLE" VARIABLENAME="CUSTOMERID">123456789</PARAMETER>
<PARAMETER NAME="VARIABLE" VARIABLENAME="VERIFICATIONCODE">99887</PARAMETER>
|
|
Example:
A call flow is using CUSTOMERID and VERIFICATIONCODE variables which need to be preset to 123456789 and 99887 respectively everytime time the call flow is executed.
You can initiate CALLFLOW.PRESETVARIABLES API action and pass the following:
param[ACCOUNT_NUMBER]=23434323423
param[CALLFLOW]=fdd89f89df9f7d8s9df
var[CUSTOMERID]=123456789
var[VERIFICATIONCODE]=99887
|
|
|
Each parameter value needs to be URL Encoded separately.
|
|
|
|
Response
|
|
|
SUCCESS when call flow processed without errors.
|
|
|
API Request Example
|
|
<?xml version="1.0" standalone="no" ?>
<REQUEST>
<USERTOKEN>
<USERKEY>df141891e2e883904b0b294dc5bq79c1c1c13f6d</USERKEY>
</USERTOKEN>
<ACTION NAME="CALLFLOW.VARIABLES.PRESET">
<PARAMETER NAME="CALLFLOW">fdd89f89df9f7d8s9df</PARAMETER>
<PARAMETER NAME="VARIABLE" VARIABLENAME="CUSTOMERID">123456789</PARAMETER>
<PARAMETER NAME="VARIABLE" VARIABLENAME="VERIFICATIONCODE">99887</PARAMETER>
</ACTION>
</REQUEST>
|
|
https://www.anveo.com/api/v2.asp?userkey=YOURAPIKEY&action=CALLFLOW.VARIABLES.PRESET¶m[ACCOUNT_NUMBER]=23434323423¶m[CALLFLOW]=fdd89f89df9f7d8s9df&var[CUSTOMERID]=123456789&var[VERIFICATIONCODE]=99887
|
|
|
|
Response Example
|
<?xml version="1.0" standalone="no" ?>
<RESPONSE>
<RESULT>SUCCESS</RESULT>
</RESPONSE>
|
|
