List Meeting Breakout Sessions
Lists meeting breakout sessions for a meeting with a specified meetingId.
This operation can be used for meeting series, scheduled meeting and ended or ongoing meeting instance objects. See the Webex Meetings guide for more information about the types of meetings.
If the meeting of
meetingIdis in progress, the operation returns the breakout sessions which are currently held in the meeting.If the meeting of
meetingIdis ended meeting instance, the operation returns the breakout sessions which happended during the meeting instance.Otherwise, if it's a meeting series or scheduled meeting and it's not in progress, the operation returns the breakout sessions which are created when the meeting is scheduled.
URI Parameters
Unique identifier for the meeting. This parameter applies to meeting series, scheduled meeting and ended or ongoing meeting instance objects. Please note that currently meeting ID of a scheduled personal room meeting is not supported for this API.
Response Properties
Breakout sessions information for meeting.
Unique identifier for breakout session.
Name for breakout session.
Invitees for breakout session. Only applies to breakout sessions which are created when meeting is scheduled.
The time the breakout session was started. Only applies to breakout sessions of ended meeting instances.
The time the breakout session was ended. Only applies to breakout sessions of ended meeting instances.
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
{
"items": [
{
"id": "18d2e565770c4eee918784ee333510ec",
"name": "Breakout Session 1",
"invitees": [
"rachel.green@example.com",
"monica.geller@example.com"
]
},
{
"id": "7ec0782fccf84a5b8cb56d97c69cc771",
"name": "Breakout Session N",
"invitees": [
"ross.geller@example.com",
"chandler.bing@example.com"
]
}
]
}