Ozeki 10 - HTTP API Commands
In Ozeki 10, there are several HTTP API commands that you can use for sending or receiving messages or phone calls. You can also find commands that can be used for manipulating or recording a call. The commands are separated into two main types, so you can easily find out which commands are for messaging which of these are for phone calls.
Command | Description |
Messaging commands | |
DeleteFile | The DeleteFile command deletes the files that you do not need anymore from a specified directory. |
ForEach | The ForEach loop command is for going through on the elements of an array which you can specify with the Array ID of it. |
GoTo | The GoTo commandrequests a specified URL and executes the OzML commands received from the URL. |
MoveFile | The MoveFile command is used for moving your source file into a specified target directory. |
ReceiveMessage | This command can be used to receive an SMS message via the SMS Gateway using HTTP polling. |
SendMessage | This method can be used to send an SMS message via the SMS Gateway. |
SendMsg | Sends a message to a specified connection. |
SendSms | The SendSms command is used for sending SMS messages to mobile phones. |
WaitForMsg | The WaitForMSG command waits for a message from a specified connection and stores its content into a variable. |
Voice commands | |
Array | The Array is a data structure which can store a fixed-size sequential collection of elements. |
AttendedTransfer | The AttendedTransfer command transfers the call during the conversation. Before transferring, the transferor must call the target party, while the transfered party changes from InCall state to Hold state. |
Beep | Plays a simple beep sound. |
BlindTransfer | The BlindTransfer command blind transfers the other party of the API extension call to a target number. It can be also used to connect two phones together. |
Call | In this command, an API extension calls a number and once the phone is picked up, a CallConnected request will be sent to the specified URL. |
CallSetup | This command sets up a call between two given telephone numbers. |
Delay | The Delay command delays the next command in the response OzML with a specified time (in seconds). |
Exit | The Exit command terminates the execution of the OzML script. |
ForwardCall | The ForwardCall command forwards a call by ID to another number while it's still in ringing state. |
Hangup | The Hangup command is used to disconnect a call. |
Hold | The Hold command is used to put both legs of the call into Hold state. |
ListActiveCalls | List calls in progress in the system with detailed information. |
ListAddressbookContacts | Retrieves addressbook contacts from Ozeki 10 filtered by the given options. |
ListAddressbookNames | This command returns with the available addressbooks from Ozeki 10. |
ListCallHistory | Get a list of call history entries meeting all the requirements specified in the parameters. |
ListExtensions | Lists configured extensions of the system. |
ListExtensionTypes | Lists available extension types in the system. It is useful for SetConfig and ListExtensions commands to specify the extension type |
Play | The Play command plays an audio file (local or downloaded from URL) when an API extension call is in progress.It is also used to play sound to chosen parties of the conversation (caller, callee or all). |
ReceiveAlarmNotification | The RecevieAlarmNotification can receive a ContactID alarm, and can perform several actions in case of a received alarm. |
Reject | The Reject command rejects an incoming call to a extension. |
Request | The command allows you to call a specified phone number and perform operations depending on call states. |
Route | The Route command routes a phone call. |
SendAlarmNotification | The SendAlarmNotification command send a Contact ID alarm message to the specified number through VoIP call. |
SendDTMF | The SendDTMF command is used to send a DTMF message to a chosen participant of the conversation. |
Speak | The Speak command converts the given text to speech and plays it to the other party of the current API extension call. |
Unhold | The Unhold command is used to put both legs of the call to InCall state. |
UserInput | The Userinput command executes commands in the current API extension call specified between nodes by the time it waits for the user to press DTMF keys. |
Var | The Var is an implicit type variable, means the compiler determines the variable's type. |
More information
- Ozeki 10 - HTTP API Commands
- HTTP API Test Guide