autoit / Zoom API / Get user's contact details
Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateString("query_presence_status","true")
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
Local $oResp = $oHttp.QuickRequestParams("GET","https://api.zoom.us/v2/chat/users/me/contacts/:contactId",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sCountry
Local $sCode
Local $sV_number
Local $bVerified
Local $sLabel
Local $intVal
Local $sId = $oJResp.StringOf("id")
Local $sEmail = $oJResp.StringOf("email")
Local $sFirst_name = $oJResp.StringOf("first_name")
Local $sLast_name = $oJResp.StringOf("last_name")
Local $sPresence_status = $oJResp.StringOf("presence_status")
Local $sPhone_number = $oJResp.StringOf("phone_number")
Local $sExtension_number = $oJResp.StringOf("extension_number")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("phone_numbers")
While $i < $iCount_i
$oJResp.I = $i
$sCountry = $oJResp.StringOf("phone_numbers[i].country")
$sCode = $oJResp.StringOf("phone_numbers[i].code")
$sV_number = $oJResp.StringOf("phone_numbers[i].number")
$bVerified = $oJResp.BoolOf("phone_numbers[i].verified")
$sLabel = $oJResp.StringOf("phone_numbers[i].label")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("direct_numbers")
While $i < $iCount_i
$oJResp.I = $i
$intVal = $oJResp.IntOf("direct_numbers[i]")
$i = $i + 1
Wend
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": ""
}
]
}
