autoit / Zoom API / List webinar participant QoS
Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateString("type","live")
$oQueryParams.UpdateInt("page_size",1)
$oQueryParams.UpdateString("next_page_token","quis officia in reprehenderit")
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
Local $oResp = $oHttp.QuickRequestParams("GET","https://api.zoom.us/v2/metrics/webinars/:webinarId/participants/qos",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
$oDate_time = ObjCreate("Chilkat.DtObj")
Local $sUser_id
Local $sUser_name
Local $sDevice
Local $sIp_address
Local $sLocation
Local $sJoin_time
Local $sLeave_time
Local $sPc_name
Local $sDomain
Local $sMac_addr
Local $sHarddisk_id
Local $sVersion
Local $iJ
Local $iCount_j
Local $sBitrate
Local $sLatency
Local $sJitter
Local $sAvg_loss
Local $sMax_loss
Local $sAudio_outputBitrate
Local $sAudio_outputLatency
Local $sAudio_outputJitter
Local $sAudio_outputAvg_loss
Local $sAudio_outputMax_loss
Local $sVideo_inputBitrate
Local $sVideo_inputLatency
Local $sVideo_inputJitter
Local $sVideo_inputAvg_loss
Local $sVideo_inputMax_loss
Local $sResolution
Local $sFrame_rate
Local $sVideo_outputBitrate
Local $sVideo_outputLatency
Local $sVideo_outputJitter
Local $sVideo_outputAvg_loss
Local $sVideo_outputMax_loss
Local $sVideo_outputResolution
Local $sVideo_outputFrame_rate
Local $sAs_inputBitrate
Local $sAs_inputLatency
Local $sAs_inputJitter
Local $sAs_inputAvg_loss
Local $sAs_inputMax_loss
Local $sAs_inputResolution
Local $sAs_inputFrame_rate
Local $sAs_outputBitrate
Local $sAs_outputLatency
Local $sAs_outputJitter
Local $sAs_outputAvg_loss
Local $sAs_outputMax_loss
Local $sAs_outputResolution
Local $sAs_outputFrame_rate
Local $sZoom_min_cpu_usage
Local $sZoom_avg_cpu_usage
Local $sZoom_max_cpu_usage
Local $sSystem_max_cpu_usage
Local $sPage_count = $oJResp.StringOf("page_count")
Local $sPage_size = $oJResp.StringOf("page_size")
Local $sTotal_records = $oJResp.StringOf("total_records")
Local $sNext_page_token = $oJResp.StringOf("next_page_token")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("participants")
While $i < $iCount_i
$oJResp.I = $i
$sUser_id = $oJResp.StringOf("participants[i].user_id")
$sUser_name = $oJResp.StringOf("participants[i].user_name")
$sDevice = $oJResp.StringOf("participants[i].device")
$sIp_address = $oJResp.StringOf("participants[i].ip_address")
$sLocation = $oJResp.StringOf("participants[i].location")
$sJoin_time = $oJResp.StringOf("participants[i].join_time")
$sLeave_time = $oJResp.StringOf("participants[i].leave_time")
$sPc_name = $oJResp.StringOf("participants[i].pc_name")
$sDomain = $oJResp.StringOf("participants[i].domain")
$sMac_addr = $oJResp.StringOf("participants[i].mac_addr")
$sHarddisk_id = $oJResp.StringOf("participants[i].harddisk_id")
$sVersion = $oJResp.StringOf("participants[i].version")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("participants[i].user_qos")
While $iJ < $iCount_j
$oJResp.J = $iJ
$oJResp.DtOf("participants[i].user_qos[j].date_time",False,$oDate_time)
$sBitrate = $oJResp.StringOf("participants[i].user_qos[j].audio_input.bitrate")
$sLatency = $oJResp.StringOf("participants[i].user_qos[j].audio_input.latency")
$sJitter = $oJResp.StringOf("participants[i].user_qos[j].audio_input.jitter")
$sAvg_loss = $oJResp.StringOf("participants[i].user_qos[j].audio_input.avg_loss")
$sMax_loss = $oJResp.StringOf("participants[i].user_qos[j].audio_input.max_loss")
$sAudio_outputBitrate = $oJResp.StringOf("participants[i].user_qos[j].audio_output.bitrate")
$sAudio_outputLatency = $oJResp.StringOf("participants[i].user_qos[j].audio_output.latency")
$sAudio_outputJitter = $oJResp.StringOf("participants[i].user_qos[j].audio_output.jitter")
$sAudio_outputAvg_loss = $oJResp.StringOf("participants[i].user_qos[j].audio_output.avg_loss")
$sAudio_outputMax_loss = $oJResp.StringOf("participants[i].user_qos[j].audio_output.max_loss")
$sVideo_inputBitrate = $oJResp.StringOf("participants[i].user_qos[j].video_input.bitrate")
$sVideo_inputLatency = $oJResp.StringOf("participants[i].user_qos[j].video_input.latency")
$sVideo_inputJitter = $oJResp.StringOf("participants[i].user_qos[j].video_input.jitter")
$sVideo_inputAvg_loss = $oJResp.StringOf("participants[i].user_qos[j].video_input.avg_loss")
$sVideo_inputMax_loss = $oJResp.StringOf("participants[i].user_qos[j].video_input.max_loss")
$sResolution = $oJResp.StringOf("participants[i].user_qos[j].video_input.resolution")
$sFrame_rate = $oJResp.StringOf("participants[i].user_qos[j].video_input.frame_rate")
$sVideo_outputBitrate = $oJResp.StringOf("participants[i].user_qos[j].video_output.bitrate")
$sVideo_outputLatency = $oJResp.StringOf("participants[i].user_qos[j].video_output.latency")
$sVideo_outputJitter = $oJResp.StringOf("participants[i].user_qos[j].video_output.jitter")
$sVideo_outputAvg_loss = $oJResp.StringOf("participants[i].user_qos[j].video_output.avg_loss")
$sVideo_outputMax_loss = $oJResp.StringOf("participants[i].user_qos[j].video_output.max_loss")
$sVideo_outputResolution = $oJResp.StringOf("participants[i].user_qos[j].video_output.resolution")
$sVideo_outputFrame_rate = $oJResp.StringOf("participants[i].user_qos[j].video_output.frame_rate")
$sAs_inputBitrate = $oJResp.StringOf("participants[i].user_qos[j].as_input.bitrate")
$sAs_inputLatency = $oJResp.StringOf("participants[i].user_qos[j].as_input.latency")
$sAs_inputJitter = $oJResp.StringOf("participants[i].user_qos[j].as_input.jitter")
$sAs_inputAvg_loss = $oJResp.StringOf("participants[i].user_qos[j].as_input.avg_loss")
$sAs_inputMax_loss = $oJResp.StringOf("participants[i].user_qos[j].as_input.max_loss")
$sAs_inputResolution = $oJResp.StringOf("participants[i].user_qos[j].as_input.resolution")
$sAs_inputFrame_rate = $oJResp.StringOf("participants[i].user_qos[j].as_input.frame_rate")
$sAs_outputBitrate = $oJResp.StringOf("participants[i].user_qos[j].as_output.bitrate")
$sAs_outputLatency = $oJResp.StringOf("participants[i].user_qos[j].as_output.latency")
$sAs_outputJitter = $oJResp.StringOf("participants[i].user_qos[j].as_output.jitter")
$sAs_outputAvg_loss = $oJResp.StringOf("participants[i].user_qos[j].as_output.avg_loss")
$sAs_outputMax_loss = $oJResp.StringOf("participants[i].user_qos[j].as_output.max_loss")
$sAs_outputResolution = $oJResp.StringOf("participants[i].user_qos[j].as_output.resolution")
$sAs_outputFrame_rate = $oJResp.StringOf("participants[i].user_qos[j].as_output.frame_rate")
$sZoom_min_cpu_usage = $oJResp.StringOf("participants[i].user_qos[j].cpu_usage.zoom_min_cpu_usage")
$sZoom_avg_cpu_usage = $oJResp.StringOf("participants[i].user_qos[j].cpu_usage.zoom_avg_cpu_usage")
$sZoom_max_cpu_usage = $oJResp.StringOf("participants[i].user_qos[j].cpu_usage.zoom_max_cpu_usage")
$sSystem_max_cpu_usage = $oJResp.StringOf("participants[i].user_qos[j].cpu_usage.system_max_cpu_usage")
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
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/webinars/:webinarId/participants/qos
Postman Collection Item JSON
{
"name": "List webinar participant QoS",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/metrics/webinars/:webinarId/participants/qos?type=live&page_size=1&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"webinars",
":webinarId",
"participants",
"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`."
},
{
"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": "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."
}
]
},
"description": "Use this API to return a list of webinar participants from live or past webinars and the quality of service they received during the webinar. 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_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 Webinar add-on."
},
"response": [
{
"name": "**HTTP Status Code:** `200`<br>\nWebinar 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/webinars/:webinarId/participants/qos?type=live&page_size=1&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"webinars",
":webinarId",
"participants",
"qos"
],
"query": [
{
"key": "type",
"value": "live"
},
{
"key": "page_size",
"value": "1"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
}
],
"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."
}
]
}
},
"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, {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/qos?type=live&page_size=1&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"webinars",
":webinarId",
"participants",
"qos"
],
"query": [
{
"key": "type",
"value": "live"
},
{
"key": "page_size",
"value": "1"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
}
],
"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."
}
]
}
},
"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 is not available or the Webinar ID is not valid.<br>\nThis webinar has not ended yet.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/metrics/webinars/:webinarId/participants/qos?type=live&page_size=1&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"webinars",
":webinarId",
"participants",
"qos"
],
"query": [
{
"key": "type",
"value": "live"
},
{
"key": "page_size",
"value": "1"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
}
],
"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."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
