Skip to main content
POST
/
texml
/
Accounts
/
{account_sid}
/
Conferences
/
{conference_sid}
/
Participants
JavaScript
import Telnyx from 'telnyx';

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

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

console.log(response.account_sid);
{
  "account_sid": "4e71926f-8f13-450e-b91c-23c2ef786aa6",
  "call_sid": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ",
  "coaching": false,
  "coaching_call_sid": null,
  "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"
}

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 id of the account the resource belongs to.

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

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

​
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

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

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

false

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

false

​
CustomHeaders
object[]

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

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:

"in-progress"

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