.png){kind=logo}
Call an assigned phone extension and play an audio file. The extension can be used to broadcast the audio file via multicast for a set amount of time if multicast is configured.
Applicable Products: 8190, 8190s, 8410, 8420, 8186, 8188, 8189, 8196, 8197, 8198, 8199, 8063, 8180g2, 8301, 8305, 8312
Minimum Firmware Version: 3.3
URI
POST /api/controls/call/start
Parameters
Element | Description | Type | Required | Notes | |
|---|---|---|---|---|---|
extension | The phone extension to call. | String | Required | ||
tone | The file name of the tone to play. | String | Required | Used to call and play a tone. | |
interval | Specify how long to wait (in seconds) before the tone plays again after it ends. | String | Optional | ||
maxdur | The total time (in seconds) to play the tone on a repeated loop. | String | Optional | ||
dtmf | Enable to play DTMF tones during the call to allow interoperability with DTMF-controlled multi-zone legacy communication systems. | String | Optional |
|
Sample Request: Call extension 123. After the call connects, dial the DTMF tone 1. The device plays chime.wav repeatedly for up to 60 seconds, with a 3-second interval between playbacks.
End a call to a phone extension
End a call to a phone extension.
Applicable Products: 8190, 8190s, 8410, 8420, 8186, 8188, 8189, 8196, 8197, 8198, 8199, 8063, 8180g2, 8301, 8305, 8312
Minimum Firmware Version: 3.3
URI
POST /api/controls/call/stop
Sample Request