Skip to main content
POST
/
calls
/
{call_control_id}
/
actions
/
playback_start
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const response = await client.calls.actions.startPlayback('call_control_id');

console.log(response.data);
{
  "data": {
    "result": "ok"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
call_control_id
string
required

Unique identifier and token for controlling the call

Body

application/json

Play audio URL request

​
audio_url
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.

Example:

"http://example.com/message.wav"

​
media_name
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.

Example:

"my_media_uploaded_to_media_storage_api"

​
loop
default:1

The number of times the audio file should be played. If supplied, the value must be an integer between 1 and 100, or the special string infinity for an endless loop.

Example:

"infinity"

​
overlay
boolean
default:false

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.

Example:

true

​
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.

Example:

"current"

​
target_legs
string
default:self

Specifies the leg or legs on which audio will be played. If supplied, the value must be either self, opposite or both.

Example:

"self"

​
cache_audio
boolean
default:true

Caches the audio file. Useful when playing the same audio file multiple times during the call.

Example:

true

​
audio_type
enum<string>
default:mp3

Specifies the type of audio provided in audio_url or playback_content.

Available options:
mp3,
wav
Example:

"wav"

​
playback_content
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

Example:

"SUQzAwAAAAADf1..."

​
client_state
string

Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.

Example:

"aGF2ZSBhIG5pY2UgZGF5ID1d"

​
command_id
string

Use this field to avoid duplicate commands. Telnyx will ignore any command with the same command_id for the same call_control_id.

Example:

"891510ac-f3e4-11e8-af5b-de00688a4901"

Response

Successful response upon making a call control command.

​
data
Call Control Command Result · object
Example:
{ "result": "ok" }