Get a message
GET {{baseUrl}}/chat/users/:userId/messages/:messageId?to_contact=<email>&to_channel=<string>&download_file_formats=audio/mp4
Gets a chat message previously sent to a contact or a channel. For user-level apps, pass the me
value instead of the userId
parameter.
You must provide one of the following query parameters:
* to_contact
— The email address of the Zoom contact to whom you sent the message.
* to_channel
— The ID of the Zoom channel where you sent the message.
Scopes: chat_message:read
, chat_message:read:admin
Rate Limit Label: Medium
Note: For an account-level OAuth app, you can only use this API for a user assigned the Edit permission for the Chat message role setting.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
to_contact | string | The user ID or member ID or email address of a chat contact to whom the message was sent. You must provide this parameter or the to_channel parameter. | |
to_channel | string | The channel ID where the message was sent. You must provide this parameter or the to_channel parameter. | |
download_file_formats | string | For different types of files, this field supports returning the download URL in the specified format. Currently, we only support the download URL in the mp4 format for audio files. If this parameter is not specified, will return the download URL of the file in its default format. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |