Skip to main content
POST
/
conferences
/
{id}
/
actions
/
play
JavaScript
import Telnyx from 'telnyx';

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

const response = await client.conferences.actions.play('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

​
id
string
required

Uniquely identifies the conference by id or name

Body

application/json
​
audio_url
string

The URL of a file to be played back in the conference. 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 in the conference. 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"

​
call_control_ids
string[]

List of call control ids identifying participants the audio file should be played to. If not given, the audio file will be played to the entire conference.

​
region
enum<string>

Region where the conference data is located. Defaults to the region defined in user's data locality settings (Europe or US).

Available options:
Australia,
Europe,
Middle East,
US
Example:

"US"

Response

Successful response upon making a conference command.

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