|
CLICK2CALL.BUTTON.CREATE - API REQUEST
|
|
|
CLICK2CALL.BUTTON.CREATE - Create a new Anveo ContactMe/Click2Call button.
|
|
|
|
Description
|
|
|
CLICK2CALL.BUTTON.CREATE API Action is used to create a new Anveo ContactMe/Click2Call button.
|
|
|
Arguments
|
|
ID
Required. ID of a new button. It must be unique. Maximum length is 128 characters.
|
|
Example:
<PARAMETER NAME="ID">ANVEOCLICK2CALL1000</PARAMETER>
|
|
PROFILEID
Required. An existing profile ID for this ContactMe/Click2Call button. Maximum length is 128 characters.
|
|
Example:
<PARAMETER NAME="PROFILEID">PROFILE123</PARAMETER>
|
|
BUTTONIMAGEURL
Required. A URL to a picture which should be used for the Click2Call button in Small mode. Maximum length is 512 characters.
|
|
Example:
<PARAMETER NAME="BUTTONIMAGEURL">http://www.anveo.com/c2c.png</PARAMETER>
|
|
COLORSTYLENAME
Required. Color theme. It could be one of the following 1,2,3,4,5,6,7,8,9,10,11,12,13. It must be specified even when a custom CSS theme will be used.
|
|
Example:
<PARAMETER NAME="COLORSTYLENAME">1</PARAMETER>
|
|
BUTTONTITLE
Optional. A text message to be used on the actual button (Like "Call Me"). When no BUTTONTITLE was specified a default "Call Me" text will be used. Maximum length is 32 characters.
|
|
Example:
<PARAMETER NAME="BUTTONTITLE">Ring me</PARAMETER>
|
|
HOUR24FROM
Required. Beginning of the daily time frame when calls can be placed using this buttom. Valid values 0-24.
|
|
Example:
<PARAMETER NAME="HOUR24FROM">8</PARAMETER>
|
|
HOUR24TO
Required. End of the daily time frame when calls can be placed using this buttom. Valid values 0-24.
|
|
Example:
<PARAMETER NAME="HOUR24TO">8</PARAMETER>
|
|
OFFHOURSMESSAGE
Required. End of the daily time frame when calls can be placed using this buttom. Valid values 0-24.
|
|
Example:
<PARAMETER NAME="OFFHOURSMESSAGE">I am not available.</PARAMETER>
|
|
CONFIGURATION
Required. Describes if the button is using Anveo Call Flow or it simply transfers calls to a phone number. Valid values: SIMPLE, CALLFLOW.
|
|
Example:
<PARAMETER NAME="PHONENUMBER">12157010680.</PARAMETER>
|
|
PHONENUMBER
Required for SIMPLE configuration only. The phone number to be connected to. The format: Country Code+Area Code+Phone number. For example: 12157010680 is USA phone number.
|
|
Example:
<PARAMETER NAME="PHONENUMBER">12157010680.</PARAMETER>
|
|
ASKCONFIRMATION
Required for SIMPLE configuration only. Specifies if call screening is required. When enabled Anveo will ask a called party to confirm the call before connecting to the caller. Valid values: 0 - no confirmation, 1 - require confirmation
|
|
Example:
<PARAMETER NAME="ASKCONFIRMATION">1</PARAMETER>
|
|
ALLOWCOUNTRY
Optional but highly recommended. ALLOWCOUNTRY should be used to limit a list of countries where callers can be located. Multiple ALLOWCOUNTRY is supported. Please see below a list of valid country names.
|
|
Example:
<PARAMETER NAME="ALLOWCOUNTRY">USA</PARAMETER>
<PARAMETER NAME="ALLOWCOUNTRY">CANADA</PARAMETER>
<PARAMETER NAME="ALLOWCOUNTRY">MEXICO</PARAMETER>
|
|
CALLFLOW
Required for CALLFLOW configuration only. Specifies what Anveo Call Flow should be used. Anveo Call Flow API Key that can be obtained via Call Flow Builder screen in the Call Flow Details section.
|
|
Example:
<PARAMETER NAME="CALLFLOW">a3348f81491bfb538cd2dbbda9e3c43c1e88ab22</PARAMETER>
|
|
VARIABLE
Optional, only available for CALLFLOW configuration. VARIABLE tag is used to pass a data into Call Flow and to Call Flow Variable. Multiple VARIABLE tags are supported. VARIABLENAME attribute is required and it specifies Call Flow Variable Name.
|
|
Example:
Your Anveo Call Flow is using ACCOUNTID and VERIFICATIONCODE variables. When initiating the Call Flow using DIAL.CALLFLOW API Action you would like to set these variables to 8732123 and 1453 respectively.
In order to do this you would need to provide 2 PARAMETERS as following:
<PARAMETER NAME="VARIABLE" VARIABLENAME="ACCOUNTID">8732123</PARAMETER>
<PARAMETER NAME="VARIABLE" VARIABLENAME="VERIFICATIONCODE">1453</PARAMETER>
|
|
|
Response
|
|
|
Result SUCCESS is returned when no errors were found.
|
|
|
API Request Example
|
<?xml version="1.0" standalone="no" ?>
<REQUEST>
<USERTOKEN>
<USERKEY>df141891e2e883904b0b294dc5bq79c1c1c13f6d</USERKEY>
</USERTOKEN>
<ACTION NAME="CLICK2CALL.BUTTON.CREATE">
<PARAMETER NAME="ID">ID1232123</PARAMETER>
<PARAMETER NAME="PROFILEID">PROFILEID123</PARAMETER>
<PARAMETER NAME="BUTTONIMAGEURL">http://www.someserver.com/c2c.png</PARAMETER>
<PARAMETER NAME="COLORSTYLENAME">12</PARAMETER>
<PARAMETER NAME="BUTTONTITLE">CallME</PARAMETER>
<PARAMETER NAME="CONFIGURATION">SIMPLE</PARAMETER>
<PARAMETER NAME="HOUR24FROM">9</PARAMETER>
<PARAMETER NAME="HOUR24TO">18</PARAMETER>
<PARAMETER NAME="OFFHOURSMESSAGE">Sorry, I am not available.</PARAMETER>
<PARAMETER NAME="PHONENUMBER">123456789</PARAMETER>
<PARAMETER NAME="ASKCONFIRMATION">1</PARAMETER>
</ACTION>
</REQUEST>
|
|
|
Response Example
|
<?xml version="1.0" standalone="no" ?>
<RESPONSE>
<RESULT>SUCCESS</RESULT>
</RESPONSE>
|
|
|
