Search company contacts

GET

/contacts

Contacts

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.

Scopes: contact:read:admin, contact:read

Rate Limit Label: Medium

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://api.zoom.us/v2/contacts?search_key'

响应示例

{
    "contacts": [
        {
            "direct_numbers": [
                111111,
                222222
            ],
            "email": "qui@djfsd.sdfjhdf",
            "extension_number": "010",
            "first_name": "John",
            "id": "isds324bdfsf",
            "im_group_id": "fhksdhfew34hjds",
            "im_group_name": "Engineering",
            "last_name": "Doe",
            "phone_number": "00000000",
            "presence_status": "Offline",
            "sip_phone_number": "11111111"
        }
    ],
    "next_page_token": " ",
    "page_size": 1
}

请求参数

Query 参数

search_key

string

必需

Provide the keyword - either first name, last name or email of the contact whom you have to search for.

query_presence_status

string

可选

Set query_presence_status to true in order to include the presence status of a contact in the response.

page_size

integer

可选

The number of records to be returned with a single API call.

<= 25

默认值:

next_page_token

string

可选

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.

返回响应

🟢200**HTTP Status Code:** `200`<br> Contact returned successfully.

application/json

Body

contacts

array [object {14}]

可选

dept

string

可选

Department of the contact as provided in the user's Zoom profile.

direct_numbers

array[string]

可选

Direct Number(s) of a user who has Zoom Phone license assigned.

string

可选

Email address of the contact.

extension_number

string

可选

Extension Number of a user who has Zoom Phone license assigned.

first_name

string

可选

First name of the contact.

string

可选

User ID of the contact.

im_group_id

string

可选

Unique Identifier of the IM directory group in which the user has been added. An IM Directory group is not the same as a channel. IM Directory allows administrators to assign users in their account to groups that display within the Contacts list on Zoom clients.

im_group_name

string

可选

Name of the IM directory group in which the user has been added. An IM Directory group is not the same as a channel. IM Directory allows administrators to assign users in their account to groups that display within the Contacts list on Zoom clients.

job_title

string

可选

Department of the user as provided in the user's Zoom profile.

last_name

string

可选

Last name of the contact.

location

string

可选

Location of the user as provided in the user's Zoom profile.

phone_number

string

可选

Phone number of the user.

presence_status

enum<string>

可选

Presence status of the contact in Zoom Client. The value of this field can be one of the following:
Do_Not_Disturb
away
Available
Offline

枚举值:

Do_Not_DisturbAwayAvailableOffline

sip_phone_number

string

可选

SIP Phone number of the user. Returned only if user has SIP phone enabled.

next_page_token

string

可选

page_size

integer

可选

The number of records returned with a single API call. Default value is 1.

<= 25

Get user's contact details

Delete a channel