DataFlex / Zoom API / Get webinar participant QoS
Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vQueryParams
Handle hoQueryParams
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
Variant vDate_time
Handle hoDate_time
String sBitrate
String sLatency
String sJitter
String sAvg_loss
String sMax_loss
String sAudio_outputBitrate
String sAudio_outputLatency
String sAudio_outputJitter
String sAudio_outputAvg_loss
String sAudio_outputMax_loss
String sVideo_inputBitrate
String sVideo_inputLatency
String sVideo_inputJitter
String sVideo_inputAvg_loss
String sVideo_inputMax_loss
String sResolution
String sFrame_rate
String sVideo_outputBitrate
String sVideo_outputLatency
String sVideo_outputJitter
String sVideo_outputAvg_loss
String sVideo_outputMax_loss
String sVideo_outputResolution
String sVideo_outputFrame_rate
String sAs_inputBitrate
String sAs_inputLatency
String sAs_inputJitter
String sAs_inputAvg_loss
String sAs_inputMax_loss
String sAs_inputResolution
String sAs_inputFrame_rate
String sAs_outputBitrate
String sAs_outputLatency
String sAs_outputJitter
String sAs_outputAvg_loss
String sAs_outputMax_loss
String sAs_outputResolution
String sAs_outputFrame_rate
String sZoom_min_cpu_usage
String sZoom_avg_cpu_usage
String sZoom_max_cpu_usage
String sSystem_max_cpu_usage
String sUser_id
String sUser_name
String sDevice
String sIp_address
String sLocation
String sJoin_time
String sLeave_time
String sPc_name
String sDomain
String sMac_addr
String sHarddisk_id
String sVersion
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Get Create (RefClass(cComChilkatJsonObject)) To hoQueryParams
If (Not(IsComObjectCreated(hoQueryParams))) Begin
Send CreateComObject of hoQueryParams
End
Get ComUpdateString Of hoQueryParams "type" "live" To iSuccess
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Get pvComObject of hoQueryParams to vQueryParams
Get ComQuickRequestParams Of hoHttp "GET" "https://api.zoom.us/v2/metrics/webinars/:webinarId/participants/:participantId/qos" vQueryParams To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "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
Get Create (RefClass(cComChilkatDtObj)) To hoDate_time
If (Not(IsComObjectCreated(hoDate_time))) Begin
Send CreateComObject of hoDate_time
End
Get ComStringOf Of hoJResp "user_id" To sUser_id
Get ComStringOf Of hoJResp "user_name" To sUser_name
Get ComStringOf Of hoJResp "device" To sDevice
Get ComStringOf Of hoJResp "ip_address" To sIp_address
Get ComStringOf Of hoJResp "location" To sLocation
Get ComStringOf Of hoJResp "join_time" To sJoin_time
Get ComStringOf Of hoJResp "leave_time" To sLeave_time
Get ComStringOf Of hoJResp "pc_name" To sPc_name
Get ComStringOf Of hoJResp "domain" To sDomain
Get ComStringOf Of hoJResp "mac_addr" To sMac_addr
Get ComStringOf Of hoJResp "harddisk_id" To sHarddisk_id
Get ComStringOf Of hoJResp "version" To sVersion
Move 0 To i
Get ComSizeOfArray Of hoJResp "user_qos" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get pvComObject of hoDate_time to vDate_time
Get ComDtOf Of hoJResp "user_qos[i].date_time" False vDate_time To iSuccess
Get ComStringOf Of hoJResp "user_qos[i].audio_input.bitrate" To sBitrate
Get ComStringOf Of hoJResp "user_qos[i].audio_input.latency" To sLatency
Get ComStringOf Of hoJResp "user_qos[i].audio_input.jitter" To sJitter
Get ComStringOf Of hoJResp "user_qos[i].audio_input.avg_loss" To sAvg_loss
Get ComStringOf Of hoJResp "user_qos[i].audio_input.max_loss" To sMax_loss
Get ComStringOf Of hoJResp "user_qos[i].audio_output.bitrate" To sAudio_outputBitrate
Get ComStringOf Of hoJResp "user_qos[i].audio_output.latency" To sAudio_outputLatency
Get ComStringOf Of hoJResp "user_qos[i].audio_output.jitter" To sAudio_outputJitter
Get ComStringOf Of hoJResp "user_qos[i].audio_output.avg_loss" To sAudio_outputAvg_loss
Get ComStringOf Of hoJResp "user_qos[i].audio_output.max_loss" To sAudio_outputMax_loss
Get ComStringOf Of hoJResp "user_qos[i].video_input.bitrate" To sVideo_inputBitrate
Get ComStringOf Of hoJResp "user_qos[i].video_input.latency" To sVideo_inputLatency
Get ComStringOf Of hoJResp "user_qos[i].video_input.jitter" To sVideo_inputJitter
Get ComStringOf Of hoJResp "user_qos[i].video_input.avg_loss" To sVideo_inputAvg_loss
Get ComStringOf Of hoJResp "user_qos[i].video_input.max_loss" To sVideo_inputMax_loss
Get ComStringOf Of hoJResp "user_qos[i].video_input.resolution" To sResolution
Get ComStringOf Of hoJResp "user_qos[i].video_input.frame_rate" To sFrame_rate
Get ComStringOf Of hoJResp "user_qos[i].video_output.bitrate" To sVideo_outputBitrate
Get ComStringOf Of hoJResp "user_qos[i].video_output.latency" To sVideo_outputLatency
Get ComStringOf Of hoJResp "user_qos[i].video_output.jitter" To sVideo_outputJitter
Get ComStringOf Of hoJResp "user_qos[i].video_output.avg_loss" To sVideo_outputAvg_loss
Get ComStringOf Of hoJResp "user_qos[i].video_output.max_loss" To sVideo_outputMax_loss
Get ComStringOf Of hoJResp "user_qos[i].video_output.resolution" To sVideo_outputResolution
Get ComStringOf Of hoJResp "user_qos[i].video_output.frame_rate" To sVideo_outputFrame_rate
Get ComStringOf Of hoJResp "user_qos[i].as_input.bitrate" To sAs_inputBitrate
Get ComStringOf Of hoJResp "user_qos[i].as_input.latency" To sAs_inputLatency
Get ComStringOf Of hoJResp "user_qos[i].as_input.jitter" To sAs_inputJitter
Get ComStringOf Of hoJResp "user_qos[i].as_input.avg_loss" To sAs_inputAvg_loss
Get ComStringOf Of hoJResp "user_qos[i].as_input.max_loss" To sAs_inputMax_loss
Get ComStringOf Of hoJResp "user_qos[i].as_input.resolution" To sAs_inputResolution
Get ComStringOf Of hoJResp "user_qos[i].as_input.frame_rate" To sAs_inputFrame_rate
Get ComStringOf Of hoJResp "user_qos[i].as_output.bitrate" To sAs_outputBitrate
Get ComStringOf Of hoJResp "user_qos[i].as_output.latency" To sAs_outputLatency
Get ComStringOf Of hoJResp "user_qos[i].as_output.jitter" To sAs_outputJitter
Get ComStringOf Of hoJResp "user_qos[i].as_output.avg_loss" To sAs_outputAvg_loss
Get ComStringOf Of hoJResp "user_qos[i].as_output.max_loss" To sAs_outputMax_loss
Get ComStringOf Of hoJResp "user_qos[i].as_output.resolution" To sAs_outputResolution
Get ComStringOf Of hoJResp "user_qos[i].as_output.frame_rate" To sAs_outputFrame_rate
Get ComStringOf Of hoJResp "user_qos[i].cpu_usage.zoom_min_cpu_usage" To sZoom_min_cpu_usage
Get ComStringOf Of hoJResp "user_qos[i].cpu_usage.zoom_avg_cpu_usage" To sZoom_avg_cpu_usage
Get ComStringOf Of hoJResp "user_qos[i].cpu_usage.zoom_max_cpu_usage" To sZoom_max_cpu_usage
Get ComStringOf Of hoJResp "user_qos[i].cpu_usage.system_max_cpu_usage" To sSystem_max_cpu_usage
Move (i + 1) To i
Loop
End_Procedure
Curl Command
curl -G -d "type=live"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/metrics/webinars/:webinarId/participants/:participantId/qos
Postman Collection Item JSON
{
"name": "Get webinar participant QoS",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/metrics/webinars/:webinarId/participants/:participantId/qos?type=live",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"webinars",
":webinarId",
"participants",
":participantId",
"qos"
],
"query": [
{
"key": "type",
"value": "live",
"description": "The type of webinar to query: \n* `past` — All past webinars. \n* `live` - All live webinars. \n\nThis value defaults to `live`."
}
],
"variable": [
{
"key": "webinarId",
"value": "quis officia in reprehenderit",
"description": "(Required) The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the webinar UUID before making an API request."
},
{
"key": "participantId",
"value": "quis officia in reprehenderit",
"description": "(Required) The participant's ID."
}
]
},
"description": "Use this API to return the quality of service (QoS) for participants during live or past webinars. This data returned indicates the connection quality for sending/receiving video, audio, and shared content. The API returns this data for either the API request or when the API request was last received. \n\nWhen the sender sends its data, a timestamp is attached to the sender’s data packet. The receiver then returns this timestamp to the sender. This helps determine the upstream and downstream latency, which includes the application processing time. The latency data returned is the five second average and five second maximum. \n\nThis API will **not** return data if there is no data being sent or received at the time of request. \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_webinars:read:admin` <br> **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy` \n\n**Prerequisites:** \n* A Business, Education, or API Plan with Zoom Rooms set up."
},
"response": [
{
"name": "**HTTP Status Code:** `200`<br>\nWebinar participant QOS returned.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/metrics/webinars/:webinarId/participants/:participantId/qos?type=live",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"webinars",
":webinarId",
"participants",
":participantId",
"qos"
],
"query": [
{
"key": "type",
"value": "live"
}
],
"variable": [
{
"key": "webinarId",
"value": "quis officia in reprehenderit",
"description": "(Required) The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the webinar UUID before making an API request."
},
{
"key": "participantId",
"value": "quis officia in reprehenderit",
"description": "(Required) The participant's ID."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\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}"
},
{
"name": "**Error Code:** `300`<br>\nCan not access webinar info, {webinarId}.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/metrics/webinars/:webinarId/participants/:participantId/qos?type=live",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"webinars",
":webinarId",
"participants",
":participantId",
"qos"
],
"query": [
{
"key": "type",
"value": "live"
}
],
"variable": [
{
"key": "webinarId",
"value": "quis officia in reprehenderit",
"description": "(Required) The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the webinar UUID before making an API request."
},
{
"key": "participantId",
"value": "quis officia in reprehenderit",
"description": "(Required) The participant's ID."
}
]
}
},
"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 webinar's detail info is not available or ID is not valid.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/metrics/webinars/:webinarId/participants/:participantId/qos?type=live",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"webinars",
":webinarId",
"participants",
":participantId",
"qos"
],
"query": [
{
"key": "type",
"value": "live"
}
],
"variable": [
{
"key": "webinarId",
"value": "quis officia in reprehenderit",
"description": "(Required) The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the webinar UUID before making an API request."
},
{
"key": "participantId",
"value": "quis officia in reprehenderit",
"description": "(Required) The participant's ID."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
