HTTP response commands in OzML to Api Extension Control notifications
These commands are used in responses to the Api Extension Control notifications coming from the phone system. If a client calls an api extension you
can control it with these commands. These commands are written in OzML.
To write an OzML command this is the standard form:
<command parameter="..."> 'parameter between the command nodes' </command>
An OzML response is always between <response> nodes:
<response> 'commands and parameter between the nodes' </response>
Example:
<Response> <Delay>1</Delay> <Speak>Congratulations, this is your first OzML Response command.</Speak> <Delay>2</Delay> <Speak>Have a nice day!</Speak> </Response>
Command | Description |
Response to Api Extension Control notifications: | |
Array | A data structure, which can store a fixed-size sequential collection of elements. |
BlindTransfer | Transfers the call during the conversation, and leaves the conversation. |
Call | Calls a number with a programmable API extension to make operations on the call later on. |
Delay | Delays the next command in the response command OzML with the specified time. |
DeleteFile | Deletes the source files which are not needed anymore, from a specified directory. |
ForEach | Loop command, which is for going through on the elements and items of a specified array. |
GoTo | Requests the specified URLs and executes the OzML commands received from the URL. |
Hangup | Terminates a call in progress by ID. |
MoveFile | Moves source files into specified target directories. |
Play | Plays an audio file (local or downloaded from URL) in an existing call for the parties respectively. |
ReceiveAlarmNotification | Receive an alarm notification from an alarm system using Ademco Contact ID protocol. |
Record | Records the voice of the current call. |
Reject | Rejects an incoming call to an API extension. It can be used only as first command in a response. |
SendAlarmNotification | This command can be used to send an alarm notification with Ademco Contact ID protocol. |
SendEmail | This command can be used for sending out e-mails to e-mail addresses. |
SendSms | This command can be used for sending SMS messages to mobile phones. |
Speak | Reads a text using the text to speech engine into a call in progress. |
Userinput | Executes commands between <InitialCommands></InitialCommands> nodes, than waits for the user to press DTMF keys. |
Var | An implicit type variable, means the compiler determines the variable's type. |
More information
- HTTP response commands in OzML to Third Party Call Control notifications
- HTTP response commands in OzML to API Extension Control notifications