TCL / Zoom API / Send IM messages
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
set req [new_CkHttpRequest]
CkHttpRequest_put_HttpVerb $req "POST"
CkHttpRequest_put_Path $req "/"
CkHttpRequest_put_ContentType $req "multipart/form-data"
CkHttpRequest_AddParam $req "message" "irure esse dolor"
CkHttpRequest_AddHeader $req "Authorization" "Bearer <access_token>"
# resp is a CkHttpResponse
set resp [CkHttp_SynchronousRequest $http "reprehenderit" 80 0 $req]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkHttpRequest $req
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkHttpRequest $req
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "id": "string"
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set id [CkJsonObject_stringOf $jResp "id"]
delete_CkHttp $http
delete_CkHttpRequest $req
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: multipart/form-data"
--form 'message=irure esse dolor'
https://api.zoom.us/v2/im/users/me/chat/messages?chat_user=quis officia in reprehenderit
Postman Collection Item JSON
{
"name": "Send IM messages",
"request": {
"auth": {
"type": "oauth2"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "message",
"value": "irure esse dolor",
"description": "IM message content.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/im/users/me/chat/messages?chat_user=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"im",
"users",
"me",
"chat",
"messages"
],
"query": [
{
"key": "chat_user",
"value": "quis officia in reprehenderit",
"description": "The email address (registered with Zoom) or the userId of the chat user."
}
]
},
"description": "Send chat message to a user. <aside>Note: This API only supports OAuth 2.0.</aside><br><br>**Scope:** `imchat:write`\n \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` "
},
"response": [
{
"name": "**HTTP Status Code:** `201`<br>\nMessage Sent.",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "message",
"value": "irure esse dolor",
"description": "IM message content.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/im/users/me/chat/messages?chat_user=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"im",
"users",
"me",
"chat",
"messages"
],
"query": [
{
"key": "chat_user",
"value": "quis officia in reprehenderit"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"id\": \"string\"\n}"
}
]
}