Click-to-IVR

Used to initiate a phone call between any one number, or list of numbers, to a pre-configured IVR within an account.

Use the Click-to-IVR API to initiate a phone call to a pre-configured IVR

The Click-to-IVR API is used to initiate a phone call between any one number, or list of numbers, to a pre-configured IVR within an account.

📘

Base URL for Click-to-IVR

https://secure.dialogtech.com/ibp_api.php

Parameter List

Parameter	Required	Accepts	Max Length	Notes	Usage
access_key	Yes	String	n/a	Access Key from the Key Manager within a DialogTech account	Credentials used for access to the API for a particular DialogTech account
secret_access_key	Yes	String	n/a	Secret Access Key from the Key Manager within a DialogTech account	Credentials used for access to the API for a particular DialogTech account
public_key	Yes	String	n/a	Public API Key from the Key Manager within a DialogTech account	This should only be used when doing a client-side Click-To-IVR and will be used in place of both the access_key and secret_access_key values
survo_id	Yes	String	n/a	The ID of the IVR being used. The IDs of the various IVRs in an account can be found under Developer Tools by selecting Building Block IDs	Defines the IVR which the caller(s) will be connected to.
action	Yes	clickto.survo	n/a	Only accepts clickto.survo for Click-to-IVR	Defines the API call as a "Click-to-IVR" type
user_parameters	No	Pipe Delimitated List of parameters. See section IVR User Parameter Substitution below.	n/a	A list of custom parameters to use within the IVR Prompts.	Custom parameters that can be utilized in text-to-speech prompts within an IVR.
p_t	No	String	n/a	Pass-through data are parameters which can be added to a clickto.survo API call, which will be included within any subsequent webhooks from that IVR for the initiated call. (See IVR WebHooks for more detailed usage).	Pass-through Data
phone_to_call	No	Unformatted Phone Number	n/a	The phone number to call. Not valid when scheduleonly is used	Defines the phone number being called to be sent to the IVR.
first_callerid	No	Unformatted Phone Number	n/a	Must be a registered number or a tracking number within the DialogTech account.	Defines the Caller ID being shown to the phone_to_call recipient
scheduleonly	No	n/a	n/a	This parameter may consist of a name without any value. No call will be placed. (i.e &scheduleonly OR &scheduleonly=1 if that is easier)	See the Scheduling Arguments Table for available scheduling parameters Failure to provide scheduling arguments will lead to this parameter being ignored
page	No	String	255	Will be stored in the Smart Click-to-Call Report	Defines the "page" the Click-to-IVR originated from.
ref	No	String	255	Will be stored in the Smart Click-to-Call Report	An available field where a custom reference can be stored

Scheduling Arguments

The following Scheduling Arguments are only available when the scheduleonly parameter is used from the table above.

Parameter	Required	Accepts	Max Length	Notes	Description
phone	Yes	Pipe delimitated list of phone numbers OR fully qualified URL to a csv containing at least 1 column called number populated with phone numbers	n/a	This parameter should not be used with phone_to_call.	Defines the recipients of the Click-to-IVR
sdate	Yes	Date/time (format YYYY-MM-DD+HH:MM)	n/a	The Start time of a broadcast is the time where the Broadcast first queues up to be processed. Note: Click-to-IVR calls must be within you broadcast start/end date AND the daily start/end times to be properly scheduled	Defines the Start Date/Time of the broadcast
edate	Yes	Date/time (format YYYY-MM-DD+HH:MM)	n/a	The End time of a broadcast is the time where the Broadcast can last queue up to be processed. Note: Click-to-IVR calls must be within you broadcast start/end date AND the daily start/end times to be properly scheduled	Defines the End Date/Time of the broadcast
dstime	Yes	time (format HH:MM)	n/a	The daily start time defines the beginning time of day calls should be queued and processed. Note: Click-to-IVR calls must be within you broadcast start/end date AND the daily start/end times to be properly scheduled	Defines the Daily Start Time of the broadcast
detime	Yes	time (format HH:MM)	n/a	The daily end time defines the last time of day calls should be queued and processed. Note: Click-to-IVR calls must be within you broadcast start/end date AND the daily start/end times to be properly scheduled	Defines the Daily End Time of the broadcast
tz	No	Eastern (default) Central Mountain Pacific Alaska Hawaii	n/a	Time zone selected must be from the list of accepted values.	Defines the time zone the Daily Start and End Times, as well as the Broadcast Start and End dates correlate to.
type	No	1 OR 2	n/a	1 - Spread Calls Evenly 2 - As Fast as Possible	Determines how calls are scheduled throughout the broadcast
attempts	No	1 (default) OR 2	n/a	1 - Do not retry failed calls (default) 2 - Retry any failed calls one time	Defines the maximum amount of times the call will be re-attempted if the call fails to reach the recipient due to a Busy signal, congestion, or other issue in trying to connect to the recipient. NOTE: This does not apply to voicemails as voicemails are valid recipients of broadcasts
retry	No	5 (default), 10, 15, 30, 60, 90, 120	n/a	retry value selected must be from the list of accepted values.	Defines the minutes between a call failure and any retry attempts. Note: attempts must be enabled
simul	No	Integer	n/a	The maximum value is based on the number of available smart broadcast ports within the account.	Defines the number of simultaneous calls to be placed. This is based on the number of available smart broadcast ports within the account.
cid	No	Unformatted Phone Number	n/a	Must be a registered number or a tracking number within the DialogTech account.	Defines the Caller ID being shown to the broadcast recipient(s)
desc	No	String	32	Default is My SurVo Broadcast	Identifier for the Voice Broadcast used on account's broadcast management page.

Using this API

When requesting the click-to-call API, the client side response will only populate after the first leg of the call is answered or not. The response will be a plain-text string indicating the success/failure of the first leg of the call.

Example Responses

Client Side Response

"Call Connected"

Server Side Response

<response>
<result>success</result>
<result_description>Call Connected</result_description>
<sid>1503112581994d3a</sid>
</response>

Server Side Response For Broadcast

<response>
<result>success</result>
<result_description>1 Voice Broadcast(s) scheduled. Broadcast ID: 4887</result_description>
<basic_broadcast_id>4887</basic_broadcast_id>
<survo_id>890</survo_id>
</response>