Chilkat Online Tools

Swift / Zoom API / Search company contacts

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

    let queryParams = CkoJsonObject()
    queryParams.UpdateString("search_key", value: "quis officia in reprehenderit")
    queryParams.UpdateString("query_presence_status", value: "quis officia in reprehenderit")
    queryParams.UpdateInt("page_size", value: 1)
    queryParams.UpdateInt("contact_types", value: 1)
    queryParams.UpdateString("next_page_token", value: "quis officia in reprehenderit")

    // Adds the "Authorization: Bearer <access_token>" header.
    http.AuthToken = "<access_token>"

    var resp: CkoHttpResponse? = http.QuickRequestParams("GET", url: "https://api.zoom.us/v2/contacts", json: queryParams)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    let sbResponseBody = CkoStringBuilder()
    resp!.GetBodySb(sbResponseBody)

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = resp!.StatusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.Header)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

    // 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

    var id: String?
    var email: String?
    var first_name: String?
    var last_name: String?
    var presence_status: String?
    var phone_number: String?
    var sip_phone_number: String?
    var extension_number: String?
    var im_group_id: String?
    var im_group_name: String?
    var dept: String?
    var job_title: String?
    var location: String?
    var sip_uri: String?
    var contact_type: Int
    var j: Int
    var count_j: Int
    var country: String?
    var code: String?
    var v_number: String?
    var verified: Bool
    var label: String?
    var intVal: Int

    var page_size: Int = jResp.IntOf("page_size").intValue
    var next_page_token: String? = jResp.StringOf("next_page_token")
    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("contacts").intValue
    while i < count_i {
        jResp.I = i
        id = jResp.StringOf("contacts[i].id")
        email = jResp.StringOf("contacts[i].email")
        first_name = jResp.StringOf("contacts[i].first_name")
        last_name = jResp.StringOf("contacts[i].last_name")
        presence_status = jResp.StringOf("contacts[i].presence_status")
        phone_number = jResp.StringOf("contacts[i].phone_number")
        sip_phone_number = jResp.StringOf("contacts[i].sip_phone_number")
        extension_number = jResp.StringOf("contacts[i].extension_number")
        im_group_id = jResp.StringOf("contacts[i].im_group_id")
        im_group_name = jResp.StringOf("contacts[i].im_group_name")
        dept = jResp.StringOf("contacts[i].dept")
        job_title = jResp.StringOf("contacts[i].job_title")
        location = jResp.StringOf("contacts[i].location")
        sip_uri = jResp.StringOf("contacts[i].sip_uri")
        contact_type = jResp.IntOf("contacts[i].contact_type").intValue
        j = 0
        count_j = jResp.SizeOfArray("contacts[i].phone_numbers").intValue
        while j < count_j {
            jResp.J = j
            country = jResp.StringOf("contacts[i].phone_numbers[j].country")
            code = jResp.StringOf("contacts[i].phone_numbers[j].code")
            v_number = jResp.StringOf("contacts[i].phone_numbers[j].number")
            verified = jResp.BoolOf("contacts[i].phone_numbers[j].verified")
            label = jResp.StringOf("contacts[i].phone_numbers[j].label")
            j = j + 1
        }

        j = 0
        count_j = jResp.SizeOfArray("contacts[i].direct_numbers").intValue
        while j < count_j {
            jResp.J = j
            intVal = jResp.IntOf("contacts[i].direct_numbers[j]").intValue
            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}"
    }
  ]
}