Quick start 
Download 
Manual 
Install 
Contact 
Sign in OZEKI Phone System - HTTP API Commands
The HTTP API is an API available for the Ozeki Phone System that allows calls to be created, controlled and monitored, it also allows SMS messages to be sent. This is an easy to use API that can be accessed through HTTP. It can be used by call center developers, CRM developers or by any developer wishing to interact with calls taking place in a PBX.
HTTP request commandsThese commands are called using HTTP requests (HTTP GET or HTTP POST requests) initiated by the Business Application.
| Command | Description |
| Api Extension Control requests: | |
| Call | Calls a number with a programmable API extension to make operations on the call later on. |
| SendAlarmNotification | This command can be used to send an alarm notification with Ademco Contact ID protocol. |
| SendEmail | This command can be used for sending e-mail messages to e-mail addresses. |
| SendSms | This command can be used for sending SMS messages to mobile phones. |
| Third Party Call Control requests: | |
| AttendedTransfer | If getting a call, you can put it on hold and call a 2nd number, then connect the call with the 2nd number using AttendedTransfer. |
| BlindTransfer | Transfer the call during the conversation, and leave the conversation. |
| Forward | Forward a call by ID to another number if it can not be answered. |
| Hangup | Terminates a call in progress by ID. |
| Hold | Puts both legs of the call from InCall state to Hold state by ID. |
| ListActiveCalls | List calls in progress in the system with detailed information. |
| Play | Plays an audio file (local or downloaded from URL) in an existing call for the parties respectively. |
| Record | Record a call in mp3 or wav format. |
| SendDTMF | Send a DTMF message to a participant |
| Speak | Reads a text using the text to speech engine into a call in progress. |
| Unhold | Puts both legs of the call to InCall state by ID. |
| System Configuration requests: | |
| AddConfig | Adds an extension configuration to the system. |
| GetConfig | Gets extension configuration details of 1 extension from the system. |
| ListExtensions | Lists configured extensions in the system. |
| ListExtensionTypes | Lists available extension types in the system. It is useful for SetConfig and ListExtensions commands to specify the extension type. |
| ModifyConfig | Modifies already existing extension configuration in the system. |
| RemoveConfig | Removes an extension configuration from the system. |
| Reporting requests: | |
| GetCallHistory | Is used to search in the call history. The details of the search can be specified. |
If you do not want unauthenticated users to give commands to the Ozeki Phone System using the HTTP API then you can ask for their username and password. A user can give his/her username and password as parameter in every command. Find out more about user authentication.
More information
- HTTP API commands in Ozeki Phone System PBX
- Notifications of Ozeki Phone System PBX HTTP API
- Status codes of Ozeki Phone System PBX HTTP API
- Response Format of Ozeki Phone System HTTP API
- How to setup HTTP API service in Ozeki Phone System PBX
- How to control the User Authentication with HTTP API
- Learn the correct form of GET and POST HTTP requests