Play
{
"verb": "play",
"url": "https://example.com/example.mp3",
"timeoutSecs": 10,
"seekOffset": 8000,
"actionHook": "/play/action"
}
Parameters
urlstring | arrayA single URL or an array of URLs (will play in sequence) to a WAV or MP3 file.
actionHookstringWebhook that is called when the play Function completes.
earlyMediabooleanIf true and the call has not yet been answered, play the audio without answering the call.
loopnumberNumber of times to play the URL(s).
seekOffsetnumberNumber of samples to seek into the URL.
timeoutSecsnumberNumber of seconds to play the URL.
actionHook properties
The actionHook that is invoked when the play command completes will include the following properties:
| property name | description |
|---|---|
| playback_seconds | the number of seconds played |
| playback_milliseconds | the number of milliseconds played |
| playback_last_offset_pos | the last offset position in samples |