Dial a new conference participant

POST

texml

Accounts

{account_sid}

Conferences

{conference_sid}

Participants

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.texml.accounts.conferences.participants.participants(
  'conference_sid',
  { account_sid: 'account_sid' },
);

console.log(response.account_sid);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
response = client.texml.accounts.conferences.participants.participants(
    conference_sid="conference_sid",
    account_sid="account_sid",
)
print(response.account_sid)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	response, err := client.Texml.Accounts.Conferences.Participants.Participants(
		context.TODO(),
		"conference_sid",
		telnyx.TexmlAccountConferenceParticipantParticipantsParams{
			AccountSid: "account_sid",
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.AccountSid)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.texml.accounts.conferences.participants.ParticipantParticipantsParams;
import com.telnyx.sdk.models.texml.accounts.conferences.participants.ParticipantParticipantsResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        ParticipantParticipantsParams params = ParticipantParticipantsParams.builder()
            .accountSid("account_sid")
            .conferenceSid("conference_sid")
            .build();
        ParticipantParticipantsResponse response = client.texml().accounts().conferences().participants().participants(params);
    }
}

require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

response = telnyx.texml.accounts.conferences.participants.participants("conference_sid", account_sid: "account_sid")

puts(response)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $response = $client->texml->accounts->conferences->participants->participants(
    'conference_sid',
    accountSid: 'account_sid',
    amdStatusCallback: 'https://www.example.com/amd_result',
    amdStatusCallbackMethod: 'GET',
    applicationSid: '1846572522338780702',
    beep: 'onExit',
    callerID: 'Info',
    callSidToCoach: 'v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ',
    cancelPlaybackOnDetectMessageEnd: false,
    cancelPlaybackOnMachineDetection: false,
    coaching: false,
    conferenceRecord: 'record-from-start',
    conferenceRecordingStatusCallback: 'https://example.com/conference_recording_status_callback',
    conferenceRecordingStatusCallbackEvent: 'in-progress completed failed absent',
    conferenceRecordingStatusCallbackMethod: 'GET',
    conferenceRecordingTimeout: 5,
    conferenceStatusCallback: 'https://example.com/conference_status_callback',
    conferenceStatusCallbackEvent: 'start end join leave',
    conferenceStatusCallbackMethod: 'GET',
    conferenceTrim: 'trim-silence',
    customHeaders: [['name' => 'X-Custom-Header', 'value' => 'custom-value']],
    earlyMedia: true,
    endConferenceOnExit: true,
    from: '+12065550200',
    label: 'customer',
    machineDetection: 'Enable',
    machineDetectionSilenceTimeout: 2000,
    machineDetectionSpeechEndThreshold: 2000,
    machineDetectionSpeechThreshold: 2000,
    machineDetectionTimeout: 1000,
    maxParticipants: 30,
    muted: true,
    preferredCodecs: 'PCMA,PCMU',
    record: false,
    recordingChannels: 'dual',
    recordingStatusCallback: 'https://example.com/recording_status_callback',
    recordingStatusCallbackEvent: 'in-progress completed absent',
    recordingStatusCallbackMethod: 'GET',
    recordingTrack: 'inbound',
    sipAuthPassword: '1234',
    sipAuthUsername: 'user',
    startConferenceOnEnter: false,
    statusCallback: 'https://www.example.com/callback',
    statusCallbackEvent: 'answered completed',
    statusCallbackMethod: 'GET',
    timeLimit: 30,
    timeoutSeconds: 30,
    to: '+12065550100',
    trim: 'trim-silence',
    waitURL: 'https://www.example.com/wait_music.mp3',
  );

  var_dump($response);
} catch (APIException $e) {
  echo $e->getMessage();
}

curl --request POST \
  --url https://api.telnyx.com/v2/texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'To=+12065550100' \
  --data 'From=+12065550200'

