lianja / Zoom API / List digital signage contents
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")
loQueryParams = createobject("CkJsonObject")
loQueryParams.UpdateString("type","quis officia in reprehenderit")
loQueryParams.UpdateString("folder_id","quis officia in reprehenderit")
loQueryParams.UpdateInt("page_size",30)
loQueryParams.UpdateString("next_page_token","quis officia in reprehenderit")
// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loResp = loHttp.QuickRequestParams("GET","https://api.zoom.us/v2/rooms/digital_signage",loQueryParams)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loQueryParams
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 loQueryParams
release loSbResponseBody
release loJResp
return
endif
release loResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "total_records": 2,
// "page_size": 30,
// "next_page_token": "",
// "contents": [
// {
// "id": "sWbbbb535LQ",
// "name": "Marketing_Folder"
// },
// {
// "id": "9N333khdhfgiafg",
// "name": "BackgroundImage.png"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lnTotal_records = loJResp.IntOf("total_records")
lnPage_size = loJResp.IntOf("page_size")
lcNext_page_token = loJResp.StringOf("next_page_token")
i = 0
lnCount_i = loJResp.SizeOfArray("contents")
do while i < lnCount_i
loJResp.I = i
lcId = loJResp.StringOf("contents[i].id")
lcName = loJResp.StringOf("contents[i].name")
i = i + 1
enddo
release loHttp
release loQueryParams
release loSbResponseBody
release loJResp
Curl Command
curl -G -d "type=quis%20officia%20in%20reprehenderit"
-d "folder_id=quis%20officia%20in%20reprehenderit"
-d "page_size=30"
-d "next_page_token=quis%20officia%20in%20reprehenderit"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/rooms/digital_signage
Postman Collection Item JSON
{
"name": "List digital signage contents",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/rooms/digital_signage?type=quis officia in reprehenderit&folder_id=quis officia in reprehenderit&page_size=30&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
"digital_signage"
],
"query": [
{
"key": "type",
"value": "quis officia in reprehenderit",
"description": "Specify the type of digital signane resource. The value can be one of the following:\n* `content`: Returns information about content files.\n* `folder`: Returns information about the folder where the content files are located."
},
{
"key": "folder_id",
"value": "quis officia in reprehenderit",
"description": "Unique identifier of the folder where the content is located. Provide this field if you would like to filter the response by contents that are only available in a specific folder."
},
{
"key": "page_size",
"value": "30",
"description": "The number of records returned within a single API call."
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit",
"description": "The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
}
]
},
"description": "Use this API to return information about a Zoom account's [Zoom Rooms digital signage content](https://support.zoom.us/hc/en-us/articles/360000030683-Zoom-Rooms-digital-signage). You can also view this content in the **Room Management** section's [**Digital Signage Content**](https://zoom.us/digitalsignage#/) tab in the Zoom web portal. \n\n**Scopes:** `room:read:admin` \n\n**Prerequisites:** \n* A Pro or a higher account with Zoom Rooms. \n* Existing content in the **Digital Signage Content** tab."
},
"response": [
{
"name": "**HTTP Status Code:** `200` **OK**<br>\nList returned.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/rooms/digital_signage?type=quis officia in reprehenderit&folder_id=quis officia in reprehenderit&page_size=30&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
"digital_signage"
],
"query": [
{
"key": "type",
"value": "quis officia in reprehenderit"
},
{
"key": "folder_id",
"value": "quis officia in reprehenderit"
},
{
"key": "page_size",
"value": "30"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"total_records\": 2,\n \"page_size\": 30,\n \"next_page_token\": \"\",\n \"contents\": [\n {\n \"id\": \"sWbbbb535LQ\",\n \"name\": \"Marketing_Folder\"\n },\n {\n \"id\": \"9N333khdhfgiafg\",\n \"name\": \"BackgroundImage.png\"\n }\n ]\n}"
},
{
"name": "**HTTP Status Code:** `400` **Bad Request**<br>\n* Zoom Room subscription was not found. Try again after purchasing a Zoom Room subscription.\n* Access restricted.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/rooms/digital_signage?type=quis officia in reprehenderit&folder_id=quis officia in reprehenderit&page_size=30&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
"digital_signage"
],
"query": [
{
"key": "type",
"value": "quis officia in reprehenderit"
},
{
"key": "folder_id",
"value": "quis officia in reprehenderit"
},
{
"key": "page_size",
"value": "30"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
