Swift / Zoom API / List user's TSP accounts
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
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
let sbResponseBody = CkoStringBuilder()
success = http.QuickGetSb("https://api.zoom.us/v2/users/:userId/tsp", sbContent: sbResponseBody)
if success == false {
print("\(http.LastErrorText)")
return
}
let jResp = CkoJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = false
print("Response Body:")
print("\(jResp.Emit())")
var respStatusCode: Int = http.LastStatus.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(http.LastHeader)")
print("Failed.")
return
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "tsp_accounts": [
// {
// "id": 111222222,
// "conference_code": "0125",
// "leader_pin": "11189898",
// "tsp_bridge": "string",
// "dial_in_numbers": [
// {
// "code": "01",
// "number": "000000000",
// "type": "toll"
// }
// ]
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
var id: Int
var conference_code: String?
var leader_pin: String?
var tsp_bridge: String?
var j: Int
var count_j: Int
var code: String?
var v_number: String?
var v_type: String?
var i: Int = 0
var count_i: Int = jResp.SizeOfArray("tsp_accounts").intValue
while i < count_i {
jResp.I = i
id = jResp.IntOf("tsp_accounts[i].id").intValue
conference_code = jResp.StringOf("tsp_accounts[i].conference_code")
leader_pin = jResp.StringOf("tsp_accounts[i].leader_pin")
tsp_bridge = jResp.StringOf("tsp_accounts[i].tsp_bridge")
j = 0
count_j = jResp.SizeOfArray("tsp_accounts[i].dial_in_numbers").intValue
while j < count_j {
jResp.J = j
code = jResp.StringOf("tsp_accounts[i].dial_in_numbers[j].code")
v_number = jResp.StringOf("tsp_accounts[i].dial_in_numbers[j].number")
v_type = jResp.StringOf("tsp_accounts[i].dial_in_numbers[j].type")
j = j + 1
}
i = i + 1
}
}
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/users/:userId/tsp
Postman Collection Item JSON
{
"name": "List user's TSP accounts",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/users/:userId/tsp",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId",
"tsp"
],
"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": "A user can have a maximum of two TSP accounts. Use this API to list all TSP accounts of a user.<br><br>\n**Scopes:** `tsp:read:admin` `tsp:read`<br>\n \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
},
"response": [
{
"name": "**HTTP Status Code:** `200` **OK**<br>\nTSP account list returned successfully.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/users/:userId/tsp",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId",
"tsp"
],
"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 \"tsp_accounts\": [\n {\n \"id\": 111222222,\n \"conference_code\": \"0125\",\n \"leader_pin\": \"11189898\",\n \"tsp_bridge\": \"string\",\n \"dial_in_numbers\": [\n {\n \"code\": \"01\",\n \"number\": \"000000000\",\n \"type\": \"toll\"\n }\n ]\n }\n ]\n}"
},
{
"name": "**HTTP Status Code:** `400`<br>\nBad request.<br>\n**Error Code:** `2024`<br>\nAccount has not enabled TSP.\n",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/users/:userId/tsp",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId",
"tsp"
],
"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": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `404`<br>\nNot Found.<br>\n**Error Code:** `1001`<br>\nUser does not exist: $userId.<br>\n**Error Code:**`1120`<br>\nA valid invitation to join the Zoom account was not found for this user.<br>\nThis error is thrown if you added a user in ",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/users/:userId/tsp",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId",
"tsp"
],
"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": ""
}
]
}
