Python / Zoom API / Get user's contact details
Back to Collection Items
import sys
import chilkat2
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = chilkat2.Http()
queryParams = chilkat2.JsonObject()
queryParams.UpdateString("query_presence_status","true")
# Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://api.zoom.us/v2/chat/users/me/contacts/:contactId",queryParams)
if (http.LastMethodSuccess == False):
print(http.LastErrorText)
sys.exit()
sbResponseBody = chilkat2.StringBuilder()
resp.GetBodySb(sbResponseBody)
jResp = chilkat2.JsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
print("Response Body:")
print(jResp.Emit())
respStatusCode = resp.StatusCode
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
print("Response Header:")
print(resp.Header)
print("Failed.")
sys.exit()
# 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
id = jResp.StringOf("id")
email = jResp.StringOf("email")
first_name = jResp.StringOf("first_name")
last_name = jResp.StringOf("last_name")
presence_status = jResp.StringOf("presence_status")
phone_number = jResp.StringOf("phone_number")
extension_number = jResp.StringOf("extension_number")
i = 0
count_i = jResp.SizeOfArray("phone_numbers")
while i < count_i :
jResp.I = i
country = jResp.StringOf("phone_numbers[i].country")
code = jResp.StringOf("phone_numbers[i].code")
v_number = jResp.StringOf("phone_numbers[i].number")
verified = jResp.BoolOf("phone_numbers[i].verified")
label = jResp.StringOf("phone_numbers[i].label")
i = i + 1
i = 0
count_i = jResp.SizeOfArray("direct_numbers")
while i < count_i :
jResp.I = i
intVal = jResp.IntOf("direct_numbers[i]")
i = i + 1
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": ""
}
]
}
