Skip to main content

Play audio URL

POST 
/calls/:call_control_id/actions/playback_start

Play an audio file on the call. If multiple play audio commands are consecutively issued, the audio files will be placed in a queue awaiting playback.

Notes:

  • when 'overlay' is enabled, 'loop' is limited to 1, and 'target_legs' is limited to 'self'.
  • A customer cannot Play Audio with overlay=true unless there is a Play Audio with overlay=false actively playing.

Expected Webhooks:

  • Playback started
  • Playback ended

Request

Responses

200:

Successful response

422:

Error response