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
cXMLREST API
cXMLREST API
  • Core
    • Overview
    • Authorization
    • Error codes
    • Paging
    • REST client SDKs
  • Compatibility REST API
      • GETList all active Participants
      • GETRetrieve a Participant
      • POSTUpdate a Participant
      • DELDelete a Participant
LogoLogoSignalWire Docs
Log inSign up
Support
Compatibility REST APIConference Participants

Update a Participant

|View as Markdown|Open in Claude|
POST
https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/:AccountSid/Conferences/:ConferenceSid/Participants/:CallSid
POST
/api/laml/2010-04-01/Accounts/:AccountSid/Conferences/:ConferenceSid/Participants/:CallSid
$curl -X POST https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Conferences/ConferenceSid/Participants/CallSid \
>     -H "Content-Type: application/x-www-form-urlencoded" \
>     -u "<project_id>:<api_token>"
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}

Update a participant.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice.

Learn more about API scopes.

Was this page helpful?
Previous

Delete a Participant

Next
Built with

Authentication

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

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.

Request

This endpoint expects an object.
AnnounceUrlstringOptionalformat: "uri"
The URL to send conference announcements to.
AnnounceMethodenumOptionalDefaults to POST

Whether the request to AnnounceUrl is a GET or a POST. Default is POST.

Allowed values:
CoachingbooleanOptional

Whether the participant is coaching another call. Requires CallSidToCoach to be set.

CallSidToCoachstringOptionalformat: "uuid"

The unique identifier of the participant who is being coached. Required when Coaching is true.

HoldbooleanOptional
Whether or not a participant is on hold.
HoldMethodenumOptionalDefaults to GET

Whether the request to HoldUrl is a GET or a POST. Default is GET.

Allowed values:
HoldUrlstringOptionalformat: "uri"
The URL to send hold music to that will be played when participant is on hold.
MutedbooleanOptional
Whether or not a participant is muted.
WaitUrlstringOptionalformat: "uri"
The URL for wait music to be played while a conference is not yet started.
WaitMethodenumOptionalDefaults to POST

Whether the request to WaitUrl is a GET or a POST. Default is POST.

Allowed values:

Response

The request has succeeded.
account_sidstringformat: "uuid"
The unique identifier for the account that created this conference.
call_sidstringformat: "uuid"
The unique identifier for the Participant call connected to this conference.
call_sid_to_coachstring or nullformat: "uuid"
The unique identifier of the participant who is being coached.
coachingboolean
Whether the participant is coaching another call.
conference_sidstringformat: "uuid"
The unique identifier for the conference this participant is in.
date_createdstring
The date, in RFC 2822 format, this conference participant was created.
statusenum
The status of the conference call.
Allowed values:
date_updatedstring
The date, in RFC 2822 format, this conference participant was updated.
end_conference_on_exitboolean
Whether or not a conference ends when a participant leaves the conference call.
mutedboolean
Whether or not a participant is muted.
holdboolean
Whether or not a participant is on hold.
start_conference_on_enterboolean
Whether or not a conference will begin when this participant enters the conference call.
uristring
The URI for this conference participant.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)