Chilkat Online Tools

autoit / Zoom API / React to a chat message

Back to Collection Items

; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oReq = ObjCreate("Chilkat.HttpRequest")
$oReq.HttpVerb = "PATCH"
$oReq.Path = "/v2/chat/users/:userId/messages/:messageId/emoji_reactions"
$oReq.ContentType = "multipart/form-data"
$oReq.AddParam "to_contact","culpa reprehenderit"

$oReq.AddParam "to_channel","culpa reprehenderitlaborum ut"

$oReq.AddParam "action","culpa reprehenderitlaborum utremove"

$oReq.AddParam "emoji","culpa reprehenderitlaborum utremovequis magna aliqua Ut"

$oReq.AddHeader "Authorization","Bearer <access_token>"

Local $oResp = $oHttp.SynchronousRequest("api.zoom.us",443,True,$oReq)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode <> 204) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Response Body:" & @CRLF)
    ConsoleWrite($oResp.BodyStr & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

ConsoleWrite("Success." & @CRLF)

Curl Command

curl -X PATCH
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: multipart/form-data"
	--form 'to_contact=culpa reprehenderit'
	--form 'to_channel=culpa reprehenderitlaborum ut'
	--form 'action=culpa reprehenderitlaborum utremove'
	--form 'emoji=culpa reprehenderitlaborum utremovequis magna aliqua Ut'
https://api.zoom.us/v2/chat/users/:userId/messages/:messageId/emoji_reactions

Postman Collection Item JSON

{
  "name": "React to a chat message",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "PATCH",
    "header": [
      {
        "key": "Content-Type",
        "value": "multipart/form-data"
      }
    ],
    "body": {
      "mode": "formdata",
      "formdata": [
        {
          "key": "to_contact",
          "value": "culpa reprehenderit",
          "description": "The email address of the contact to whom the message was sent. You must provide either the `to_contact` or the `to_channel` parameter in the API request.\n\nTo get a channel's ID, use the [List User's Channels API](https://marketplace.zoom.us/docs/api-reference/zoom-api/chat-channels/getchannels).",
          "type": "text"
        },
        {
          "key": "to_channel",
          "value": "laborum ut",
          "description": "The channel's ID where you sent the message. You must provide either the `to_contact` or the `to_channel` parameter in the API request.\n\nTo get a channel's ID, use the [List User's Channels API](https://marketplace.zoom.us/docs/api-reference/zoom-api/chat-channels/getchannels).",
          "type": "text"
        },
        {
          "key": "action",
          "value": "remove",
          "description": "The action to perform with the message:\n* `add` — Add an emoji reaction.\n* `remove` — Remove an emoji reaction. (This can only be one of add,remove)",
          "type": "text"
        },
        {
          "key": "emoji",
          "value": "quis magna aliqua Ut",
          "description": "The emoji's unicode value, in `UTF-32` format. For more information, read the [Emojipedia](https://emojipedia.org/emoji-modifier-sequence/) documentation.",
          "type": "text"
        }
      ]
    },
    "url": {
      "raw": "{{baseUrl}}/chat/users/:userId/messages/:messageId/emoji_reactions",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "chat",
        "users",
        ":userId",
        "messages",
        ":messageId",
        "emoji_reactions"
      ],
      "variable": [
        {
          "key": "userId",
          "value": "quis officia in reprehenderit",
          "description": "(Required) The user's unique ID."
        },
        {
          "key": "messageId",
          "value": "quis officia in reprehenderit",
          "description": "(Required) The message's unique ID."
        }
      ]
    },
    "description": "Use this API to react (add or remove) to a chat message with an emoji.\n\nFor an **account-level** [OAuth app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app), this API can only be used on behalf of a user who is assigned with a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.) that has the **Edit** permission for **Chat Messages**.\n\n**Scopes:** `chat_message:write`, `chat_message:write:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `204`<br>\nMessage reacted successfully.",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "to_contact",
              "value": "culpa reprehenderit",
              "description": "The email address of the contact to whom the message was sent. You must provide either the `to_contact` or the `to_channel` parameter in the API request.\n\nTo get a channel's ID, use the [List User's Channels API](https://marketplace.zoom.us/docs/api-reference/zoom-api/chat-channels/getchannels).",
              "type": "text"
            },
            {
              "key": "to_channel",
              "value": "laborum ut",
              "description": "The channel's ID where you sent the message. You must provide either the `to_contact` or the `to_channel` parameter in the API request.\n\nTo get a channel's ID, use the [List User's Channels API](https://marketplace.zoom.us/docs/api-reference/zoom-api/chat-channels/getchannels).",
              "type": "text"
            },
            {
              "key": "action",
              "value": "remove",
              "description": "The action to perform with the message:\n* `add` — Add an emoji reaction.\n* `remove` — Remove an emoji reaction. (This can only be one of add,remove)",
              "type": "text"
            },
            {
              "key": "emoji",
              "value": "quis magna aliqua Ut",
              "description": "The emoji's unicode value, in `UTF-32` format. For more information, read the [Emojipedia](https://emojipedia.org/emoji-modifier-sequence/) documentation.",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/chat/users/:userId/messages/:messageId/emoji_reactions",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "chat",
            "users",
            ":userId",
            "messages",
            ":messageId",
            "emoji_reactions"
          ],
          "variable": [
            {
              "key": "userId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The user's unique ID."
            },
            {
              "key": "messageId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The message's unique ID."
            }
          ]
        }
      },
      "status": "No Content",
      "code": 204,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "**HTTP Status Code:** `400`<br>\nBad request<br>\n**Error Code:** `300`<br>\nMessage does not exist: $messageId <br> Must provide either contact or channel parameter.\n",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "to_contact",
              "value": "culpa reprehenderit",
              "description": "The email address of the contact to whom the message was sent. You must provide either the `to_contact` or the `to_channel` parameter in the API request.\n\nTo get a channel's ID, use the [List User's Channels API](https://marketplace.zoom.us/docs/api-reference/zoom-api/chat-channels/getchannels).",
              "type": "text"
            },
            {
              "key": "to_channel",
              "value": "laborum ut",
              "description": "The channel's ID where you sent the message. You must provide either the `to_contact` or the `to_channel` parameter in the API request.\n\nTo get a channel's ID, use the [List User's Channels API](https://marketplace.zoom.us/docs/api-reference/zoom-api/chat-channels/getchannels).",
              "type": "text"
            },
            {
              "key": "action",
              "value": "remove",
              "description": "The action to perform with the message:\n* `add` — Add an emoji reaction.\n* `remove` — Remove an emoji reaction. (This can only be one of add,remove)",
              "type": "text"
            },
            {
              "key": "emoji",
              "value": "quis magna aliqua Ut",
              "description": "The emoji's unicode value, in `UTF-32` format. For more information, read the [Emojipedia](https://emojipedia.org/emoji-modifier-sequence/) documentation.",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/chat/users/:userId/messages/:messageId/emoji_reactions",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "chat",
            "users",
            ":userId",
            "messages",
            ":messageId",
            "emoji_reactions"
          ],
          "variable": [
            {
              "key": "userId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The user's unique ID."
            },
            {
              "key": "messageId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The message's unique ID."
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "**HTTP Status Code:** `404`<br>\n**Error Code**: `1001`<br>\nUser does not exist: $to_contact.<br>\n**Error Code**: `4130`<br>\nChannel does not exist: $to_channel.",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "to_contact",
              "value": "culpa reprehenderit",
              "description": "The email address of the contact to whom the message was sent. You must provide either the `to_contact` or the `to_channel` parameter in the API request.\n\nTo get a channel's ID, use the [List User's Channels API](https://marketplace.zoom.us/docs/api-reference/zoom-api/chat-channels/getchannels).",
              "type": "text"
            },
            {
              "key": "to_channel",
              "value": "laborum ut",
              "description": "The channel's ID where you sent the message. You must provide either the `to_contact` or the `to_channel` parameter in the API request.\n\nTo get a channel's ID, use the [List User's Channels API](https://marketplace.zoom.us/docs/api-reference/zoom-api/chat-channels/getchannels).",
              "type": "text"
            },
            {
              "key": "action",
              "value": "remove",
              "description": "The action to perform with the message:\n* `add` — Add an emoji reaction.\n* `remove` — Remove an emoji reaction. (This can only be one of add,remove)",
              "type": "text"
            },
            {
              "key": "emoji",
              "value": "quis magna aliqua Ut",
              "description": "The emoji's unicode value, in `UTF-32` format. For more information, read the [Emojipedia](https://emojipedia.org/emoji-modifier-sequence/) documentation.",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/chat/users/:userId/messages/:messageId/emoji_reactions",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "chat",
            "users",
            ":userId",
            "messages",
            ":messageId",
            "emoji_reactions"
          ],
          "variable": [
            {
              "key": "userId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The user's unique ID."
            },
            {
              "key": "messageId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The message's unique ID."
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}