phpAx / Zoom API / Get meeting details
Back to Collection Items
<?php
// 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 new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$queryParams = new COM("Chilkat.JsonObject");
$queryParams->UpdateString('type','live');
// Adds the "Authorization: Bearer <access_token>" header.
$http->AuthToken = '<access_token>';
// resp is a Chilkat.HttpResponse
$resp = $http->QuickRequestParams('GET','https://api.zoom.us/v2/metrics/meetings/:meetingId',$queryParams);
if ($http->LastMethodSuccess == 0) {
print $http->LastErrorText . "\n";
exit;
}
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$resp->GetBodySb($sbResponseBody);
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->Header . "\n";
print 'Failed.' . "\n";
exit;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "uuid": "carreter@-2c9b447f3",
// "id": 33281536,
// "topic": "My meeting",
// "host": "cool host",
// "email": "example@example.com",
// "user_type": "Pro|Webinar1000",
// "start_time": "2007-06-16T16:55:42.078Z",
// "end_time": "2007-06-16T16:59:42.078Z",
// "duration": "30:00",
// "participants": 4874645,
// "has_pstn": false,
// "has_voip": false,
// "has_3rd_party_audio": false,
// "has_video": false,
// "has_screen_share": false,
// "has_recording": false,
// "has_sip": false,
// "has_archiving": false,
// "in_room_participants": 3
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$uuid = $jResp->stringOf('uuid');
$id = $jResp->IntOf('id');
$topic = $jResp->stringOf('topic');
$host = $jResp->stringOf('host');
$email = $jResp->stringOf('email');
$user_type = $jResp->stringOf('user_type');
$start_time = $jResp->stringOf('start_time');
$end_time = $jResp->stringOf('end_time');
$duration = $jResp->stringOf('duration');
$participants = $jResp->IntOf('participants');
$has_pstn = $jResp->BoolOf('has_pstn');
$has_voip = $jResp->BoolOf('has_voip');
$has_3rd_party_audio = $jResp->BoolOf('has_3rd_party_audio');
$has_video = $jResp->BoolOf('has_video');
$has_screen_share = $jResp->BoolOf('has_screen_share');
$has_recording = $jResp->BoolOf('has_recording');
$has_sip = $jResp->BoolOf('has_sip');
$has_archiving = $jResp->BoolOf('has_archiving');
$in_room_participants = $jResp->IntOf('in_room_participants');
?>
Curl Command
curl -G -d "type=live"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/metrics/meetings/:meetingId
Postman Collection Item JSON
{
"name": "Get meeting details",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/metrics/meetings/:meetingId?type=live",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"meetings",
":meetingId"
],
"query": [
{
"key": "type",
"value": "live",
"description": "The type of meeting to query: \n* `past` — All past meetings. \n* `pastOne` — All past one-user meetings. \n* `live` - All live meetings. \n\nThis value defaults to `live`."
}
],
"variable": [
{
"key": "meetingId",
"value": "quis officia in reprehenderit",
"description": "(Required) The meeting's ID or universally unique ID (UUID). \n* If you provide a meeting ID, the API will return a response for the latest meeting instance. \n* If you provide a meeting UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the meeting UUID before making an API request."
}
]
},
"description": "Get details on live or past meetings. This overview will show if features such as audio, video, screen sharing, and recording were being used in the meeting. You can also see the license types of each user on your account.<br> You can specify a monthly date range for the dashboard data using the `from` and `to` query parameters. The month should fall within the last six months. <br>\n**Scopes:** `dashboard_meetings:read:admin`<br>\n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`<br>\n**Prerequisites:** <br>\n* Business or a higher plan."
},
"response": [
{
"name": "**HTTP Status Code:** `200`<br>\nMeeting 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/meetings/:meetingId?type=live",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"meetings",
":meetingId"
],
"query": [
{
"key": "type",
"value": "live"
}
],
"variable": [
{
"key": "meetingId",
"value": "quis officia in reprehenderit",
"description": "(Required) The meeting's ID or universally unique ID (UUID). \n* If you provide a meeting ID, the API will return a response for the latest meeting instance. \n* If you provide a meeting UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the meeting UUID before making an API request."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"uuid\": \"carreter@-2c9b447f3\",\n \"id\": 33281536,\n \"topic\": \"My meeting\",\n \"host\": \"cool host\",\n \"email\": \"example@example.com\",\n \"user_type\": \"Pro|Webinar1000\",\n \"start_time\": \"2007-06-16T16:55:42.078Z\",\n \"end_time\": \"2007-06-16T16:59:42.078Z\",\n \"duration\": \"30:00\",\n \"participants\": 4874645,\n \"has_pstn\": false,\n \"has_voip\": false,\n \"has_3rd_party_audio\": false,\n \"has_video\": false,\n \"has_screen_share\": false,\n \"has_recording\": false,\n \"has_sip\": false,\n \"has_archiving\": false,\n \"in_room_participants\": 3\n}"
},
{
"name": "**Error Code:** `300`<br>\nCan not access webinar info, {meetingId}.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/metrics/meetings/:meetingId?type=live",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"meetings",
":meetingId"
],
"query": [
{
"key": "type",
"value": "live"
}
],
"variable": [
{
"key": "meetingId",
"value": "quis officia in reprehenderit",
"description": "(Required) The meeting's ID or universally unique ID (UUID). \n* If you provide a meeting ID, the API will return a response for the latest meeting instance. \n* If you provide a meeting UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the meeting 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>\nMeeting ID is invalid or the meeting has not ended yet.<br>\nThis meeting's details are not available.\n",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/metrics/meetings/:meetingId?type=live",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"meetings",
":meetingId"
],
"query": [
{
"key": "type",
"value": "live"
}
],
"variable": [
{
"key": "meetingId",
"value": "quis officia in reprehenderit",
"description": "(Required) The meeting's ID or universally unique ID (UUID). \n* If you provide a meeting ID, the API will return a response for the latest meeting instance. \n* If you provide a meeting UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the meeting UUID before making an API request."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
