Chilkat Online Tools

lianja / Zoom API / Update E911 digital signage

Back to Collection Items

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

loHttp = createobject("CkHttp")

loReq = createobject("CkHttpRequest")
loReq.HttpVerb = "PATCH"
loReq.Path = "/v2/rooms/events"
loReq.ContentType = "multipart/form-data"
loReq.AddParam("method","zoomroom.emergency_alert_displayed")

loReq.AddParam("params",'zoomroom.emergency_alert_displayed{"content":"anim dolore veniam dolore","target_ids":["laborum commodo est in"],"target_type":"location"}')

loReq.AddHeader("Authorization","Bearer <access_token>")

loResp = loHttp.SynchronousRequest("api.zoom.us",443,.T.,loReq)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loReq
    return
endif

loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    release loResp
    release loHttp
    release loReq
    release loSbResponseBody
    release loJResp
    return
endif

release loResp

// 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

lcEvent_id = loJResp.StringOf("event_id")


release loHttp
release loReq
release loSbResponseBody
release loJResp

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": ""
    }
  ]
}