Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Check out our upcoming events and meetups! View events →
Retrieve details of a specific conference participant by their ID or label.
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.conferences.retrieveParticipant('participant_id', {
id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
});
console.log(response.data);{
"data": {
"id": "<string>",
"call_control_id": "<string>",
"call_leg_id": "<string>",
"conference_id": "<string>",
"label": "<string>",
"muted": true,
"on_hold": true,
"whisper_call_control_ids": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"end_conference_on_exit": true,
"soft_end_conference_on_exit": true
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Uniquely identifies the conference.
Uniquely identifies the participant by their ID or label.
Successful response
Show child attributes
Was this page helpful?
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.conferences.retrieveParticipant('participant_id', {
id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
});
console.log(response.data);{
"data": {
"id": "<string>",
"call_control_id": "<string>",
"call_leg_id": "<string>",
"conference_id": "<string>",
"label": "<string>",
"muted": true,
"on_hold": true,
"whisper_call_control_ids": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"end_conference_on_exit": true,
"soft_end_conference_on_exit": true
}
}