Use the Click-to-IVR API to dial one or more numbers and connect them to an IVR.
The Click-to-IVR API allows the user to dial one or more numbers and connect them to a configured IVR in their customer account. The user can then create placeholders for text and phone numbers that can be changed dynamically by passing the user parameters within IVR.
Click-to-IVR calls may be placed immediately or scheduled for a future date and time. Also, Click-to-IVR requests may be made on the client side (requires Public Key) or the server side (requires API Key).
The Call-Initiation API parameters listed in the following table may be needed to complete this action:
Please Note
Arguments and the response format may vary depending on the request type used.
| PARAMETER | REQUIRED | OPTIONAL |
|---|---|---|
| App | X | |
| First Caller ID | X | |
| Key | X | |
| Page | X | |
| Phone-to-Call | X | |
| PT | X | |
| Ref | X | |
| Schedule Only | X | |
| SurVo ID | X | |
| User Parameters | X |
Please Note
If the Schedule Only flag is set, refer to the "Schedule Voice Broadcast" arguments for additional parameters.
/click_to_xyz.php?app=cts&phone_to_call=8475551212&survo_id=890&key=foofoofoo
In the above-listed example, the 847-555-1212 number is called, which will starts the IVR (ID 890).
Call Connected
Scheduling Voice Broadcasts
As stated previously, the Click-to-IVR feature may be used to schedule voice broadcasts for calls in advance. To schedule voice broadcasts for future calls, follow the instructions below:
- Set the "scheduleonly" parameter by adding line "&scheduleonly" or "&scheduleonly=some_value"
- Use appropriate parameters from Scheduling Arguments table (provide link to table) to schedule voice broadcasts for future calls
The successful return message for this type of web request will be as follows:
1 Voice Broadcast(s) scheduled. Broadcast ID: 34059
The broadcast ID in the return message may be used by other API calls to modify the schedule.
Please Note: The Phone-to-Call parameter from the Call Initiation API Arguments for Click-to-IVR table is not valid with the "scheduleonly" parameter.
Server-Side Requests
For server-side requests that utilize the API key, GET, or POST method, reference the following Server-Side Requests table (provide link).
Need more background on server-side requests and why they are needed for this particular API type.
*IVR User Parameter Substitution
IVRs are able to accept values passed in user_parameters and, dynamically, substitute them in the customer IVR. This capability may be used in order to change IVR question text content, call-transfer numbers, or duration of a monitored call, on a per-call basis.
To begin, configure the user IVR with the variables for substitution. Include the named parameter in an IVR question message script, preceded by "@." In the example below, the name and date parameters are used.
API calls made will include the name and date parameters in the user_parameters section. The values included in this section will replace the "@name" and "@date" text and be read back to the caller. Parameters are submitted as a bar-delimited list of key value pairs.
https://secure.ifbyphone.com/click_to_xyz.php?app=cts&phone_to_call=8475551212&survo_id=890&key=foofoofoo&user_parameters=name|John Doe||date|May 3rd, 2015
The user may include as many key value pairs as he or she needs for each IVR question.
API Test Panel
Use the DialogTech API Wizard and Test Panel to make changes to a customer account.
Please note that this tool works with the live data in a customer account. The user must be careful when adding, editing, or deleting data.