TCL / Zoom API / Update E911 digital signage
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 "PATCH"
CkHttpRequest_put_Path $req "/v2/rooms/events"
CkHttpRequest_put_ContentType $req "multipart/form-data"
CkHttpRequest_AddParam $req "method" "zoomroom.emergency_alert_displayed"
CkHttpRequest_AddParam $req "params" "zoomroom.emergency_alert_displayed{\"content\":\"anim dolore veniam dolore\",\"target_ids\":[\"laborum commodo est in\"],\"target_type\":\"location\"}"
CkHttpRequest_AddHeader $req "Authorization" "Bearer <access_token>"
# resp is a CkHttpResponse
set resp [CkHttp_SynchronousRequest $http "api.zoom.us" 443 1 $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)
# {
# "event_id": "6354hgfsdj34"
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set event_id [CkJsonObject_stringOf $jResp "event_id"]
delete_CkHttp $http
delete_CkHttpRequest $req
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -X PATCH
-H "Authorization: Bearer <access_token>"
-H "Content-Type: multipart/form-data"
--form 'method=zoomroom.emergency_alert_displayed'
--form 'params=zoomroom.emergency_alert_displayed{"content":"anim dolore veniam dolore","target_ids":["laborum commodo est in"],"target_type":"location"}'
https://api.zoom.us/v2/rooms/events
Postman Collection Item JSON
{
"name": "Update E911 digital signage",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "method",
"value": "zoomroom.emergency_alert_displayed",
"type": "text"
},
{
"key": "params",
"value": "{\"content\":\"anim dolore veniam dolore\",\"target_ids\":[\"laborum commodo est in\"],\"target_type\":\"location\"}",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/rooms/events",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
"events"
]
},
"description": "Display or hide E911 emergency alert text content from [Zoom Rooms digital signage](https://support.zoom.us/hc/en-us/articles/360000030683-Zoom-Rooms-digital-signage).\n\n**Scope:** `room:write:admin`\n\n**Prerequisites:**<br>\n* [Zoom Rooms](https://zoom.us/zoomrooms/software) 5.3.0 or higher\n* Zoom Rooms digital signage must be [enabled](https://support.zoom.us/hc/en-us/articles/360000030683-Zoom-Rooms-Digital-Signage#h_767fbb33-82a8-45a8-8392-a1bfa9687edd)\n"
},
"response": [
{
"name": "**HTTP Status Code:** `202` <br>",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "method",
"value": "zoomroom.emergency_alert_displayed",
"type": "text"
},
{
"key": "params",
"value": "{\"content\":\"anim dolore veniam dolore\",\"target_ids\":[\"laborum commodo est in\"],\"target_type\":\"location\"}",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/rooms/events",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
"events"
]
}
},
"status": "Accepted",
"code": 202,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"event_id\": \"6354hgfsdj34\"\n}"
},
{
"name": "**HTTP Status Code:** `400` <br>\n\n**Error Code:** `200` <br> Access restricted. <br><br>\n**Error Code:** `300`\nEvent id is required.<br>\nInvalid value submitted for Target Ids. Provide a valid Target Id associated with the Target type.",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "method",
"value": "zoomroom.emergency_alert_displayed",
"type": "text"
},
{
"key": "params",
"value": "{\"content\":\"anim dolore veniam dolore\",\"target_ids\":[\"laborum commodo est in\"],\"target_type\":\"location\"}",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/rooms/events",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
"events"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}