Chilkat Online Tools

Foxpro / Zoom API / Get user's contact details

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcCountry
LOCAL lcCode
LOCAL lcV_number
LOCAL lnVerified
LOCAL lcLabel
LOCAL lnIntVal
LOCAL lcId
LOCAL lcEmail
LOCAL lcFirst_name
LOCAL lcLast_name
LOCAL lcPresence_status
LOCAL lcPhone_number
LOCAL lcExtension_number
LOCAL i
LOCAL lnCount_i

* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams = CreateObject('Chilkat.JsonObject')
loQueryParams.UpdateString("query_presence_status","true")

* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"

loResp = loHttp.QuickRequestParams("GET","https://api.zoom.us/v2/chat/users/me/contacts/:contactId",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loQueryParams
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loQueryParams
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)

* {
*   "id": "u487547sic45ing",
*   "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"
*     }
*   ],
*   "direct_numbers": [
*     111111,
*     222222
*   ],
*   "extension_number": "010"
* }

* Sample code for parsing the JSON response...
* Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

lcId = loJResp.StringOf("id")
lcEmail = loJResp.StringOf("email")
lcFirst_name = loJResp.StringOf("first_name")
lcLast_name = loJResp.StringOf("last_name")
lcPresence_status = loJResp.StringOf("presence_status")
lcPhone_number = loJResp.StringOf("phone_number")
lcExtension_number = loJResp.StringOf("extension_number")
i = 0
lnCount_i = loJResp.SizeOfArray("phone_numbers")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcCountry = loJResp.StringOf("phone_numbers[i].country")
    lcCode = loJResp.StringOf("phone_numbers[i].code")
    lcV_number = loJResp.StringOf("phone_numbers[i].number")
    lnVerified = loJResp.BoolOf("phone_numbers[i].verified")
    lcLabel = loJResp.StringOf("phone_numbers[i].label")
    i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("direct_numbers")
DO WHILE i < lnCount_i
    loJResp.I = i
    lnIntVal = loJResp.IntOf("direct_numbers[i]")
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp

Curl Command

curl -G -d "query_presence_status=true"
	-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/chat/users/me/contacts/:contactId

Postman Collection Item JSON

{
  "name": "Get user's contact details",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/chat/users/me/contacts/:contactId?query_presence_status=true",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "chat",
        "users",
        "me",
        "contacts",
        ":contactId"
      ],
      "query": [
        {
          "key": "query_presence_status",
          "value": "true",
          "description": "The presence status of the contact. \nInclude this query parameter with a value of `true` to get the presence status of the contact in the response."
        }
      ],
      "variable": [
        {
          "key": "contactId",
          "value": "quis officia in reprehenderit",
          "description": "(Required) The user's contact Id or email address. The contact can be either a company contact or an external contact."
        }
      ]
    },
    "description": "A user under an organization’s Zoom account has internal users listed under Company Contacts in the Zoom Client. A Zoom user can also add another Zoom user as a [contact](https://support.zoom.us/hc/en-us/articles/115004055706-Managing-Contacts). Call this API to get information on a specific contact of the Zoom user.\n\n<p style=\"background-color:#e1f5fe; color:#01579b; padding:8px\"> <b>Note: </b>This API only supports <b>user-managed</b> <a href=\"https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app\">OAuth app</a>.</p><br>\n\n**Scope**: `chat_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 information returned.\n\n\n",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/chat/users/me/contacts/:contactId?query_presence_status=true",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "chat",
            "users",
            "me",
            "contacts",
            ":contactId"
          ],
          "query": [
            {
              "key": "query_presence_status",
              "value": "true"
            }
          ],
          "variable": [
            {
              "key": "contactId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The user's contact Id or email address. The contact can be either a company contact or an external contact."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"id\": \"u487547sic45ing\",\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 \"direct_numbers\": [\n  111111,\n  222222\n ],\n \"extension_number\": \"010\"\n}"
    },
    {
      "name": "**HTTP Status Code:** `400`<br>\nBad request<br>\n**Error Code:** `5301`<br>\nRequest to get the presence status of the chat contact failed.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/chat/users/me/contacts/:contactId?query_presence_status=true",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "chat",
            "users",
            "me",
            "contacts",
            ":contactId"
          ],
          "query": [
            {
              "key": "query_presence_status",
              "value": "true"
            }
          ],
          "variable": [
            {
              "key": "contactId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The user's contact Id or email address. The contact can be either a company contact or an external contact."
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "**HTTP Status Code:** `404`<br>\n**Error Code**: `1001`<br>\nUser does not exist: $contactId",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/chat/users/me/contacts/:contactId?query_presence_status=true",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "chat",
            "users",
            "me",
            "contacts",
            ":contactId"
          ],
          "query": [
            {
              "key": "query_presence_status",
              "value": "true"
            }
          ],
          "variable": [
            {
              "key": "contactId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The user's contact Id or email address. The contact can be either a company contact or an external contact."
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}