For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
GuidesReference
GuidesReference
    • Core
      • Overview
    • Agents
      • Overview
      • AgentBase
      • AgentServer
      • Configuration
      • ContextBuilder
      • DataMap
      • FunctionResult
      • Helper Functions & Utilities
      • LiveWire
      • PomBuilder
      • Prefabs
      • SkillBase
      • SkillManager
      • SkillRegistry
      • Skills
      • SwaigFunction
      • SwmlBuilder
      • SWMLService
    • RELAY
      • Overview
      • Actions
      • Call
      • Constants
      • Events
      • Message
      • RelayClient
      • RelayError
    • REST Client
      • Overview
      • Addresses
      • Calling
      • ChatResource
      • Compat
        • Accounts
        • Applications
        • Calls
        • Conferences
          • deleteRecording
          • get
          • getParticipant
          • getRecording
          • list
          • listParticipants
          • listRecordings
          • removeParticipant
          • startStream
          • stopStream
          • update
          • updateParticipant
          • updateRecording
        • Faxes
        • LAML Bins
        • Messages
        • Phone Numbers
        • Queues
        • Recordings
        • Tokens
        • Transcriptions
      • Datasphere
      • Fabric
      • ImportedNumbersResource
      • Logs
      • LookupResource
      • MFA
      • Number Groups
      • Phone Numbers
      • Project
      • PubSubResource
      • Queues
      • Recordings
      • Registry
      • RestClient
      • RestError
      • Short Codes
      • SIP Profile
      • Verified Callers
      • Video
LogoLogoSignalWire Docs
Log inSign up
Support
On this page
  • Response Example
  • Example
REST ClientCompatConferences

getParticipant

|View as Markdown|Open in Claude|
Was this page helpful?
Edit this page
Previous

getRecording

Next
Built with

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.
Allowed values:
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
1{
2  "account_sid": "b3877c40-da60-4998-90ad-b792e98472af",
3  "call_sid": "b3877c40-da60-4998-90ad-b792e98472ca",
4  "call_sid_to_coach": "b3877c40-da60-4998-90ad-b792e98472co",
5  "coaching": false,
6  "conference_sid": "b3877c40-da60-4998-90ad-b792e98472cf",
7  "date_created": "Mon, 24 Sept 2018 21:00:00 +0000",
8  "status": "completed",
9  "date_updated": "Tue, 25 Sept 2018 20:00:00 +0000",
10  "end_conference_on_exit": false,
11  "muted": false,
12  "hold": false,
13  "start_conference_on_enter": true,
14  "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"
15}

Example

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