PowerBuilder / Zoom API / Get webinar participant QoS
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
oleobject loo_Date_time
string ls_Bitrate
string ls_Latency
string ls_Jitter
string ls_Avg_loss
string ls_Max_loss
string ls_Audio_outputBitrate
string ls_Audio_outputLatency
string ls_Audio_outputJitter
string ls_Audio_outputAvg_loss
string ls_Audio_outputMax_loss
string ls_Video_inputBitrate
string ls_Video_inputLatency
string ls_Video_inputJitter
string ls_Video_inputAvg_loss
string ls_Video_inputMax_loss
string ls_Resolution
string ls_Frame_rate
string ls_Video_outputBitrate
string ls_Video_outputLatency
string ls_Video_outputJitter
string ls_Video_outputAvg_loss
string ls_Video_outputMax_loss
string ls_Video_outputResolution
string ls_Video_outputFrame_rate
string ls_As_inputBitrate
string ls_As_inputLatency
string ls_As_inputJitter
string ls_As_inputAvg_loss
string ls_As_inputMax_loss
string ls_As_inputResolution
string ls_As_inputFrame_rate
string ls_As_outputBitrate
string ls_As_outputLatency
string ls_As_outputJitter
string ls_As_outputAvg_loss
string ls_As_outputMax_loss
string ls_As_outputResolution
string ls_As_outputFrame_rate
string ls_Zoom_min_cpu_usage
string ls_Zoom_avg_cpu_usage
string ls_Zoom_max_cpu_usage
string ls_System_max_cpu_usage
string ls_User_id
string ls_User_name
string ls_Device
string ls_Ip_address
string ls_Location
string ls_Join_time
string ls_Leave_time
string ls_Pc_name
string ls_Domain
string ls_Mac_addr
string ls_Harddisk_id
string ls_Version
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_QueryParams = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat.JsonObject")
loo_QueryParams.UpdateString("type","live")
// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_Resp = loo_Http.QuickRequestParams("GET","https://api.zoom.us/v2/metrics/webinars/:webinarId/participants/:participantId/qos",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_QueryParams
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// 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
loo_Date_time = create oleobject
// Use "Chilkat_9_5_0.DtObj" for versions of Chilkat < 10.0.0
li_rc = loo_Date_time.ConnectToNewObject("Chilkat.DtObj")
ls_User_id = loo_JResp.StringOf("user_id")
ls_User_name = loo_JResp.StringOf("user_name")
ls_Device = loo_JResp.StringOf("device")
ls_Ip_address = loo_JResp.StringOf("ip_address")
ls_Location = loo_JResp.StringOf("location")
ls_Join_time = loo_JResp.StringOf("join_time")
ls_Leave_time = loo_JResp.StringOf("leave_time")
ls_Pc_name = loo_JResp.StringOf("pc_name")
ls_Domain = loo_JResp.StringOf("domain")
ls_Mac_addr = loo_JResp.StringOf("mac_addr")
ls_Harddisk_id = loo_JResp.StringOf("harddisk_id")
ls_Version = loo_JResp.StringOf("version")
i = 0
li_Count_i = loo_JResp.SizeOfArray("user_qos")
do while i < li_Count_i
loo_JResp.I = i
loo_JResp.DtOf("user_qos[i].date_time",0,loo_Date_time)
ls_Bitrate = loo_JResp.StringOf("user_qos[i].audio_input.bitrate")
ls_Latency = loo_JResp.StringOf("user_qos[i].audio_input.latency")
ls_Jitter = loo_JResp.StringOf("user_qos[i].audio_input.jitter")
ls_Avg_loss = loo_JResp.StringOf("user_qos[i].audio_input.avg_loss")
ls_Max_loss = loo_JResp.StringOf("user_qos[i].audio_input.max_loss")
ls_Audio_outputBitrate = loo_JResp.StringOf("user_qos[i].audio_output.bitrate")
ls_Audio_outputLatency = loo_JResp.StringOf("user_qos[i].audio_output.latency")
ls_Audio_outputJitter = loo_JResp.StringOf("user_qos[i].audio_output.jitter")
ls_Audio_outputAvg_loss = loo_JResp.StringOf("user_qos[i].audio_output.avg_loss")
ls_Audio_outputMax_loss = loo_JResp.StringOf("user_qos[i].audio_output.max_loss")
ls_Video_inputBitrate = loo_JResp.StringOf("user_qos[i].video_input.bitrate")
ls_Video_inputLatency = loo_JResp.StringOf("user_qos[i].video_input.latency")
ls_Video_inputJitter = loo_JResp.StringOf("user_qos[i].video_input.jitter")
ls_Video_inputAvg_loss = loo_JResp.StringOf("user_qos[i].video_input.avg_loss")
ls_Video_inputMax_loss = loo_JResp.StringOf("user_qos[i].video_input.max_loss")
ls_Resolution = loo_JResp.StringOf("user_qos[i].video_input.resolution")
ls_Frame_rate = loo_JResp.StringOf("user_qos[i].video_input.frame_rate")
ls_Video_outputBitrate = loo_JResp.StringOf("user_qos[i].video_output.bitrate")
ls_Video_outputLatency = loo_JResp.StringOf("user_qos[i].video_output.latency")
ls_Video_outputJitter = loo_JResp.StringOf("user_qos[i].video_output.jitter")
ls_Video_outputAvg_loss = loo_JResp.StringOf("user_qos[i].video_output.avg_loss")
ls_Video_outputMax_loss = loo_JResp.StringOf("user_qos[i].video_output.max_loss")
ls_Video_outputResolution = loo_JResp.StringOf("user_qos[i].video_output.resolution")
ls_Video_outputFrame_rate = loo_JResp.StringOf("user_qos[i].video_output.frame_rate")
ls_As_inputBitrate = loo_JResp.StringOf("user_qos[i].as_input.bitrate")
ls_As_inputLatency = loo_JResp.StringOf("user_qos[i].as_input.latency")
ls_As_inputJitter = loo_JResp.StringOf("user_qos[i].as_input.jitter")
ls_As_inputAvg_loss = loo_JResp.StringOf("user_qos[i].as_input.avg_loss")
ls_As_inputMax_loss = loo_JResp.StringOf("user_qos[i].as_input.max_loss")
ls_As_inputResolution = loo_JResp.StringOf("user_qos[i].as_input.resolution")
ls_As_inputFrame_rate = loo_JResp.StringOf("user_qos[i].as_input.frame_rate")
ls_As_outputBitrate = loo_JResp.StringOf("user_qos[i].as_output.bitrate")
ls_As_outputLatency = loo_JResp.StringOf("user_qos[i].as_output.latency")
ls_As_outputJitter = loo_JResp.StringOf("user_qos[i].as_output.jitter")
ls_As_outputAvg_loss = loo_JResp.StringOf("user_qos[i].as_output.avg_loss")
ls_As_outputMax_loss = loo_JResp.StringOf("user_qos[i].as_output.max_loss")
ls_As_outputResolution = loo_JResp.StringOf("user_qos[i].as_output.resolution")
ls_As_outputFrame_rate = loo_JResp.StringOf("user_qos[i].as_output.frame_rate")
ls_Zoom_min_cpu_usage = loo_JResp.StringOf("user_qos[i].cpu_usage.zoom_min_cpu_usage")
ls_Zoom_avg_cpu_usage = loo_JResp.StringOf("user_qos[i].cpu_usage.zoom_avg_cpu_usage")
ls_Zoom_max_cpu_usage = loo_JResp.StringOf("user_qos[i].cpu_usage.zoom_max_cpu_usage")
ls_System_max_cpu_usage = loo_JResp.StringOf("user_qos[i].cpu_usage.system_max_cpu_usage")
i = i + 1
loop
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
destroy loo_Date_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": ""
}
]
}
