lianja / Zoom API / List meetings
Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
loQueryParams = createobject("CkJsonObject")
loQueryParams.UpdateString("type","live")
loQueryParams.UpdateInt("page_size",30)
loQueryParams.UpdateString("next_page_token","quis officia in reprehenderit")
loQueryParams.UpdateString("page_number","quis officia in reprehenderit")
// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loResp = loHttp.QuickRequestParams("GET","https://api.zoom.us/v2/users/:userId/meetings",loQueryParams)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loQueryParams
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "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
return
endif
release loResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "page_count": 1,
// "page_number": 1,
// "page_size": 30,
// "total_records": 4,
// "meetings": [
// {
// "uuid": "mlghmfghlBBB",
// "id": 11111,
// "host_id": "abckjdfhsdkjf",
// "topic": "Zoom Meeting",
// "type": 2,
// "start_time": "2019-08-16T02:00:00Z",
// "duration": 30,
// "timezone": "America/Los_Angeles",
// "created_at": "2019-08-16T01:13:12Z",
// "join_url": "https://zoom.us/j/11111"
// },
// {
// "uuid": "J8H8eavweUcd321==",
// "id": 2222,
// "host_id": "abckjdfhsdkjf",
// "topic": "TestMeeting",
// "type": 2,
// "start_time": "2019-08-16T19:00:00Z",
// "duration": 60,
// "timezone": "America/Los_Angeles",
// "agenda": "RegistrationDeniedTest",
// "created_at": "2019-08-16T18:30:46Z",
// "join_url": "https://zoom.us/j/2222"
// },
// {
// "uuid": "SGVTAcfSfCbbbb",
// "id": 33333,
// "host_id": "abckjdfhsdkjf",
// "topic": "My Meeting",
// "type": 2,
// "start_time": "2019-08-16T22:00:00Z",
// "duration": 60,
// "timezone": "America/Los_Angeles",
// "created_at": "2019-08-16T21:15:56Z",
// "join_url": "https://zoom.us/j/33333"
// },
// {
// "uuid": "64123avdfsMVA==",
// "id": 44444,
// "host_id": "abckjdfhsdkjf",
// "topic": "MyTestPollMeeting",
// "type": 2,
// "start_time": "2019-08-29T18:00:00Z",
// "duration": 60,
// "timezone": "America/Los_Angeles",
// "created_at": "2019-08-29T17:32:33Z",
// "join_url": "https://zoom.us/j/4444"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lnPage_count = loJResp.IntOf("page_count")
lnPage_number = loJResp.IntOf("page_number")
lnPage_size = loJResp.IntOf("page_size")
lnTotal_records = loJResp.IntOf("total_records")
i = 0
lnCount_i = loJResp.SizeOfArray("meetings")
do while i < lnCount_i
loJResp.I = i
lcUuid = loJResp.StringOf("meetings[i].uuid")
lnId = loJResp.IntOf("meetings[i].id")
lcHost_id = loJResp.StringOf("meetings[i].host_id")
lcTopic = loJResp.StringOf("meetings[i].topic")
lnV_type = loJResp.IntOf("meetings[i].type")
lcStart_time = loJResp.StringOf("meetings[i].start_time")
lnDuration = loJResp.IntOf("meetings[i].duration")
lcTimezone = loJResp.StringOf("meetings[i].timezone")
lcCreated_at = loJResp.StringOf("meetings[i].created_at")
lcJoin_url = loJResp.StringOf("meetings[i].join_url")
lcAgenda = loJResp.StringOf("meetings[i].agenda")
i = i + 1
enddo
release loHttp
release loQueryParams
release loSbResponseBody
release loJResp
Curl Command
curl -G -d "type=live"
-d "page_size=30"
-d "next_page_token=quis%20officia%20in%20reprehenderit"
-d "page_number=quis%20officia%20in%20reprehenderit"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/users/:userId/meetings
Postman Collection Item JSON
{
"name": "List meetings",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/users/:userId/meetings?type=live&page_size=30&next_page_token=quis officia in reprehenderit&page_number=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId",
"meetings"
],
"query": [
{
"key": "type",
"value": "live",
"description": "The meeting types: <br>`scheduled` - This includes all valid past meetings (unexpired), live meetings and upcoming scheduled meetings. It is equivalent to the combined list of \"Previous Meetings\" and \"Upcoming Meetings\" displayed in the user's [Meetings page](https://zoom.us/meeting) on the Zoom Web Portal.<br>`live` - All the ongoing meetings.<br>`upcoming` - All upcoming meetings including live meetings."
},
{
"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": "page_number",
"value": "quis officia in reprehenderit",
"description": "The page number of the current page in the returned records."
}
],
"variable": [
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) The user ID or email address of the user. For user-level apps, pass the `me` value for this parameter."
}
]
},
"description": "List all the meetings that were scheduled for a user (meeting host). For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\nThis API **only** supports scheduled meetings. This API does not return information about instant meetings.\n\n**Scopes:** `meeting:read:admin`, `meeting:read`</br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
},
"response": [
{
"name": "**HTTP Status Code:** `200`<br>\nList of meeting objects returned.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/users/:userId/meetings?type=live&page_size=30&next_page_token=quis officia in reprehenderit&page_number=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId",
"meetings"
],
"query": [
{
"key": "type",
"value": "live"
},
{
"key": "page_size",
"value": "30"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
},
{
"key": "page_number",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) The user ID or email address of the user. For user-level apps, pass the `me` value for this parameter."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"page_count\": 1,\n \"page_number\": 1,\n \"page_size\": 30,\n \"total_records\": 4,\n \"meetings\": [\n {\n \"uuid\": \"mlghmfghlBBB\",\n \"id\": 11111,\n \"host_id\": \"abckjdfhsdkjf\",\n \"topic\": \"Zoom Meeting\",\n \"type\": 2,\n \"start_time\": \"2019-08-16T02:00:00Z\",\n \"duration\": 30,\n \"timezone\": \"America/Los_Angeles\",\n \"created_at\": \"2019-08-16T01:13:12Z\",\n \"join_url\": \"https://zoom.us/j/11111\"\n },\n {\n \"uuid\": \"J8H8eavweUcd321==\",\n \"id\": 2222,\n \"host_id\": \"abckjdfhsdkjf\",\n \"topic\": \"TestMeeting\",\n \"type\": 2,\n \"start_time\": \"2019-08-16T19:00:00Z\",\n \"duration\": 60,\n \"timezone\": \"America/Los_Angeles\",\n \"agenda\": \"RegistrationDeniedTest\",\n \"created_at\": \"2019-08-16T18:30:46Z\",\n \"join_url\": \"https://zoom.us/j/2222\"\n },\n {\n \"uuid\": \"SGVTAcfSfCbbbb\",\n \"id\": 33333,\n \"host_id\": \"abckjdfhsdkjf\",\n \"topic\": \"My Meeting\",\n \"type\": 2,\n \"start_time\": \"2019-08-16T22:00:00Z\",\n \"duration\": 60,\n \"timezone\": \"America/Los_Angeles\",\n \"created_at\": \"2019-08-16T21:15:56Z\",\n \"join_url\": \"https://zoom.us/j/33333\"\n },\n {\n \"uuid\": \"64123avdfsMVA==\",\n \"id\": 44444,\n \"host_id\": \"abckjdfhsdkjf\",\n \"topic\": \"MyTestPollMeeting\",\n \"type\": 2,\n \"start_time\": \"2019-08-29T18:00:00Z\",\n \"duration\": 60,\n \"timezone\": \"America/Los_Angeles\",\n \"created_at\": \"2019-08-29T17:32:33Z\",\n \"join_url\": \"https://zoom.us/j/4444\"\n }\n ]\n}"
},
{
"name": "**HTTP Status Code:** `404`<br>\nUser ID not found.<br>\n**Error Code:** `1001`<br>\nUser {userId} not exist or not belong to this account.<br>",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/users/:userId/meetings?type=live&page_size=30&next_page_token=quis officia in reprehenderit&page_number=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId",
"meetings"
],
"query": [
{
"key": "type",
"value": "live"
},
{
"key": "page_size",
"value": "30"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
},
{
"key": "page_number",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) The user ID or email address of the user. For user-level apps, pass the `me` value for this parameter."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
