Foxpro / Zoom API / Get webinar participant QoS
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL loDate_time
LOCAL lcBitrate
LOCAL lcLatency
LOCAL lcJitter
LOCAL lcAvg_loss
LOCAL lcMax_loss
LOCAL lcAudio_outputBitrate
LOCAL lcAudio_outputLatency
LOCAL lcAudio_outputJitter
LOCAL lcAudio_outputAvg_loss
LOCAL lcAudio_outputMax_loss
LOCAL lcVideo_inputBitrate
LOCAL lcVideo_inputLatency
LOCAL lcVideo_inputJitter
LOCAL lcVideo_inputAvg_loss
LOCAL lcVideo_inputMax_loss
LOCAL lcResolution
LOCAL lcFrame_rate
LOCAL lcVideo_outputBitrate
LOCAL lcVideo_outputLatency
LOCAL lcVideo_outputJitter
LOCAL lcVideo_outputAvg_loss
LOCAL lcVideo_outputMax_loss
LOCAL lcVideo_outputResolution
LOCAL lcVideo_outputFrame_rate
LOCAL lcAs_inputBitrate
LOCAL lcAs_inputLatency
LOCAL lcAs_inputJitter
LOCAL lcAs_inputAvg_loss
LOCAL lcAs_inputMax_loss
LOCAL lcAs_inputResolution
LOCAL lcAs_inputFrame_rate
LOCAL lcAs_outputBitrate
LOCAL lcAs_outputLatency
LOCAL lcAs_outputJitter
LOCAL lcAs_outputAvg_loss
LOCAL lcAs_outputMax_loss
LOCAL lcAs_outputResolution
LOCAL lcAs_outputFrame_rate
LOCAL lcZoom_min_cpu_usage
LOCAL lcZoom_avg_cpu_usage
LOCAL lcZoom_max_cpu_usage
LOCAL lcSystem_max_cpu_usage
LOCAL lcUser_id
LOCAL lcUser_name
LOCAL lcDevice
LOCAL lcIp_address
LOCAL lcLocation
LOCAL lcJoin_time
LOCAL lcLeave_time
LOCAL lcPc_name
LOCAL lcDomain
LOCAL lcMac_addr
LOCAL lcHarddisk_id
LOCAL lcVersion
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams = CreateObject('Chilkat.JsonObject')
loQueryParams.UpdateString("type","live")
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loResp = loHttp.QuickRequestParams("GET","https://api.zoom.us/v2/metrics/webinars/:webinarId/participants/:participantId/qos",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loQueryParams
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "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
CANCEL
ENDIF
RELEASE loResp
* 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
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.DtObj')
loDate_time = CreateObject('Chilkat.DtObj')
lcUser_id = loJResp.StringOf("user_id")
lcUser_name = loJResp.StringOf("user_name")
lcDevice = loJResp.StringOf("device")
lcIp_address = loJResp.StringOf("ip_address")
lcLocation = loJResp.StringOf("location")
lcJoin_time = loJResp.StringOf("join_time")
lcLeave_time = loJResp.StringOf("leave_time")
lcPc_name = loJResp.StringOf("pc_name")
lcDomain = loJResp.StringOf("domain")
lcMac_addr = loJResp.StringOf("mac_addr")
lcHarddisk_id = loJResp.StringOf("harddisk_id")
lcVersion = loJResp.StringOf("version")
i = 0
lnCount_i = loJResp.SizeOfArray("user_qos")
DO WHILE i < lnCount_i
loJResp.I = i
loJResp.DtOf("user_qos[i].date_time",0,loDate_time)
lcBitrate = loJResp.StringOf("user_qos[i].audio_input.bitrate")
lcLatency = loJResp.StringOf("user_qos[i].audio_input.latency")
lcJitter = loJResp.StringOf("user_qos[i].audio_input.jitter")
lcAvg_loss = loJResp.StringOf("user_qos[i].audio_input.avg_loss")
lcMax_loss = loJResp.StringOf("user_qos[i].audio_input.max_loss")
lcAudio_outputBitrate = loJResp.StringOf("user_qos[i].audio_output.bitrate")
lcAudio_outputLatency = loJResp.StringOf("user_qos[i].audio_output.latency")
lcAudio_outputJitter = loJResp.StringOf("user_qos[i].audio_output.jitter")
lcAudio_outputAvg_loss = loJResp.StringOf("user_qos[i].audio_output.avg_loss")
lcAudio_outputMax_loss = loJResp.StringOf("user_qos[i].audio_output.max_loss")
lcVideo_inputBitrate = loJResp.StringOf("user_qos[i].video_input.bitrate")
lcVideo_inputLatency = loJResp.StringOf("user_qos[i].video_input.latency")
lcVideo_inputJitter = loJResp.StringOf("user_qos[i].video_input.jitter")
lcVideo_inputAvg_loss = loJResp.StringOf("user_qos[i].video_input.avg_loss")
lcVideo_inputMax_loss = loJResp.StringOf("user_qos[i].video_input.max_loss")
lcResolution = loJResp.StringOf("user_qos[i].video_input.resolution")
lcFrame_rate = loJResp.StringOf("user_qos[i].video_input.frame_rate")
lcVideo_outputBitrate = loJResp.StringOf("user_qos[i].video_output.bitrate")
lcVideo_outputLatency = loJResp.StringOf("user_qos[i].video_output.latency")
lcVideo_outputJitter = loJResp.StringOf("user_qos[i].video_output.jitter")
lcVideo_outputAvg_loss = loJResp.StringOf("user_qos[i].video_output.avg_loss")
lcVideo_outputMax_loss = loJResp.StringOf("user_qos[i].video_output.max_loss")
lcVideo_outputResolution = loJResp.StringOf("user_qos[i].video_output.resolution")
lcVideo_outputFrame_rate = loJResp.StringOf("user_qos[i].video_output.frame_rate")
lcAs_inputBitrate = loJResp.StringOf("user_qos[i].as_input.bitrate")
lcAs_inputLatency = loJResp.StringOf("user_qos[i].as_input.latency")
lcAs_inputJitter = loJResp.StringOf("user_qos[i].as_input.jitter")
lcAs_inputAvg_loss = loJResp.StringOf("user_qos[i].as_input.avg_loss")
lcAs_inputMax_loss = loJResp.StringOf("user_qos[i].as_input.max_loss")
lcAs_inputResolution = loJResp.StringOf("user_qos[i].as_input.resolution")
lcAs_inputFrame_rate = loJResp.StringOf("user_qos[i].as_input.frame_rate")
lcAs_outputBitrate = loJResp.StringOf("user_qos[i].as_output.bitrate")
lcAs_outputLatency = loJResp.StringOf("user_qos[i].as_output.latency")
lcAs_outputJitter = loJResp.StringOf("user_qos[i].as_output.jitter")
lcAs_outputAvg_loss = loJResp.StringOf("user_qos[i].as_output.avg_loss")
lcAs_outputMax_loss = loJResp.StringOf("user_qos[i].as_output.max_loss")
lcAs_outputResolution = loJResp.StringOf("user_qos[i].as_output.resolution")
lcAs_outputFrame_rate = loJResp.StringOf("user_qos[i].as_output.frame_rate")
lcZoom_min_cpu_usage = loJResp.StringOf("user_qos[i].cpu_usage.zoom_min_cpu_usage")
lcZoom_avg_cpu_usage = loJResp.StringOf("user_qos[i].cpu_usage.zoom_avg_cpu_usage")
lcZoom_max_cpu_usage = loJResp.StringOf("user_qos[i].cpu_usage.zoom_max_cpu_usage")
lcSystem_max_cpu_usage = loJResp.StringOf("user_qos[i].cpu_usage.system_max_cpu_usage")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
RELEASE loDate_time
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": ""
}
]
}
