PureBasic / Zoom API / Search company contacts
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.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
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"search_key","quis officia in reprehenderit")
CkJsonObject::ckUpdateString(queryParams,"query_presence_status","quis officia in reprehenderit")
CkJsonObject::ckUpdateInt(queryParams,"page_size",1)
CkJsonObject::ckUpdateInt(queryParams,"contact_types",1)
CkJsonObject::ckUpdateString(queryParams,"next_page_token","quis officia in reprehenderit")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://api.zoom.us/v2/contacts",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
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 = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "page_size": 1,
; "next_page_token": " ",
; "contacts": [
; {
; "id": "isds324bdfsf",
; "email": "example@example.com",
; "first_name": "John",
; "last_name": "Doe",
; "presence_status": "Offline",
; "phone_number": "15550100",
; "phone_numbers": [
; {
; "country": "US",
; "code": "+1",
; "number": "15550102",
; "verified": true,
; "label": "Mobile"
; }
; ],
; "sip_phone_number": "11111111",
; "direct_numbers": [
; 111111,
; 222222
; ],
; "extension_number": "010",
; "im_group_id": "fhksdhfew34hjds",
; "im_group_name": "Engineering",
; "dept": "Engineering",
; "job_title": "Engineer",
; "location": "New York",
; "sip_uri": "800@aaa.example.com",
; "contact_type": 1
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
id.s
email.s
first_name.s
last_name.s
presence_status.s
phone_number.s
sip_phone_number.s
extension_number.s
im_group_id.s
im_group_name.s
dept.s
job_title.s
location.s
sip_uri.s
contact_type.i
j.i
count_j.i
country.s
code.s
v_number.s
verified.i
label.s
intVal.i
page_size.i = CkJsonObject::ckIntOf(jResp,"page_size")
next_page_token.s = CkJsonObject::ckStringOf(jResp,"next_page_token")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"contacts")
While i < count_i
CkJsonObject::setCkI(jResp, i)
id = CkJsonObject::ckStringOf(jResp,"contacts[i].id")
email = CkJsonObject::ckStringOf(jResp,"contacts[i].email")
first_name = CkJsonObject::ckStringOf(jResp,"contacts[i].first_name")
last_name = CkJsonObject::ckStringOf(jResp,"contacts[i].last_name")
presence_status = CkJsonObject::ckStringOf(jResp,"contacts[i].presence_status")
phone_number = CkJsonObject::ckStringOf(jResp,"contacts[i].phone_number")
sip_phone_number = CkJsonObject::ckStringOf(jResp,"contacts[i].sip_phone_number")
extension_number = CkJsonObject::ckStringOf(jResp,"contacts[i].extension_number")
im_group_id = CkJsonObject::ckStringOf(jResp,"contacts[i].im_group_id")
im_group_name = CkJsonObject::ckStringOf(jResp,"contacts[i].im_group_name")
dept = CkJsonObject::ckStringOf(jResp,"contacts[i].dept")
job_title = CkJsonObject::ckStringOf(jResp,"contacts[i].job_title")
location = CkJsonObject::ckStringOf(jResp,"contacts[i].location")
sip_uri = CkJsonObject::ckStringOf(jResp,"contacts[i].sip_uri")
contact_type = CkJsonObject::ckIntOf(jResp,"contacts[i].contact_type")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"contacts[i].phone_numbers")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
country = CkJsonObject::ckStringOf(jResp,"contacts[i].phone_numbers[j].country")
code = CkJsonObject::ckStringOf(jResp,"contacts[i].phone_numbers[j].code")
v_number = CkJsonObject::ckStringOf(jResp,"contacts[i].phone_numbers[j].number")
verified = CkJsonObject::ckBoolOf(jResp,"contacts[i].phone_numbers[j].verified")
label = CkJsonObject::ckStringOf(jResp,"contacts[i].phone_numbers[j].label")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"contacts[i].direct_numbers")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
intVal = CkJsonObject::ckIntOf(jResp,"contacts[i].direct_numbers[j]")
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -G -d "search_key=quis%20officia%20in%20reprehenderit"
-d "query_presence_status=quis%20officia%20in%20reprehenderit"
-d "page_size=1"
-d "contact_types=1"
-d "next_page_token=quis%20officia%20in%20reprehenderit"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/contacts
Postman Collection Item JSON
{
"name": "Search company contacts",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/contacts?search_key=quis officia in reprehenderit&query_presence_status=quis officia in reprehenderit&page_size=1&contact_types=1&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"contacts"
],
"query": [
{
"key": "search_key",
"value": "quis officia in reprehenderit",
"description": "(Required) Provide the keyword - either first name, last name or email of the contact whom you have to search for."
},
{
"key": "query_presence_status",
"value": "quis officia in reprehenderit",
"description": "Set `query_presence_status` to `true` in order to include the presence status of a contact in the response."
},
{
"key": "page_size",
"value": "1",
"description": "The number of records to be returned with a single API call."
},
{
"key": "contact_types",
"value": "1",
"description": "A comma-separated list of the type of user contact to query: \n* `1` — A Zoom user. \n* `2` — An auto receptionist. \n* `3` — A common area phone. \n* `4` — A call queue. \n * `5` — A shared line group. \n* `6` — A shared global directory. \n* `7` — A shared office contact. \n\n**Note:** \n* You must have a [phone management role with the \"**View**\" permission](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management) to query the `2`, `3`, `4`, `5`, and `7` values. \n* You must provide a valid `search_key` value to query this parameter."
},
{
"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": "A user under an organization's Zoom account has internal users listed under Company Contacts in the Zoom Client. Use this API to search users that are in the company contacts of a Zoom account. Using the `search_key` query parameter, provide either first name, last name or the email address of the user that you would like to search for. Optionally, set `query_presence_status` to `true` in order to include the presence status of a contact. <br><br>\n\n**Scopes:** `contact:read:admin`, `contact: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`<br>\nContact returned successfully.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/contacts?search_key=quis officia in reprehenderit&query_presence_status=quis officia in reprehenderit&page_size=1&contact_types=1&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"contacts"
],
"query": [
{
"key": "search_key",
"value": "quis officia in reprehenderit"
},
{
"key": "query_presence_status",
"value": "quis officia in reprehenderit"
},
{
"key": "page_size",
"value": "1"
},
{
"key": "contact_types",
"value": "1"
},
{
"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_size\": 1,\n \"next_page_token\": \" \",\n \"contacts\": [\n {\n \"id\": \"isds324bdfsf\",\n \"email\": \"example@example.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"presence_status\": \"Offline\",\n \"phone_number\": \"15550100\",\n \"phone_numbers\": [\n {\n \"country\": \"US\",\n \"code\": \"+1\",\n \"number\": \"15550102\",\n \"verified\": true,\n \"label\": \"Mobile\"\n }\n ],\n \"sip_phone_number\": \"11111111\",\n \"direct_numbers\": [\n 111111,\n 222222\n ],\n \"extension_number\": \"010\",\n \"im_group_id\": \"fhksdhfew34hjds\",\n \"im_group_name\": \"Engineering\",\n \"dept\": \"Engineering\",\n \"job_title\": \"Engineer\",\n \"location\": \"New York\",\n \"sip_uri\": \"800@aaa.example.com\",\n \"contact_type\": 1\n }\n ]\n}"
}
]
}
