Gateway Outbound Call Reference

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:

Where <machine_name> is the host machine name of 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.

Y Required N Optional
	Name	Comment
Y	info	information about the call
N	attendee	name of the person to call
Y	phoneno	phone number
Y	firstocc	no retry after this time, set as minutes from the current time. Originally represent appointment time start time.
Y/N	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.
N	exitvxml	Call this vxml file when the call finishes.
Y/N	starturl	The starting vxml file of the outbound call. Specified as URL. Optional if startvxml is set.
N	exiturl	The exiting vxml file.
N	schedule	schedule=t if schedule this call for a later time
Y/N	calltime	scheduled call time. Must set if schedule is set. Specified as minutes from the current time.
N	selfdelete	Set selfdelete=1 to automatically remove call record after the call is made
N	sms	Set sms=1 if you want to schedule sending a SMS/text message. You must have release 8 or later.

Each call request to the gateway specifies the starting VoiceXML file or URL to the starting VoiceXML file.

Returns From The Call Request Handler

Once the Call Scheduler received the call request post, it creates a record for the call request and an HTML page is returned.

Each call record has a unique ID. This ID is embedded in the call request handler return page. To find the ID, search the string pattern [ReqId=<reqId>]. For example, reqId of 135798468 is returned as [ReqId=135798468]. This reqId can be used to get call status or remove call record from the gateway.

Call Status Handler

At the specified time in the call record, the gateway makes the call. After the call, the call record is updated. Since the gateway will not notify the client about the call status, client has to poll the gateway for call status. In order not to overload the gateway, please wait a few seconds between subsequent polls.

To check call status, send an HTTP call request to the Call Scheduler of Voicent Gateway.

Where <machine_name> is the host machine name of Voicent Gateway.

Parameters In The Request

There is only one parameter.

Y Required N Optional
	Name	Comment
Y	reqId	call record reqId

Returns From The Call Status Handler

The call status is embedded in the return HTML page. There might be a few call status because of retries. The call history also includes called time and status. To get the full history, it is recommended to use Voicent SDK.

To get a simple final status, search the string pattern ^made^ for calls made successfully and pattern ^failed^ for calls failed.

Call Removal Handler

To remove the call record from the gateway, send an HTTP request to the Call Scheduler of Voicent Gateway.

The Call Scheduler listens on port 8155. Send your request to the following URL:

Where <machine_name> is the host machine name of Voicent Gateway.

Parameters in the request

There is only one parameter.

Y Required N Optional
	Name	Comment
Y	reqId	call record reqId