REST ClientCompatConferences

getParticipant

View as MarkdownOpen in Claude

Retrieve a specific participant in a conference.

Path parameters

AccountSidstringRequiredformat: "uuid"
The unique identifier for the account that created this conference.
ConferenceSidstringRequiredformat: "uuid"
The unique identifier for the conference this participant is in.
CallSidstringRequiredformat: "uuid"
The unique identifier for the Participant call connected to this conference.

Response

account_sidstringRequiredformat: "uuid"
The unique identifier for the account that created this conference.
call_sidstringRequiredformat: "uuid"
The unique identifier for the Participant call connected to this conference.
call_sid_to_coachstring or nullRequiredformat: "uuid"
The unique identifier of the participant who is being coached.
coachingbooleanRequired
Whether the participant is coaching another call.
conference_sidstringRequiredformat: "uuid"
The unique identifier for the conference this participant is in.
date_createdstringRequired
The date, in RFC 2822 format, this conference participant was created.
statusenumRequired
The status of the conference call.
date_updatedstringRequired
The date, in RFC 2822 format, this conference participant was updated.
end_conference_on_exitbooleanRequired
Whether or not a conference ends when a participant leaves the conference call.
mutedbooleanRequired
Whether or not a participant is muted.
holdbooleanRequired
Whether or not a participant is on hold.
start_conference_on_enterbooleanRequired
Whether or not a conference will begin when this participant enters the conference call.
uristringRequired
The URI for this conference participant.

Response Example

Response
{
  "account_sid": "b3877c40-da60-4998-90ad-b792e98472af",
  "call_sid": "b3877c40-da60-4998-90ad-b792e98472ca",
  "call_sid_to_coach": "b3877c40-da60-4998-90ad-b792e98472co",
  "coaching": false,
  "conference_sid": "b3877c40-da60-4998-90ad-b792e98472cf",
  "date_created": "Mon, 24 Sept 2018 21:00:00 +0000",
  "status": "completed",
  "date_updated": "Tue, 25 Sept 2018 20:00:00 +0000",
  "end_conference_on_exit": false,
  "muted": false,
  "hold": false,
  "start_conference_on_enter": true,
  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf/Participants/b3877c40-da60-4998-90ad-b792e98472ca.json"
}

Example

import { RestClient } from "@signalwire/sdk";
const client = new RestClient({
  project: "your-project-id",
  token: "your-api-token",
  host: "your-space.signalwire.com"
});
const participant = await client.compat.conferences.getParticipant("CF...", "CA...");