Swift / Zoom API / List webinar participants
Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()
var success: Bool
let queryParams = CkoJsonObject()
queryParams.UpdateInt("page_size", value: 30)
queryParams.UpdateString("next_page_token", value: "quis officia in reprehenderit")
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
var resp: CkoHttpResponse? = http.QuickRequestParams("GET", url: "https://api.zoom.us/v2/past_webinars/:webinarId/participants", json: queryParams)
if http.LastMethodSuccess == false {
print("\(http.LastErrorText)")
return
}
let sbResponseBody = CkoStringBuilder()
resp!.GetBodySb(sbResponseBody)
let jResp = CkoJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = false
print("Response Body:")
print("\(jResp.Emit())")
var respStatusCode: Int = resp!.StatusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(resp!.Header)")
print("Failed.")
resp = nil
return
}
resp = nil
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "page_count": 1,
// "page_size": 1,
// "total_records": 1,
// "next_page_token": "mdnf23qbsf4wr",
// "participants": [
// {
// "id": "sdjhf3ui",
// "name": "Matt",
// "user_email": "example@example.com"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
var id: String?
var name: String?
var user_email: String?
var page_count: Int = jResp.IntOf("page_count").intValue
var page_size: Int = jResp.IntOf("page_size").intValue
var total_records: Int = jResp.IntOf("total_records").intValue
var next_page_token: String? = jResp.StringOf("next_page_token")
var i: Int = 0
var count_i: Int = jResp.SizeOfArray("participants").intValue
while i < count_i {
jResp.I = i
id = jResp.StringOf("participants[i].id")
name = jResp.StringOf("participants[i].name")
user_email = jResp.StringOf("participants[i].user_email")
i = i + 1
}
}
Curl Command
curl -G -d "page_size=30"
-d "next_page_token=quis%20officia%20in%20reprehenderit"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/past_webinars/:webinarId/participants
Postman Collection Item JSON
{
"name": "List webinar participants",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/past_webinars/:webinarId/participants?page_size=30&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"past_webinars",
":webinarId",
"participants"
],
"query": [
{
"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."
}
],
"variable": [
{
"key": "webinarId",
"value": "quis officia in reprehenderit",
"description": "(Required) The webinar's ID. To get this value, use the [**List webinars**](https://marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinars) API."
}
]
},
"description": "Use this API to list all the participants who attended a webinar hosted in the past. \n\n**Scopes:** `webinar:read:admin`, `webinar:read` <br> **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` \n\n**Prerequisites:** \n* A Pro or higher plan with a Webinar add-on."
},
"response": [
{
"name": "**HTTP Status Code:** `200` **OK**<br>\nParticipants list returned.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/past_webinars/:webinarId/participants?page_size=30&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"past_webinars",
":webinarId",
"participants"
],
"query": [
{
"key": "page_size",
"value": "30"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "webinarId",
"value": "quis officia in reprehenderit",
"description": "(Required) The webinar's ID. To get this value, use the [**List webinars**](https://marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinars) API."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"page_count\": 1,\n \"page_size\": 1,\n \"total_records\": 1,\n \"next_page_token\": \"mdnf23qbsf4wr\",\n \"participants\": [\n {\n \"id\": \"sdjhf3ui\",\n \"name\": \"Matt\",\n \"user_email\": \"example@example.com\"\n }\n ]\n}"
},
{
"name": "**HTTP Status Code:** `400` **Bad request**<br>\n\n**Error Code:** `200`<br>\nNo permission.<br>\nOnly available for paid account: {accountId}.<br><br>\n**Error Code:** `300`<br>\nThe next page token is invalid or expired.\n",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/past_webinars/:webinarId/participants?page_size=30&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"past_webinars",
":webinarId",
"participants"
],
"query": [
{
"key": "page_size",
"value": "30"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "webinarId",
"value": "quis officia in reprehenderit",
"description": "(Required) The webinar's ID. To get this value, use the [**List webinars**](https://marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinars) API."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `404`\n**Error Code:**`3001`<br>\nWebinar does not exist.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/past_webinars/:webinarId/participants?page_size=30&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"past_webinars",
":webinarId",
"participants"
],
"query": [
{
"key": "page_size",
"value": "30"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "webinarId",
"value": "quis officia in reprehenderit",
"description": "(Required) The webinar's ID. To get this value, use the [**List webinars**](https://marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinars) API."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
