Delphi (DLL) / Zoom API / Search company contacts
Back to Collection Items
var
begin
CkJsonObject_UpdateString(queryParams,'search_key','quis officia in reprehenderit');CkJsonObject_UpdateString(queryParams,'query_presence_status','quis officia in reprehenderit');CkJsonObject_UpdateInt(queryParams,'page_size',1);CkJsonObject_UpdateInt(queryParams,'contact_types',1);CkJsonObject_UpdateString(queryParams,'next_page_token','quis officia in reprehenderit');CkHttp_putAuthToken(http,'<access_token>');CkHttpResponse_GetBodySb(resp,sbResponseBody);CkJsonObject_LoadSb(jResp,sbResponseBody);CkJsonObject_putEmitCompact(jResp,False);CkJsonObject_putI(jResp,i);id := CkJsonObject__stringOf(jResp,'contacts[i].id');email := CkJsonObject__stringOf(jResp,'contacts[i].email');first_name := CkJsonObject__stringOf(jResp,'contacts[i].first_name');last_name := CkJsonObject__stringOf(jResp,'contacts[i].last_name');presence_status := CkJsonObject__stringOf(jResp,'contacts[i].presence_status');phone_number := CkJsonObject__stringOf(jResp,'contacts[i].phone_number');sip_phone_number := CkJsonObject__stringOf(jResp,'contacts[i].sip_phone_number');extension_number := CkJsonObject__stringOf(jResp,'contacts[i].extension_number');im_group_id := CkJsonObject__stringOf(jResp,'contacts[i].im_group_id');im_group_name := CkJsonObject__stringOf(jResp,'contacts[i].im_group_name');dept := CkJsonObject__stringOf(jResp,'contacts[i].dept');job_title := CkJsonObject__stringOf(jResp,'contacts[i].job_title');location := CkJsonObject__stringOf(jResp,'contacts[i].location');sip_uri := CkJsonObject__stringOf(jResp,'contacts[i].sip_uri');contact_type := CkJsonObject_IntOf(jResp,'contacts[i].contact_type');j := 0;count_j := CkJsonObject_SizeOfArray(jResp,'contacts[i].phone_numbers');CkJsonObject_putJ(jResp,j);country := CkJsonObject__stringOf(jResp,'contacts[i].phone_numbers[j].country');code := CkJsonObject__stringOf(jResp,'contacts[i].phone_numbers[j].code');v_number := CkJsonObject__stringOf(jResp,'contacts[i].phone_numbers[j].number');verified := CkJsonObject_BoolOf(jResp,'contacts[i].phone_numbers[j].verified');label := CkJsonObject__stringOf(jResp,'contacts[i].phone_numbers[j].label');j := j + 1;j := 0;count_j := CkJsonObject_SizeOfArray(jResp,'contacts[i].direct_numbers');CkJsonObject_putJ(jResp,j);intVal := CkJsonObject_IntOf(jResp,'contacts[i].direct_numbers[j]');j := j + 1;i := i + 1;
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}"
}
]
}
