List user's contacts

GET

/chat/users/me/contacts

Contacts

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. Call this API to list all the contacts of a Zoom user. Zoom contacts are categorized into "company contacts" and "external contacts". You must specify the contact type in the type query parameter. If you do not specify, by default, the type will be set as company contact.

Note: This API only supports user-managed OAuth app.

Scope: chat_contact:read

Rate Limit Label: Medium

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://api.zoom.us/v2/chat/users/me/contacts'

响应示例

200 - response

{
  "contacts": [
    {
      "email": "someemail@somemail.com",
      "first_name": "Brandon",
      "id": "44ABCDEfgjWHABBxw",
      "last_name": "Ghimire"
    }
  ],
  "next_page_token": "shdjksA4",
  "page_size": 10
}

请求参数

Query 参数

type

string

可选

The type of contact. The value can be one of the following:
company: Contacts from the user's organization.
external: External contacts.

默认值:

company

page_size

integer

可选

The number of records returned with a single API call.

<= 50

默认值:

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>List of user's contacts returned.

application/json

Body

contacts

array [object {4}]

可选

The contacts object.

string <email>

可选

Contact's email address.

first_name

string

可选

Contact's first name.

string

可选

Contact Id.

last_name

string

可选

Contact's last name.

next_page_token

string

可选

page_size

integer

可选

The number of records returned with a single API call.
Default value: 30.

<= 100

🔵300**Error Code:** `300`<br> The next page token is invalid or has expired.

Create a channel

Get user's contact details