Update a Participant
To mute, un-mute, expel, or admit a participant in a live meeting. The participantId is required to identify the meeting and the participant.
Notes:
The owner of the OAuth token calling this API needs to be the meeting host or co-host.
The
expelattribute always takes precedence overadmitandmuted. The request can have allexpel,admitandmutedor any of them.
There is an inconsistent behavior in Webex Meetings App when all active meeting participants join using Webex Meetings App and the host attempts to change meeting participant status using this API. Requests to mute, un-mute, admit, or expel a meeting participant return a successful response and update the state in the API, but the changes will not be applied to the Webex Meetings App participants. The inconsistent behavior in Webex Meetings App will be corrected in a future release. Workaround: Enable closed captions or enable the Webex Assistant.
URI Parameters
The unique identifier for the meeting and the participant.
Body Parameters
The value is true or false, and means to mute or unmute the audio of a participant.
The value can be true or false. The value of true is to admit a participant to the meeting if the participant is in the lobby, No-Op if the participant is not in the lobby or when the value is set to false.
The attribute is exclusive and its value can be true or false. The value of true means that the participant will be expelled from the meeting, the value of false means No-Op.
Response Properties
The participant ID that identifies the meeting and the participant.
The ID that identifies the organization.
Whether or not the participant is the host of the meeting.
Whether or not the participant has host privilege in the meeting.
Whether or not the participant is the team space moderator. This field returns only if the meeting is associated with a Webex space.
The email address of the participant.
The name of the participant.
Whether or not the participant is invited to the meeting.
The status of the participant's video.
The video is turned on.
The video is turned off.
Whether or not the participant's audio is muted.
The status of the participant in the meeting.
The participant is waiting in the meeting lobby.
The participant has joined the meeting.
The site URL.
A unique identifier for the meeting which the participant belongs to.
The email address of the host.
An internal ID that is associated with each join.
The type of device.
The audio type that the participant is using.
PSTN
VoIP
The participant is not connected to audio.
The time the device joined the meeting. If the field is non-existent or shows 1970-01-01T00:00:00.000Z the meeting may be still ongoing and the joinedTime will be filled in after the meeting ended. If you need real-time joined events, please refer to the webhooks guide.
The time the device left the meeting, leftTime is the exact moment when a specific device left the meeting. If the field is non-existent or shows 1970-01-01T00:00:00.000Z the meeting may be still ongoing and the leftTime will be filled in after the meeting ended. If you need real-time left events, please refer to the webhooks guide.
Response Codes
The list below describes the common success and error responses you should expect from the API.
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Body
- The value is true or false, and means to mute or unmute the audio of a participant.
- The value can be true or false. The value of true is to admit a participant to the meeting if the participant is in the lobby, No-Op if the participant is not in the lobby or when the value is set to false.
- The attribute is exclusive and its value can be true or false. The value of true means that the participant will be expelled from the meeting, the value of false means No-Op.
{
"muted": false
}
{
"id": "560d7b784f5143e3be2fc3064a5c4999_3c2e2338-e950-43bf-b588-573773ee43d1",
"orgId": "1eb65fdf-9643-417f-9974-ad72cae0e10f",
"host": true,
"coHost": false,
"spaceModerator": false,
"email": "joeDoe@cisco.com",
"displayName": "Joe Doe",
"invitee": false,
"video": "on",
"muted": false,
"state": "lobby",
"siteUrl": "example.webex.com",
"meetingId": "3a688f62840346e8b87dde2b50703511_I_197977258267247872",
"hostEmail": "janeDoe@cisco.com",
"devices": [
{
"correlationId": "8ccced6c-b812-4dff-a5dd-4c5c28f8d47d",
"deviceType": "mac",
"audioType": "pstn",
"joinedTime": "2019-04-23T17:31:00.000Z",
"leftTime": "2019-04-23T17:32:00.000Z"
}
]
}