PureBasic / Zoom API / List a user's PAC accounts
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://api.zoom.us/v2/users/:userId/pac",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "pac_accounts": [
; {
; "dedicated_dial_in_number": [
; {
; "number": "123343434",
; "country": "USA"
; }
; ],
; "global_dial_in_numbers": [
; {
; "number": "434343434",
; "country": "USA"
; }
; ],
; "conference_id": "111111",
; "participant_password": "ghdf",
; "listen_only_password": "hkgk"
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
conference_id.s
participant_password.s
listen_only_password.s
j.i
count_j.i
v_number.s
country.s
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"pac_accounts")
While i < count_i
CkJsonObject::setCkI(jResp, i)
conference_id = CkJsonObject::ckStringOf(jResp,"pac_accounts[i].conference_id")
participant_password = CkJsonObject::ckStringOf(jResp,"pac_accounts[i].participant_password")
listen_only_password = CkJsonObject::ckStringOf(jResp,"pac_accounts[i].listen_only_password")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"pac_accounts[i].dedicated_dial_in_number")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
v_number = CkJsonObject::ckStringOf(jResp,"pac_accounts[i].dedicated_dial_in_number[j].number")
country = CkJsonObject::ckStringOf(jResp,"pac_accounts[i].dedicated_dial_in_number[j].country")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"pac_accounts[i].global_dial_in_numbers")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
v_number = CkJsonObject::ckStringOf(jResp,"pac_accounts[i].global_dial_in_numbers[j].number")
country = CkJsonObject::ckStringOf(jResp,"pac_accounts[i].global_dial_in_numbers[j].country")
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/users/:userId/pac
Postman Collection Item JSON
{
"name": "List a user's PAC accounts",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/users/:userId/pac",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId",
"pac"
],
"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": "Use this API to list a user's [Personal Audio Conference](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) accounts. 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\nPAC allows Pro or higher account holders to host meetings through PSTN (phone dial-in) only.\n\n**Scopes:** `pac:read:admin`, `pac:read`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\n\n**Prerequisites:** \n* A Pro or higher plan with [Premium Audio Conferencing](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) add-on.\n* Personal Audio Conference must be enabled in the user's profile."
},
"response": [
{
"name": "**HTTP Status Code:** `200` **OK**<br>\nPAC account list returned.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/users/:userId/pac",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId",
"pac"
],
"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 \"pac_accounts\": [\n {\n \"dedicated_dial_in_number\": [\n {\n \"number\": \"123343434\",\n \"country\": \"USA\"\n }\n ],\n \"global_dial_in_numbers\": [\n {\n \"number\": \"434343434\",\n \"country\": \"USA\"\n }\n ],\n \"conference_id\": \"111111\",\n \"participant_password\": \"ghdf\",\n \"listen_only_password\": \"hkgk\"\n }\n ]\n}"
},
{
"name": "**HTTP Status Code:** `400` **Bad Request**<br>\n**Error Code:** `2024`<br>\nUser does not have PAC enabled.\n",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/users/:userId/pac",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId",
"pac"
],
"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` **Not Found**<br>\n**Error Code:** `1001`<br>\nUser does not exist: $userId.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/users/:userId/pac",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId",
"pac"
],
"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": ""
}
]
}
