List Meeting Chats
Lists the meeting chats of a finished meeting instance specified by meetingId
. You can set a maximum number of chats to return.
Use this operation to list the chats of a finished meeting instance when they are ready. Please note that only meeting instances in state ended
are supported for meetingId
. Meeting series, scheduled meetings and in-progress
meeting instances are not supported.
Query Parameters
A unique identifier for the meeting instance to which the chats belong. The meeting ID of a scheduled personal room meeting is not supported.
Limit the maximum number of meeting chats in the response, up to 100.
Offset from the first result that you want to fetch.
Response Properties
Chat array
A unique identifier for the chat snippet.
Chat time for the chat snippet in ISO 8601 compliant format.
The text of the chat snippet.
A unique identifier for the meeting instance to which the chat belongs.
Whether the type of the chat is private, public or group. Private chat is for the 1:1 chat. Public chat is for the message which is sent to all the people in the meeting. Group chat is for the message which is sent to a small group of people, like a message to "host and presenter".
Information of the sender of the chat snippet.
Email address of the sender of the meeting chat snippet.
Display name for the sender.
A unique identifier for the sender.
The ID of the organization to which the sender belongs.
Information of the receivers of the chat snippet.
Email address of the receiver of the meeting chat snippet.
Display name for the receiver.
A unique identifier for the receiver.
The ID of the organization to which the receiver belongs.
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
Query Parameters
- meetingIdstringRequiredA unique identifier for the [meeting instance](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) to which the chats belong. The meeting ID of a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) meeting is not supported.
- maxnumberLimit the maximum number of meeting chats in the response, up to 100.
- offsetnumberOffset from the first result that you want to fetch.
{ "items": [ { "id": "1aea8390-e375-4547-b7ff-58ecd9e0b03d", "chatTime": "2021-07-06T09:22:34Z", "text": "hi", "meetingId": "a2f95f5073e347489f7611492dbd6ad5_I_199075330905867928", "type": "private", "sender": { "email": "john.andersen@example.com", "displayName": "John Andersen", "personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jN2ZkNzNmMi05ZjFlLTQ3ZjctYWEwNS05ZWI5OGJiNjljYzY=", "orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9jMmUyMjE4Zi00ZDZhLTQwODEtYTc1MS0yOWIyZTk3MDRiZGU=" }, "receivers": [ { "email": "catherine.sinu@example.com", "displayName": "Catherine Sinu", "personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9hYmEwZDRjYi02MGVkLTQzYjctYTkyNy1mZTc2MmIyZTRiODY=", "orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9jMmUyMjE4Zi00ZDZhLTQwODEtYTc1MS0yOWIyZTk3MDRiZGU=" } ] } ] }