REST ClientCompatConferences

update_participant

View as MarkdownOpen in Claude

Update a participant in a conference (e.g., mute or hold).

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

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

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

1from signalwire.rest import RestClient
2
3client = RestClient(
4    project="your-project-id",
5    token="your-api-token",
6    host="your-space.signalwire.com",
7)
8
9client.compat.conferences.update_participant("CF...", "CA...", Muted=True)