Skip to content

Latest commit

 

History

History
32 lines (20 loc) · 2.44 KB

PlayAudioUrlRequest.md

File metadata and controls

32 lines (20 loc) · 2.44 KB
Raw

PlayAudioUrlRequest

Properties

Name Type Description Notes
audioUrl String The URL of a file to be played back on the call. The URL can point to either a WAV or MP3 file. media_name and audio_url cannot be used together in one request. [optional]
mediaName String The media_name of a file to be played back on the call. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file. [optional]
loop Loopcount [optional]
overlay Boolean When enabled, audio will be mixed on top of any other audio that is actively being played back. Note that `overlay: true` will only work if there is another audio file already being played on the call. [optional]
stop String When specified, it stops the current audio being played. Specify `current` to stop the current audio being played, and to play the next file in the queue. Specify `all` to stop the current audio file being played and to also clear all audio files from the queue. [optional]
targetLegs String Specifies the leg or legs on which audio will be played. If supplied, the value must be either `self`, `opposite` or `both`. [optional]
cacheAudio Boolean Caches the audio file. Useful when playing the same audio file multiple times during the call. [optional]
audioType AudioTypeEnum Specifies the type of audio provided in `audio_url` or `playback_content`. [optional]
playbackContent String Allows a user to provide base64 encoded mp3 or wav. Note: when using this parameter, `media_url` and `media_name` in the `playback_started` and `playback_ended` webhooks will be empty [optional]
clientState String Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. [optional]
commandId String Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`. [optional]

Enum: AudioTypeEnum

Name Value
MP3 "mp3"
WAV "wav"