Foxpro / Zoom API / List meetings
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcUuid
LOCAL lcId
LOCAL lcTopic
LOCAL lcHost
LOCAL lcEmail
LOCAL lcUser_type
LOCAL lcStart_time
LOCAL lcEnd_time
LOCAL lcDuration
LOCAL lcParticipants
LOCAL lcHas_pstn
LOCAL lcHas_voip
LOCAL lcHas_3rd_party_audio
LOCAL lcHas_video
LOCAL lcHas_screen_share
LOCAL lcHas_recording
LOCAL lcHas_sip
LOCAL lcHas_archiving
LOCAL lcFrom
LOCAL lcV_to
LOCAL lcPage_count
LOCAL lcPage_size
LOCAL lcTotal_records
LOCAL lcNext_page_token
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.Http')
loQueryParams = CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams.UpdateString("type","live")
loQueryParams.UpdateString("from","1989-05-07")
loQueryParams.UpdateString("to","1989-05-07")
loQueryParams.UpdateInt("page_size",30)
loQueryParams.UpdateString("next_page_token","quis officia in reprehenderit")
loQueryParams.UpdateString("include_fields","tracking_fields")
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loResp = loHttp.QuickRequestParams("GET","https://api.zoom.us/v2/metrics/meetings",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loQueryParams
CANCEL
ENDIF
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
loJResp = CreateObject('Chilkat_9_5_0.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)
* {
* "from": "string [date]",
* "to": "string [date]",
* "page_count": "integer",
* "page_size": "integer",
* "total_records": "integer",
* "next_page_token": "string",
* "meetings": [
* {
* "uuid": "string [uuid]",
* "id": "integer",
* "topic": "string",
* "host": "string",
* "email": "string",
* "user_type": "string",
* "start_time": "string [date-time]",
* "end_time": "string [date-time]",
* "duration": "string",
* "participants": "integer",
* "has_pstn": "boolean",
* "has_voip": "boolean",
* "has_3rd_party_audio": "boolean",
* "has_video": "boolean",
* "has_screen_share": "boolean",
* "has_recording": "boolean",
* "has_sip": "boolean",
* "has_archiving": "boolean"
* }
* ]
* }
* Sample code for parsing the JSON response...
* Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lcFrom = loJResp.StringOf("from")
lcV_to = loJResp.StringOf("to")
lcPage_count = loJResp.StringOf("page_count")
lcPage_size = loJResp.StringOf("page_size")
lcTotal_records = loJResp.StringOf("total_records")
lcNext_page_token = loJResp.StringOf("next_page_token")
i = 0
lnCount_i = loJResp.SizeOfArray("meetings")
DO WHILE i < lnCount_i
loJResp.I = i
lcUuid = loJResp.StringOf("meetings[i].uuid")
lcId = loJResp.StringOf("meetings[i].id")
lcTopic = loJResp.StringOf("meetings[i].topic")
lcHost = loJResp.StringOf("meetings[i].host")
lcEmail = loJResp.StringOf("meetings[i].email")
lcUser_type = loJResp.StringOf("meetings[i].user_type")
lcStart_time = loJResp.StringOf("meetings[i].start_time")
lcEnd_time = loJResp.StringOf("meetings[i].end_time")
lcDuration = loJResp.StringOf("meetings[i].duration")
lcParticipants = loJResp.StringOf("meetings[i].participants")
lcHas_pstn = loJResp.StringOf("meetings[i].has_pstn")
lcHas_voip = loJResp.StringOf("meetings[i].has_voip")
lcHas_3rd_party_audio = loJResp.StringOf("meetings[i].has_3rd_party_audio")
lcHas_video = loJResp.StringOf("meetings[i].has_video")
lcHas_screen_share = loJResp.StringOf("meetings[i].has_screen_share")
lcHas_recording = loJResp.StringOf("meetings[i].has_recording")
lcHas_sip = loJResp.StringOf("meetings[i].has_sip")
lcHas_archiving = loJResp.StringOf("meetings[i].has_archiving")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
Curl Command
curl -G -d "type=live"
-d "from=1989-05-07"
-d "to=1989-05-07"
-d "page_size=30"
-d "next_page_token=quis%20officia%20in%20reprehenderit"
-d "include_fields=tracking_fields"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/metrics/meetings
Postman Collection Item JSON
{
"name": "List meetings",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/metrics/meetings?type=live&from=1989-05-07&to=1989-05-07&page_size=30&next_page_token=quis officia in reprehenderit&include_fields=tracking_fields",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"meetings"
],
"query": [
{
"key": "type",
"value": "live",
"description": "Specify a value to get the response for the corresponding meeting type. The value of this field can be one of the following:<br> <br>`past` - Meeting that already occurred in the specified date range.<br>`pastOne` - Past meetings that were attended by only one user. <br>`live` - Live meetings.<br><br>\n\nIf you do not provide this field, the default value will be `live` and thus, the API will only query responses for live meetings."
},
{
"key": "from",
"value": "1989-05-07",
"description": "(Required) Start date in 'yyyy-mm-dd' format. The date range defined by the \"from\" and \"to\" parameters should only be one month as the report includes only one month worth of data at once."
},
{
"key": "to",
"value": "1989-05-07",
"description": "(Required) End date."
},
{
"key": "page_size",
"value": "30",
"description": "The number of records returned within a single API call."
},
{
"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."
},
{
"key": "include_fields",
"value": "tracking_fields",
"description": "Set the value of this field to \"tracking_fields\" if you would like to include tracking fields of each meeting in the response."
}
]
},
"description": "List total live or past meetings that occurred during a specified period of time. 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):** `Resource-intensive`<br><br>\n**Prerequisites:** <br>\n* Business or a higher plan.<br><br>"
},
"response": [
{
"name": "**HTTP Status Code:** `200`<br>\nMeetings returned.<br>\nOnly available for paid accounts that have dashboard feature enabled.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/metrics/meetings?type=live&from=1989-05-07&to=1989-05-07&page_size=30&next_page_token=quis officia in reprehenderit&include_fields=tracking_fields",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"meetings"
],
"query": [
{
"key": "type",
"value": "live"
},
{
"key": "from",
"value": "1989-05-07"
},
{
"key": "to",
"value": "1989-05-07"
},
{
"key": "page_size",
"value": "30"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
},
{
"key": "include_fields",
"value": "tracking_fields"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"from\": \"string [date]\",\n \"to\": \"string [date]\",\n \"page_count\": \"integer\",\n \"page_size\": \"integer\",\n \"total_records\": \"integer\",\n \"next_page_token\": \"string\",\n \"meetings\": [\n {\n \"uuid\": \"string [uuid]\",\n \"id\": \"integer\",\n \"topic\": \"string\",\n \"host\": \"string\",\n \"email\": \"string\",\n \"user_type\": \"string\",\n \"start_time\": \"string [date-time]\",\n \"end_time\": \"string [date-time]\",\n \"duration\": \"string\",\n \"participants\": \"integer\",\n \"has_pstn\": \"boolean\",\n \"has_voip\": \"boolean\",\n \"has_3rd_party_audio\": \"boolean\",\n \"has_video\": \"boolean\",\n \"has_screen_share\": \"boolean\",\n \"has_recording\": \"boolean\",\n \"has_sip\": \"boolean\",\n \"has_archiving\": \"boolean\"\n }\n ]\n}"
},
{
"name": "**Error Code:** `300`<br>\nThe next page token is invalid or expired.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/metrics/meetings?type=live&from=1989-05-07&to=1989-05-07&page_size=30&next_page_token=quis officia in reprehenderit&include_fields=tracking_fields",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"meetings"
],
"query": [
{
"key": "type",
"value": "live"
},
{
"key": "from",
"value": "1989-05-07"
},
{
"key": "to",
"value": "1989-05-07"
},
{
"key": "page_size",
"value": "30"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
},
{
"key": "include_fields",
"value": "tracking_fields"
}
]
}
},
"status": "Multiple Choices",
"code": 300,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
