unicodeC / Zoom API / List SIP phones
Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW queryParams;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *id;
const wchar_t *user_email;
const wchar_t *domain;
const wchar_t *register_server;
const wchar_t *transport_protocol;
const wchar_t *proxy_server;
const wchar_t *register_server2;
const wchar_t *transport_protocol2;
const wchar_t *proxy_server2;
const wchar_t *register_server3;
const wchar_t *transport_protocol3;
const wchar_t *proxy_server3;
int registration_expire_time;
const wchar_t *user_name;
const wchar_t *password;
const wchar_t *authorization_name;
const wchar_t *voice_mail;
int page_count;
int page_number;
int page_size;
int total_records;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
queryParams = CkJsonObjectW_Create();
CkJsonObjectW_UpdateInt(queryParams,L"page_number",1);
CkJsonObjectW_UpdateString(queryParams,L"search_key",L"quis officia in reprehenderit");
CkJsonObjectW_UpdateInt(queryParams,L"page_size",68423085);
CkJsonObjectW_UpdateString(queryParams,L"next_page_token",L"quis officia in reprehenderit");
// Adds the "Authorization: Bearer <access_token>" header.
CkHttpW_putAuthToken(http,L"<access_token>");
resp = CkHttpW_QuickRequestParams(http,L"GET",L"https://api.zoom.us/v2/sip_phones",queryParams);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "page_count": 1,
// "page_number": 1,
// "page_size": 1,
// "total_records": 1,
// "phones": [
// {
// "id": "123456",
// "user_email": "example@example.com",
// "domain": "example.com",
// "register_server": "192.0.2.1",
// "transport_protocol": "UDP",
// "proxy_server": "192.0.2.2",
// "register_server2": "192.0.2.3",
// "transport_protocol2": "UDP",
// "proxy_server2": "192.0.2.4",
// "register_server3": "192.0.2.5",
// "transport_protocol3": "UDP",
// "proxy_server3": "192.0.2.6",
// "registration_expire_time": 60,
// "user_name": "1008",
// "password": "apassword1",
// "authorization_name": "testname",
// "voice_mail": "4000"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
page_count = CkJsonObjectW_IntOf(jResp,L"page_count");
page_number = CkJsonObjectW_IntOf(jResp,L"page_number");
page_size = CkJsonObjectW_IntOf(jResp,L"page_size");
total_records = CkJsonObjectW_IntOf(jResp,L"total_records");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"phones");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
id = CkJsonObjectW_stringOf(jResp,L"phones[i].id");
user_email = CkJsonObjectW_stringOf(jResp,L"phones[i].user_email");
domain = CkJsonObjectW_stringOf(jResp,L"phones[i].domain");
register_server = CkJsonObjectW_stringOf(jResp,L"phones[i].register_server");
transport_protocol = CkJsonObjectW_stringOf(jResp,L"phones[i].transport_protocol");
proxy_server = CkJsonObjectW_stringOf(jResp,L"phones[i].proxy_server");
register_server2 = CkJsonObjectW_stringOf(jResp,L"phones[i].register_server2");
transport_protocol2 = CkJsonObjectW_stringOf(jResp,L"phones[i].transport_protocol2");
proxy_server2 = CkJsonObjectW_stringOf(jResp,L"phones[i].proxy_server2");
register_server3 = CkJsonObjectW_stringOf(jResp,L"phones[i].register_server3");
transport_protocol3 = CkJsonObjectW_stringOf(jResp,L"phones[i].transport_protocol3");
proxy_server3 = CkJsonObjectW_stringOf(jResp,L"phones[i].proxy_server3");
registration_expire_time = CkJsonObjectW_IntOf(jResp,L"phones[i].registration_expire_time");
user_name = CkJsonObjectW_stringOf(jResp,L"phones[i].user_name");
password = CkJsonObjectW_stringOf(jResp,L"phones[i].password");
authorization_name = CkJsonObjectW_stringOf(jResp,L"phones[i].authorization_name");
voice_mail = CkJsonObjectW_stringOf(jResp,L"phones[i].voice_mail");
i = i + 1;
}
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -G -d "page_number=1"
-d "search_key=quis%20officia%20in%20reprehenderit"
-d "page_size=68423085"
-d "next_page_token=quis%20officia%20in%20reprehenderit"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/sip_phones
Postman Collection Item JSON
{
"name": "List SIP phones",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/sip_phones?page_number=1&search_key=quis officia in reprehenderit&page_size=68423085&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"sip_phones"
],
"query": [
{
"key": "page_number",
"value": "1",
"description": "**Deprecated.** We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination."
},
{
"key": "search_key",
"value": "quis officia in reprehenderit",
"description": "User name or email address of a user. If this parameter is provided, only the SIP phone system integration enabled for that specific user will be returned. Otherwise, all SIP phones on an account will be returned."
},
{
"key": "page_size",
"value": "68423085",
"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."
}
]
},
"description": "Zoom’s Phone System Integration (PSI), also referred as SIP phones, enables an organization to leverage the Zoom client to complete a softphone registration to supported premise based PBX system. End users will have the ability to have softphone functionality within a single client while maintaining a comparable interface to Zoom Phone. Use this API to list SIP phones on an account.<br><br>\n**Prerequisites**:\n* Currently only supported on Cisco and Avaya PBX systems. \n* User must enable SIP Phone Integration by contacting the [Sales](https://zoom.us/contactsales) team.<br> **Scope:** `sip_phone:read:admin`<br> \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`<br>\n"
},
"response": [
{
"name": "**HTTP Status Code:** `200`<br>\nSIP Phones listed successfully.\n\n**Error Code:** `200`<br>\nPermission missing: Enable SIP Phone Integration by contacting a Zoom Admin first.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/sip_phones?page_number=1&search_key=quis officia in reprehenderit&page_size=68423085&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"sip_phones"
],
"query": [
{
"key": "page_number",
"value": "1"
},
{
"key": "search_key",
"value": "quis officia in reprehenderit"
},
{
"key": "page_size",
"value": "68423085"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
}
]
}
},
"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\": 1,\n \"total_records\": 1,\n \"phones\": [\n {\n \"id\": \"123456\",\n \"user_email\": \"example@example.com\",\n \"domain\": \"example.com\",\n \"register_server\": \"192.0.2.1\",\n \"transport_protocol\": \"UDP\",\n \"proxy_server\": \"192.0.2.2\",\n \"register_server2\": \"192.0.2.3\",\n \"transport_protocol2\": \"UDP\",\n \"proxy_server2\": \"192.0.2.4\",\n \"register_server3\": \"192.0.2.5\",\n \"transport_protocol3\": \"UDP\",\n \"proxy_server3\": \"192.0.2.6\",\n \"registration_expire_time\": 60,\n \"user_name\": \"1008\",\n \"password\": \"apassword1\",\n \"authorization_name\": \"testname\",\n \"voice_mail\": \"4000\"\n }\n ]\n}"
},
{
"name": "**HTTP Status Code:** `400`<br> Bad Request\n\n",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/sip_phones?page_number=1&search_key=quis officia in reprehenderit&page_size=68423085&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"sip_phones"
],
"query": [
{
"key": "page_number",
"value": "1"
},
{
"key": "search_key",
"value": "quis officia in reprehenderit"
},
{
"key": "page_size",
"value": "68423085"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
