Mono / Zoom API / Get 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.
Chilkat.Http http = new Chilkat.Http();
bool success;
Chilkat.JsonObject queryParams = new Chilkat.JsonObject();
queryParams.UpdateString("type","live");
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>";
Chilkat.HttpResponse resp = http.QuickRequestParams("GET","https://api.zoom.us/v2/metrics/webinars/:webinarId/participants/:participantId/qos",queryParams);
if (http.LastMethodSuccess == false) {
Debug.WriteLine(http.LastErrorText);
return;
}
Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);
Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;
Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());
int respStatusCode = resp.StatusCode;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
Debug.WriteLine("Response Header:");
Debug.WriteLine(resp.Header);
Debug.WriteLine("Failed.");
return;
}
// 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
Chilkat.DtObj date_time = new Chilkat.DtObj();
string Bitrate;
string Latency;
string Jitter;
string Avg_loss;
string Max_loss;
string audio_outputBitrate;
string audio_outputLatency;
string audio_outputJitter;
string audio_outputAvg_loss;
string audio_outputMax_loss;
string video_inputBitrate;
string video_inputLatency;
string video_inputJitter;
string video_inputAvg_loss;
string video_inputMax_loss;
string Resolution;
string Frame_rate;
string video_outputBitrate;
string video_outputLatency;
string video_outputJitter;
string video_outputAvg_loss;
string video_outputMax_loss;
string video_outputResolution;
string video_outputFrame_rate;
string as_inputBitrate;
string as_inputLatency;
string as_inputJitter;
string as_inputAvg_loss;
string as_inputMax_loss;
string as_inputResolution;
string as_inputFrame_rate;
string as_outputBitrate;
string as_outputLatency;
string as_outputJitter;
string as_outputAvg_loss;
string as_outputMax_loss;
string as_outputResolution;
string as_outputFrame_rate;
string Zoom_min_cpu_usage;
string Zoom_avg_cpu_usage;
string Zoom_max_cpu_usage;
string System_max_cpu_usage;
string user_id = jResp.StringOf("user_id");
string user_name = jResp.StringOf("user_name");
string device = jResp.StringOf("device");
string ip_address = jResp.StringOf("ip_address");
string location = jResp.StringOf("location");
string join_time = jResp.StringOf("join_time");
string leave_time = jResp.StringOf("leave_time");
string pc_name = jResp.StringOf("pc_name");
string domain = jResp.StringOf("domain");
string mac_addr = jResp.StringOf("mac_addr");
string harddisk_id = jResp.StringOf("harddisk_id");
string version = jResp.StringOf("version");
int i = 0;
int count_i = jResp.SizeOfArray("user_qos");
while (i < count_i) {
jResp.I = i;
jResp.DtOf("user_qos[i].date_time",false,date_time);
Bitrate = jResp.StringOf("user_qos[i].audio_input.bitrate");
Latency = jResp.StringOf("user_qos[i].audio_input.latency");
Jitter = jResp.StringOf("user_qos[i].audio_input.jitter");
Avg_loss = jResp.StringOf("user_qos[i].audio_input.avg_loss");
Max_loss = jResp.StringOf("user_qos[i].audio_input.max_loss");
audio_outputBitrate = jResp.StringOf("user_qos[i].audio_output.bitrate");
audio_outputLatency = jResp.StringOf("user_qos[i].audio_output.latency");
audio_outputJitter = jResp.StringOf("user_qos[i].audio_output.jitter");
audio_outputAvg_loss = jResp.StringOf("user_qos[i].audio_output.avg_loss");
audio_outputMax_loss = jResp.StringOf("user_qos[i].audio_output.max_loss");
video_inputBitrate = jResp.StringOf("user_qos[i].video_input.bitrate");
video_inputLatency = jResp.StringOf("user_qos[i].video_input.latency");
video_inputJitter = jResp.StringOf("user_qos[i].video_input.jitter");
video_inputAvg_loss = jResp.StringOf("user_qos[i].video_input.avg_loss");
video_inputMax_loss = jResp.StringOf("user_qos[i].video_input.max_loss");
Resolution = jResp.StringOf("user_qos[i].video_input.resolution");
Frame_rate = jResp.StringOf("user_qos[i].video_input.frame_rate");
video_outputBitrate = jResp.StringOf("user_qos[i].video_output.bitrate");
video_outputLatency = jResp.StringOf("user_qos[i].video_output.latency");
video_outputJitter = jResp.StringOf("user_qos[i].video_output.jitter");
video_outputAvg_loss = jResp.StringOf("user_qos[i].video_output.avg_loss");
video_outputMax_loss = jResp.StringOf("user_qos[i].video_output.max_loss");
video_outputResolution = jResp.StringOf("user_qos[i].video_output.resolution");
video_outputFrame_rate = jResp.StringOf("user_qos[i].video_output.frame_rate");
as_inputBitrate = jResp.StringOf("user_qos[i].as_input.bitrate");
as_inputLatency = jResp.StringOf("user_qos[i].as_input.latency");
as_inputJitter = jResp.StringOf("user_qos[i].as_input.jitter");
as_inputAvg_loss = jResp.StringOf("user_qos[i].as_input.avg_loss");
as_inputMax_loss = jResp.StringOf("user_qos[i].as_input.max_loss");
as_inputResolution = jResp.StringOf("user_qos[i].as_input.resolution");
as_inputFrame_rate = jResp.StringOf("user_qos[i].as_input.frame_rate");
as_outputBitrate = jResp.StringOf("user_qos[i].as_output.bitrate");
as_outputLatency = jResp.StringOf("user_qos[i].as_output.latency");
as_outputJitter = jResp.StringOf("user_qos[i].as_output.jitter");
as_outputAvg_loss = jResp.StringOf("user_qos[i].as_output.avg_loss");
as_outputMax_loss = jResp.StringOf("user_qos[i].as_output.max_loss");
as_outputResolution = jResp.StringOf("user_qos[i].as_output.resolution");
as_outputFrame_rate = jResp.StringOf("user_qos[i].as_output.frame_rate");
Zoom_min_cpu_usage = jResp.StringOf("user_qos[i].cpu_usage.zoom_min_cpu_usage");
Zoom_avg_cpu_usage = jResp.StringOf("user_qos[i].cpu_usage.zoom_avg_cpu_usage");
Zoom_max_cpu_usage = jResp.StringOf("user_qos[i].cpu_usage.zoom_max_cpu_usage");
System_max_cpu_usage = jResp.StringOf("user_qos[i].cpu_usage.system_max_cpu_usage");
i = i + 1;
}
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": ""
}
]
}
