PureBasic / Zoom API / Update E911 digital signage
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttpRequest.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
req.i = CkHttpRequest::ckCreate()
If req.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpRequest::setCkHttpVerb(req, "PATCH")
CkHttpRequest::setCkPath(req, "/v2/rooms/events")
CkHttpRequest::setCkContentType(req, "multipart/form-data")
CkHttpRequest::ckAddParam(req,"method","zoomroom.emergency_alert_displayed")
CkHttpRequest::ckAddParam(req,"params","zoomroom.emergency_alert_displayed{" + Chr(34) + "content" + Chr(34) + ":" + Chr(34) + "anim dolore veniam dolore" + Chr(34) + "," + Chr(34) + "target_ids" + Chr(34) + ":[" + Chr(34) + "laborum commodo est in" + Chr(34) + "]," + Chr(34) + "target_type" + Chr(34) + ":" + Chr(34) + "location" + Chr(34) + "}")
CkHttpRequest::ckAddHeader(req,"Authorization","Bearer <access_token>")
resp.i = CkHttp::ckSynchronousRequest(http,"api.zoom.us",443,1,req)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkHttpRequest::ckDispose(req)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkHttpRequest::ckDispose(req)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(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
event_id.s = CkJsonObject::ckStringOf(jResp,"event_id")
CkHttp::ckDispose(http)
CkHttpRequest::ckDispose(req)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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": ""
}
]
}