PureBasic / Zoom API / List meeting participants QoS
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkDtObj.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
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"type","live")
CkJsonObject::ckUpdateInt(queryParams,"page_size",1)
CkJsonObject::ckUpdateString(queryParams,"next_page_token","quis officia in reprehenderit")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://api.zoom.us/v2/metrics/meetings/:meetingId/participants/qos",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
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)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "page_count": "integer [int64]",
; "page_size": "integer",
; "total_records": "integer [int64]",
; "next_page_token": "string",
; "participants": [
; {
; "user_id": "1670000000",
; "user_name": "User",
; "device": "Android",
; "ip_address": "192.0.2.0",
; "location": "San Jose (US)",
; "join_time": "2021-06-24T20:00:00Z",
; "leave_time": "2021-06-24T20:00:00Z",
; "pc_name": "User's Phone",
; "domain": "user-android",
; "mac_addr": "",
; "harddisk_id": "",
; "version": "4.4.55383.0726",
; "user_qos": [
; {
; "date_time": "2021-06-24T20:00:00Z",
; "audio_input": {
; "bitrate": "23 kbps",
; "latency": "126 ms",
; "jitter": "6 ms",
; "avg_loss": "0.3%",
; "max_loss": "1.9%"
; },
; "audio_output": {
; "bitrate": "63 kbps",
; "latency": "134 ms",
; "jitter": "6 ms",
; "avg_loss": "0.0%",
; "max_loss": "0.0%"
; },
; "video_input": {
; "bitrate": "1055 kbps",
; "latency": "129 ms",
; "jitter": "11 ms",
; "avg_loss": "0.0%",
; "max_loss": "4.9%",
; "resolution": "1280*720",
; "frame_rate": "12 fps"
; },
; "video_output": {
; "bitrate": "673 kbps",
; "latency": "135 ms",
; "jitter": "11 ms",
; "avg_loss": "0.0%",
; "max_loss": "0.0%",
; "resolution": "640*360",
; "frame_rate": "22 fps"
; },
; "as_input": {
; "bitrate": "70 kbps",
; "latency": "135 ms",
; "jitter": "8 ms",
; "avg_loss": "0.0%",
; "max_loss": "0.0%",
; "resolution": "0*0",
; "frame_rate": ""
; },
; "as_output": {
; "bitrate": "70 kbps",
; "latency": "135 ms",
; "jitter": "8 ms",
; "avg_loss": "0.0%",
; "max_loss": "0.0%",
; "resolution": "0*0",
; "frame_rate": ""
; },
; "cpu_usage": {
; "zoom_min_cpu_usage": "8%",
; "zoom_avg_cpu_usage": "12%",
; "zoom_max_cpu_usage": "18%",
; "system_max_cpu_usage": "40%"
; }
; }
; ]
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
date_time.i = CkDtObj::ckCreate()
If date_time.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
user_id.s
user_name.s
device.s
ip_address.s
location.s
join_time.s
leave_time.s
pc_name.s
domain.s
mac_addr.s
harddisk_id.s
version.s
j.i
count_j.i
Bitrate.s
Latency.s
Jitter.s
Avg_loss.s
Max_loss.s
audio_outputBitrate.s
audio_outputLatency.s
audio_outputJitter.s
audio_outputAvg_loss.s
audio_outputMax_loss.s
video_inputBitrate.s
video_inputLatency.s
video_inputJitter.s
video_inputAvg_loss.s
video_inputMax_loss.s
Resolution.s
Frame_rate.s
video_outputBitrate.s
video_outputLatency.s
video_outputJitter.s
video_outputAvg_loss.s
video_outputMax_loss.s
video_outputResolution.s
video_outputFrame_rate.s
as_inputBitrate.s
as_inputLatency.s
as_inputJitter.s
as_inputAvg_loss.s
as_inputMax_loss.s
as_inputResolution.s
as_inputFrame_rate.s
as_outputBitrate.s
as_outputLatency.s
as_outputJitter.s
as_outputAvg_loss.s
as_outputMax_loss.s
as_outputResolution.s
as_outputFrame_rate.s
Zoom_min_cpu_usage.s
Zoom_avg_cpu_usage.s
Zoom_max_cpu_usage.s
System_max_cpu_usage.s
page_count.s = CkJsonObject::ckStringOf(jResp,"page_count")
page_size.s = CkJsonObject::ckStringOf(jResp,"page_size")
total_records.s = CkJsonObject::ckStringOf(jResp,"total_records")
next_page_token.s = CkJsonObject::ckStringOf(jResp,"next_page_token")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"participants")
While i < count_i
CkJsonObject::setCkI(jResp, i)
user_id = CkJsonObject::ckStringOf(jResp,"participants[i].user_id")
user_name = CkJsonObject::ckStringOf(jResp,"participants[i].user_name")
device = CkJsonObject::ckStringOf(jResp,"participants[i].device")
ip_address = CkJsonObject::ckStringOf(jResp,"participants[i].ip_address")
location = CkJsonObject::ckStringOf(jResp,"participants[i].location")
join_time = CkJsonObject::ckStringOf(jResp,"participants[i].join_time")
leave_time = CkJsonObject::ckStringOf(jResp,"participants[i].leave_time")
pc_name = CkJsonObject::ckStringOf(jResp,"participants[i].pc_name")
domain = CkJsonObject::ckStringOf(jResp,"participants[i].domain")
mac_addr = CkJsonObject::ckStringOf(jResp,"participants[i].mac_addr")
harddisk_id = CkJsonObject::ckStringOf(jResp,"participants[i].harddisk_id")
version = CkJsonObject::ckStringOf(jResp,"participants[i].version")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"participants[i].user_qos")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
CkJsonObject::ckDtOf(jResp,"participants[i].user_qos[j].date_time",0,date_time)
Bitrate = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].audio_input.bitrate")
Latency = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].audio_input.latency")
Jitter = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].audio_input.jitter")
Avg_loss = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].audio_input.avg_loss")
Max_loss = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].audio_input.max_loss")
audio_outputBitrate = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].audio_output.bitrate")
audio_outputLatency = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].audio_output.latency")
audio_outputJitter = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].audio_output.jitter")
audio_outputAvg_loss = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].audio_output.avg_loss")
audio_outputMax_loss = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].audio_output.max_loss")
video_inputBitrate = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].video_input.bitrate")
video_inputLatency = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].video_input.latency")
video_inputJitter = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].video_input.jitter")
video_inputAvg_loss = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].video_input.avg_loss")
video_inputMax_loss = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].video_input.max_loss")
Resolution = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].video_input.resolution")
Frame_rate = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].video_input.frame_rate")
video_outputBitrate = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].video_output.bitrate")
video_outputLatency = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].video_output.latency")
video_outputJitter = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].video_output.jitter")
video_outputAvg_loss = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].video_output.avg_loss")
video_outputMax_loss = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].video_output.max_loss")
video_outputResolution = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].video_output.resolution")
video_outputFrame_rate = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].video_output.frame_rate")
as_inputBitrate = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].as_input.bitrate")
as_inputLatency = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].as_input.latency")
as_inputJitter = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].as_input.jitter")
as_inputAvg_loss = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].as_input.avg_loss")
as_inputMax_loss = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].as_input.max_loss")
as_inputResolution = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].as_input.resolution")
as_inputFrame_rate = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].as_input.frame_rate")
as_outputBitrate = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].as_output.bitrate")
as_outputLatency = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].as_output.latency")
as_outputJitter = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].as_output.jitter")
as_outputAvg_loss = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].as_output.avg_loss")
as_outputMax_loss = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].as_output.max_loss")
as_outputResolution = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].as_output.resolution")
as_outputFrame_rate = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].as_output.frame_rate")
Zoom_min_cpu_usage = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].cpu_usage.zoom_min_cpu_usage")
Zoom_avg_cpu_usage = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].cpu_usage.zoom_avg_cpu_usage")
Zoom_max_cpu_usage = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].cpu_usage.zoom_max_cpu_usage")
System_max_cpu_usage = CkJsonObject::ckStringOf(jResp,"participants[i].user_qos[j].cpu_usage.system_max_cpu_usage")
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
CkDtObj::ckDispose(date_time)
ProcedureReturn
EndProcedure
Curl Command
curl -G -d "type=live"
-d "page_size=1"
-d "next_page_token=quis%20officia%20in%20reprehenderit"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/metrics/meetings/:meetingId/participants/qos
Postman Collection Item JSON
{
"name": "List meeting participants QoS",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/metrics/meetings/:meetingId/participants/qos?type=live&page_size=1&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"meetings",
":meetingId",
"participants",
"qos"
],
"query": [
{
"key": "type",
"value": "live",
"description": "The type of meeting to query: \n* `past` — All past meetings. \n* `live` - All live meetings. \n\nThis value defaults to `live`."
},
{
"key": "page_size",
"value": "1",
"description": "The number of items returned per page."
},
{
"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."
}
],
"variable": [
{
"key": "meetingId",
"value": "quis officia in reprehenderit",
"description": "(Required) The meeting's ID or universally unique ID (UUID). \n* If you provide a meeting ID, the API will return a response for the latest meeting instance. \n* If you provide a meeting UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the meeting UUID before making an API request."
}
]
},
"description": "Use this API to return a list of meeting participants from live or past meetings and their quality of service recieved during the meeting. The data returned indicates the connection quality for sending/receiving video, audio, and shared content. \n\n**Note:** \n\nThis API may return empty values for participants' `user_name`, `ip_address`, `location`, and `email` responses when the account calling this API: \n* Does **not** have a signed HIPAA business associate agreement (BAA). \n* Is a [**legacy** HIPAA BAA account](https://marketplace.zoom.us/docs/api-reference/other-references/legacy-business-associate-agreements). \n\n**Scopes:** `dashboard_meetings:read:admin` <br> **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy` \n\n**Prerequisites:** \n* A Business or a higher plan."
},
"response": [
{
"name": "**HTTP Status Code:** `200`<br>\nMeeting participants returned.<br>\nOnly available for paid accounts that have enabled the dashboard feature.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/metrics/meetings/:meetingId/participants/qos?type=live&page_size=1&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"meetings",
":meetingId",
"participants",
"qos"
],
"query": [
{
"key": "type",
"value": "live"
},
{
"key": "page_size",
"value": "1"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "meetingId",
"value": "quis officia in reprehenderit",
"description": "(Required) The meeting's ID or universally unique ID (UUID). \n* If you provide a meeting ID, the API will return a response for the latest meeting instance. \n* If you provide a meeting UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the meeting UUID before making an API request."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"page_count\": \"integer [int64]\",\n \"page_size\": \"integer\",\n \"total_records\": \"integer [int64]\",\n \"next_page_token\": \"string\",\n \"participants\": [\n {\n \"user_id\": \"1670000000\",\n \"user_name\": \"User\",\n \"device\": \"Android\",\n \"ip_address\": \"192.0.2.0\",\n \"location\": \"San Jose (US)\",\n \"join_time\": \"2021-06-24T20:00:00Z\",\n \"leave_time\": \"2021-06-24T20:00:00Z\",\n \"pc_name\": \"User's Phone\",\n \"domain\": \"user-android\",\n \"mac_addr\": \"\",\n \"harddisk_id\": \"\",\n \"version\": \"4.4.55383.0726\",\n \"user_qos\": [\n {\n \"date_time\": \"2021-06-24T20:00:00Z\",\n \"audio_input\": {\n \"bitrate\": \"23 kbps\",\n \"latency\": \"126 ms\",\n \"jitter\": \"6 ms\",\n \"avg_loss\": \"0.3%\",\n \"max_loss\": \"1.9%\"\n },\n \"audio_output\": {\n \"bitrate\": \"63 kbps\",\n \"latency\": \"134 ms\",\n \"jitter\": \"6 ms\",\n \"avg_loss\": \"0.0%\",\n \"max_loss\": \"0.0%\"\n },\n \"video_input\": {\n \"bitrate\": \"1055 kbps\",\n \"latency\": \"129 ms\",\n \"jitter\": \"11 ms\",\n \"avg_loss\": \"0.0%\",\n \"max_loss\": \"4.9%\",\n \"resolution\": \"1280*720\",\n \"frame_rate\": \"12 fps\"\n },\n \"video_output\": {\n \"bitrate\": \"673 kbps\",\n \"latency\": \"135 ms\",\n \"jitter\": \"11 ms\",\n \"avg_loss\": \"0.0%\",\n \"max_loss\": \"0.0%\",\n \"resolution\": \"640*360\",\n \"frame_rate\": \"22 fps\"\n },\n \"as_input\": {\n \"bitrate\": \"70 kbps\",\n \"latency\": \"135 ms\",\n \"jitter\": \"8 ms\",\n \"avg_loss\": \"0.0%\",\n \"max_loss\": \"0.0%\",\n \"resolution\": \"0*0\",\n \"frame_rate\": \"\"\n },\n \"as_output\": {\n \"bitrate\": \"70 kbps\",\n \"latency\": \"135 ms\",\n \"jitter\": \"8 ms\",\n \"avg_loss\": \"0.0%\",\n \"max_loss\": \"0.0%\",\n \"resolution\": \"0*0\",\n \"frame_rate\": \"\"\n },\n \"cpu_usage\": {\n \"zoom_min_cpu_usage\": \"8%\",\n \"zoom_avg_cpu_usage\": \"12%\",\n \"zoom_max_cpu_usage\": \"18%\",\n \"system_max_cpu_usage\": \"40%\"\n }\n }\n ]\n }\n ]\n}"
},
{
"name": "**Error Code:** `300`<br>\nCan not access webinar info, {meetingId}.<br>\nThe next page token is either invalid or expired.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/metrics/meetings/:meetingId/participants/qos?type=live&page_size=1&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"meetings",
":meetingId",
"participants",
"qos"
],
"query": [
{
"key": "type",
"value": "live"
},
{
"key": "page_size",
"value": "1"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "meetingId",
"value": "quis officia in reprehenderit",
"description": "(Required) The meeting's ID or universally unique ID (UUID). \n* If you provide a meeting ID, the API will return a response for the latest meeting instance. \n* If you provide a meeting UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the meeting UUID before making an API request."
}
]
}
},
"status": "Multiple Choices",
"code": 300,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `404`<br>\n**Error Code:** `3001`<br>\nThis meeting's detail info is not available.<br>\nThe Meeting ID is not valid or the meeting has not ended yet.\n",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/metrics/meetings/:meetingId/participants/qos?type=live&page_size=1&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"meetings",
":meetingId",
"participants",
"qos"
],
"query": [
{
"key": "type",
"value": "live"
},
{
"key": "page_size",
"value": "1"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "meetingId",
"value": "quis officia in reprehenderit",
"description": "(Required) The meeting's ID or universally unique ID (UUID). \n* If you provide a meeting ID, the API will return a response for the latest meeting instance. \n* If you provide a meeting UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the meeting UUID before making an API request."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
