Call a phone extension and play an audio file

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	This parameter is available in firmware version 5.7 and later. Use a comma to insert a pause between DTMF tones. Each comma (`,`) represents a 500 ms delay. For example: `"dtmf": "12"`: The device plays tone 1 followed immediately by tone 2 (no pause). `"dtmf": "1,2"`: The device plays tone 1, waits 500 ms, then plays tone 2. `"dtmf": "1,,2"`: The device plays DTMF tone 1, waits 1000 ms, then plays tone 2. Maximum length: 15 characters.

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.

POST https://10.12.123.12/api/controls/call/start
{
	"extension": "123",
	"dtmf": "1",
	"tone": "chime.wav",
	"interval": "3",
	"maxdur": "60"
}

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

POST https://10.12.123.12/api/controls/call/stop