{
  "account_sid": "4e71926f-8f13-450e-b91c-23c2ef786aa6",
  "call_sid": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ",
  "coaching": false,
  "conference_sid": "cd5a70f4-759b-4d5e-9c06-88c00f16f3c1",
  "end_conference_on_exit": false,
  "hold": false,
  "muted": false,
  "status": "completed",
  "uri": "/v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1/Participants/v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ.json"
}

{
  "errors": [
    {
      "detail": "Resource not found"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

account_sid

string

required

The UUID of the Telnyx account that owns the resource, for example f5586561-8ff0-4291-a51b-c7dfe4139ff9. The account_sid path segment is kept for Twilio API compatibility, but the value is a Telnyx account UUID, not a Twilio AC... SID. It must match the account that owns the API key used to authenticate the request, otherwise the endpoint returns 404. The same value is sent as AccountSid in TeXML webhooks.

Example:

"f5586561-8ff0-4291-a51b-c7dfe4139ff9"

conference_sid

string

required

The ConferenceSid that uniquely identifies a conference.

Body

application/x-www-form-urlencoded

Dial Conference Participant request object

Beep

enum<string>

Whether to play a notification beep to the conference when the participant enters and exits.

Available options:

true,

false,

onEnter,

onExit

Example:

"onExit"

StatusCallback

string

URL destination for Telnyx to send status callback events to for the call.

Example:

"https://www.example.com/callback"

StatusCallbackMethod

enum<string>

HTTP request type used for StatusCallback.

Available options:

GET,

POST

Example:

"GET"

StatusCallbackEvent

string

The changes to the call's state that should generate a call to StatusCallback. Can be: initiated, ringing, answered, and completed. Separate multiple values with a space. The default value is completed.

Example:

"answered completed"

string

The phone number of the called party. Phone numbers are formatted with a + and country code.

Example:

"+16175551212"

From

string

The phone number of the party that initiated the call. Phone numbers are formatted with a + and country code.

Example:

"+16175551212"

Timeout

integer

The number of seconds that we should allow the phone to ring before assuming there is no answer. Can be an integer between 5 and 120, inclusive. The default value is 30.

Example:

30

Muted

boolean

Whether the participant should be muted.

Example:

true

StartConferenceOnEnter

boolean

Whether to start the conference when the participant enters. Defaults to true.

Example:

false

EndConferenceOnExit

boolean

Whether to end the conference when the participant leaves. Defaults to false.

Example:

true

Label

string

A unique label for the participant that will be added to the conference. The label can be used to reference the participant for updates via the TeXML REST API.

Example:

"customer"

EarlyMedia

boolean

default:false

Whether participant shall be bridged to conference before the participant answers (from early media if available). Defaults to false.

Example:

true

ConferenceStatusCallback

string

The URL the conference callbacks will be sent to.

Example:

"https://example.com/conference_status_callback"

ConferenceStatusCallbackMethod

enum<string>

HTTP request type used for ConferenceStatusCallback. Defaults to POST.

Available options:

GET,

POST

Example:

"GET"

ConferenceStatusCallbackEvent

string

The changes to the conference's state that should generate a call to ConferenceStatusCallback. Can be: start, end, join and leave. Separate multiple values with a space. By default no callbacks are sent.

Example:

"start end join leave"

WaitUrl

string

The URL to call for an audio file to play while the participant is waiting for the conference to start.

Example:

"https://www.example.com/wait_music.mp3"

MaxParticipants

integer

The maximum number of participants in the conference. Can be a positive integer from 2 to 800. The default value is 250.

Example:

30

Coaching

boolean

Whether the participant is coaching another call. When true, CallSidToCoach has to be given.

Example:

false

CallSidToCoach

string

The SID of the participant who is being coached. The participant being coached is the only participant who can hear the participant who is coaching.

Example:

"v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ"

CallerId

string

To be used as the caller id name (SIP From Display Name) presented to the destination (To number). The string should have a maximum of 128 characters, containing only letters, numbers, spaces, and -_~!.+ special characters. If ommited, the display name will be the same as the number in the From field.

Example:

"Info"

TimeLimit

integer

The maximum duration of the call in seconds.

Example:

30

MachineDetection

enum<string>

Whether to detect if a human or an answering machine picked up the call. Use Enable if you would like to ne notified as soon as the called party is identified. Use DetectMessageEnd, if you would like to leave a message on an answering machine.

Available options:

Enable,

DetectMessageEnd

Example:

"Enable"

MachineDetectionTimeout

integer

How long answering machine detection should go on for before sending an Unknown result. Given in milliseconds.

Example:

1000

MachineDetectionSpeechThreshold

integer

default:3500

Maximum threshold of a human greeting. If greeting longer than this value, considered machine. Ignored when premium detection is used.

Example:

2000

MachineDetectionSpeechEndThreshold

integer

default:800

Silence duration threshold after a greeting message or voice for it be considered human. Ignored when premium detection is used.

Example:

2000

MachineDetectionSilenceTimeout

integer

default:3500

If initial silence duration is greater than this value, consider it a machine. Ignored when premium detection is used.

Example:

2000

MachineDetectionBeepProfile

enum<string>

default:both

Selects which detectors must validate a beep. both requires the amplitude and frequency detectors to agree. freq_only uses the frequency detector alone, for beeps whose volume is too unsteady for the default profile. Only used when MachineDetection is enabled.

Available options:

both,

freq_only

Example:

"freq_only"

MachineDetectionBeepMinFrequency

integer<int32>

Lowest frequency, in Hz, that a tone must reach to be treated as a beep. Raising it above 480 excludes North American ringback (440 + 480 Hz), which can otherwise be reported as a beep when the freq_only profile is in use. Only used when MachineDetection is enabled.

Required range: 200 <= x <= 4000

Example:

550

MachineDetectionBeepMaxFrequency

integer<int32>

Highest frequency, in Hz, that a tone can reach and still be treated as a beep. Only used when MachineDetection is enabled.

Required range: 200 <= x <= 4000

Example:

2000

MachineDetectionBeepMinToneDuration

integer<int32>

Shortest tone, in milliseconds, that can be treated as a beep. Raising it rejects brief tones such as call-progress blips. Only used when MachineDetection is enabled.

Required range: 50 <= x <= 5000

Example:

300

MachineDetectionBeepSpectralConfirmation

boolean

When enabled, a candidate beep must pass an additional spectral check before it is reported. Only used when MachineDetection is enabled.

Example:

true

MachineDetectionBeepSpectralWindow

integer<int32>

Length of the spectral confirmation window, in milliseconds. Only used when MachineDetection is enabled.

Required range: 20 <= x <= 1000

Example:

100

MachineDetectionBeepSpectralMinPurity

number

Minimum spectral purity, from 0 to 1, for a tone to be treated as a beep. Raising it rejects mixed tones such as ringback, which combines two frequencies. Only used when MachineDetection is enabled.

Required range: 0 <= x <= 1

Example:

0.8

MachineDetectionBeepSpectralRejectFaxCng

boolean

When enabled, the fax CNG tone is rejected rather than reported as a beep. Only used when MachineDetection is enabled.

Example:

true

AmdStatusCallback

string

The URL the result of answering machine detection will be sent to.

Example:

"https://www.example.com/amd_result"

AmdStatusCallbackMethod

enum<string>

HTTP request type used for AmdStatusCallback. Defaults to POST.

Available options:

GET,

POST

Example:

"GET"

ApplicationSid

string

The SID of the TeXML application that will handle the new participant's call. Required unless joining an existing conference by its ConferenceSid.

Example:

"1846572522338780702"

CancelPlaybackOnMachineDetection

boolean

default:true

Whether to cancel ongoing playback on machine detection. Defaults to true.

Example:

false

CancelPlaybackOnDetectMessageEnd

boolean

default:true

Whether to cancel ongoing playback on greeting ended detection. Defaults to true.

Example:

false

PreferredCodecs

string

The list of comma-separated codecs to be offered on a call.

Example:

"PCMA,PCMU"

Record

boolean

Whether to record the entire participant's call leg. Defaults to false.

Example:

false

RecordingChannels

enum<string>

The number of channels in the final recording. Defaults to mono.

Available options:

mono,

dual

Example:

"dual"

RecordingStatusCallback

string

The URL the recording callbacks will be sent to.

Example:

"https://example.com/recording_status_callback"

RecordingStatusCallbackMethod

enum<string>

HTTP request type used for RecordingStatusCallback. Defaults to POST.

Available options:

GET,

POST

Example:

"GET"

RecordingStatusCallbackEvent

string

The changes to the recording's state that should generate a call to RecoridngStatusCallback. Can be: in-progress, completed and absent. Separate multiple values with a space. Defaults to completed.

Example:

"in-progress completed absent"

RecordingTrack

enum<string>

The audio track to record for the call. The default is both.

Available options:

inbound,

outbound,

both

Example:

"inbound"

SipAuthPassword

string

The password to use for SIP authentication.

Example:

"1234"

SipAuthUsername

string

The username to use for SIP authentication.

Example:

"user"

Trim

enum<string>

Whether to trim any leading and trailing silence from the recording. Defaults to trim-silence.

Available options:

trim-silence,

do-not-trim

Example:

"trim-silence"

ConferenceRecord

enum<string>

Whether to record the conference the participant is joining. Defualts to do-not-record. The boolean values true and false are synonymous with record-from-start and do-not-record respectively.

Available options:

true,

false,

record-from-start,

do-not-record

Example:

"record-from-start"

ConferenceRecordingStatusCallback

string

The URL the conference recording callbacks will be sent to.

Example:

"https://example.com/conference_recording_status_callback"

ConferenceRecordingStatusCallbackMethod

enum<string>

HTTP request type used for ConferenceRecordingStatusCallback. Defaults to POST.

Available options:

GET,

POST

Example:

"GET"

ConferenceRecordingStatusCallbackEvent

string

The changes to the conference recording's state that should generate a call to RecoridngStatusCallback. Can be: in-progress, completed and absent. Separate multiple values with a space. Defaults to completed. failed and absent are synonymous.

Example:

"in-progress completed failed absent"

ConferenceRecordingTimeout

integer

default:0

The number of seconds that Telnyx will wait for the recording to be stopped if silence is detected. The timer only starts when the speech is detected. Please note that the transcription is used to detect silence and the related charge will be applied. The minimum value is 0. The default value is 0 (infinite)

Example:

5

ConferenceTrim

enum<string>

Whether to trim any leading and trailing silence from the conference recording. Defaults to trim-silence.

Available options:

trim-silence,

do-not-trim

Example:

"trim-silence"

CustomHeaders

object[]

Custom HTTP headers to be sent with the call. Each header should be an object with 'name' and 'value' properties.

Show child attributes

Example:

[
  {
    "name": "X-Custom-Header",
    "value": "custom-value"
  }
]

Response

New participant resource.

account_sid

string

The id of the account the resource belongs to.

Example:

"61bf923e-5e4d-4595-a110-56190ea18a1b"

call_sid

string

The identifier of this participant's call.

Example:

"v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ"

coaching

boolean

Whether the participant is coaching another call.

Example:

false

coaching_call_sid

string

The identifier of the coached participant's call.

Example:

"v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ"

end_conference_on_exit

boolean

Whether the conference ends when the participant leaves.

Example:

false

hold

boolean

Whether the participant is on hold.

Example:

false

muted

boolean

Whether the participant is muted.

Example:

false

status

enum<string>

The status of the participant's call in the conference.

Available options:

connecting,

connected,

completed

Example:

"connected"

uri

string

The relative URI for this participant.

Example:

"/v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1/Participants/v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ.json"

conference_sid

string<uuid>

The unique identifier for the conference.

Example:

"cd5a70f4-759b-4d5e-9c06-88c00f16f3c1"

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.texml.accounts.conferences.participants.participants(
  'conference_sid',
  { account_sid: 'account_sid' },
);

console.log(response.account_sid);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
response = client.texml.accounts.conferences.participants.participants(
    conference_sid="conference_sid",
    account_sid="account_sid",
)
print(response.account_sid)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	response, err := client.Texml.Accounts.Conferences.Participants.Participants(
		context.TODO(),
		"conference_sid",
		telnyx.TexmlAccountConferenceParticipantParticipantsParams{
			AccountSid: "account_sid",
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.AccountSid)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.texml.accounts.conferences.participants.ParticipantParticipantsParams;
import com.telnyx.sdk.models.texml.accounts.conferences.participants.ParticipantParticipantsResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        ParticipantParticipantsParams params = ParticipantParticipantsParams.builder()
            .accountSid("account_sid")
            .conferenceSid("conference_sid")
            .build();
        ParticipantParticipantsResponse response = client.texml().accounts().conferences().participants().participants(params);
    }
}

require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

response = telnyx.texml.accounts.conferences.participants.participants("conference_sid", account_sid: "account_sid")

puts(response)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $response = $client->texml->accounts->conferences->participants->participants(
    'conference_sid',
    accountSid: 'account_sid',
    amdStatusCallback: 'https://www.example.com/amd_result',
    amdStatusCallbackMethod: 'GET',
    applicationSid: '1846572522338780702',
    beep: 'onExit',
    callerID: 'Info',
    callSidToCoach: 'v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ',
    cancelPlaybackOnDetectMessageEnd: false,
    cancelPlaybackOnMachineDetection: false,
    coaching: false,
    conferenceRecord: 'record-from-start',
    conferenceRecordingStatusCallback: 'https://example.com/conference_recording_status_callback',
    conferenceRecordingStatusCallbackEvent: 'in-progress completed failed absent',
    conferenceRecordingStatusCallbackMethod: 'GET',
    conferenceRecordingTimeout: 5,
    conferenceStatusCallback: 'https://example.com/conference_status_callback',
    conferenceStatusCallbackEvent: 'start end join leave',
    conferenceStatusCallbackMethod: 'GET',
    conferenceTrim: 'trim-silence',
    customHeaders: [['name' => 'X-Custom-Header', 'value' => 'custom-value']],
    earlyMedia: true,
    endConferenceOnExit: true,
    from: '+12065550200',
    label: 'customer',
    machineDetection: 'Enable',
    machineDetectionSilenceTimeout: 2000,
    machineDetectionSpeechEndThreshold: 2000,
    machineDetectionSpeechThreshold: 2000,
    machineDetectionTimeout: 1000,
    maxParticipants: 30,
    muted: true,
    preferredCodecs: 'PCMA,PCMU',
    record: false,
    recordingChannels: 'dual',
    recordingStatusCallback: 'https://example.com/recording_status_callback',
    recordingStatusCallbackEvent: 'in-progress completed absent',
    recordingStatusCallbackMethod: 'GET',
    recordingTrack: 'inbound',
    sipAuthPassword: '1234',
    sipAuthUsername: 'user',
    startConferenceOnEnter: false,
    statusCallback: 'https://www.example.com/callback',
    statusCallbackEvent: 'answered completed',
    statusCallbackMethod: 'GET',
    timeLimit: 30,
    timeoutSeconds: 30,
    to: '+12065550100',
    trim: 'trim-silence',
    waitURL: 'https://www.example.com/wait_music.mp3',
  );

  var_dump($response);
} catch (APIException $e) {
  echo $e->getMessage();
}

curl --request POST \
  --url https://api.telnyx.com/v2/texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'To=+12065550100' \
  --data 'From=+12065550200'

{
  "account_sid": "4e71926f-8f13-450e-b91c-23c2ef786aa6",
  "call_sid": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ",
  "coaching": false,
  "conference_sid": "cd5a70f4-759b-4d5e-9c06-88c00f16f3c1",
  "end_conference_on_exit": false,
  "hold": false,
  "muted": false,
  "status": "completed",
  "uri": "/v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1/Participants/v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ.json"
}

{
  "errors": [
    {
      "detail": "Resource not found"
    }
  ]
}

Guides

Markup Language

API Reference

For AI Agents

Dial a new conference participant

Authorizations

Path Parameters

Body

Response