Outbound Call Request Reference | Gateway Tutorial

Voicent Gateway contains an outbound Call Scheduler. The Call Scheduler has an HTTP interface.

Please note that although this interface is relatively stable, it is subject to change in future releases. If this is going to be a problem for you, please use the gateway SDK instead. The gateway SDK API hides most of the details of the Call Scheduler interface, thus it is easier to use and more stable.

Call Request Handler

To make an outbound call, simply send an HTTP call request to the call scheduler of Voicent Gateway.

The call scheduler listens on port 8155. Send your request to the following URL:

http://MACHINE_NAME:8155/ocall/callreqHandler.jsp

Where MACHINE_NAME is the host machine name of the Voicent Gateway.

Parameters in the Call Request

The following are legal call request parameters. Traditionally, these names are used for AutoReminder, but they have generic meanings now.

Action	Name	Details
Required	info	Information about the call.
Optional	attendee	Name of the person to call.
Required	phoneno	Phone number.
Required	firstocc	No retry after this time, set as minutes from the current time. Originally represent appointment start time.
Required	startvxml	The starting VXML file of the outbound call. Specified as the full file path name on the gateway machine. Optional if starturl is set.
Optional	exitvxml	Call this VXML file when the call finishes.
Required	starturl	The starting VXML file of the outbound call. Specified as a URL. Optional if startvxml is set.
Optional	exiturl	The exiting VXML file.
Optional	schedule	Schedule call for a later time
Required	calltime	Scheduled call time. Must set if schedule is set. Specified as minutes from the current time.
Optional	selfdelete	Set selfdelte=1 to automatically remove call record after the call is made.
Optional	sms	Set sms=1 if you want to schedule sending a SMS/text message. You must have release 8 or later.