Struct zoom_api::contacts::Contacts

pub struct Contacts { /* fields omitted */ }

Implementations

impl Contacts

pub async fn search_company(
    &self,
    search_key: &str,
    query_presence_status: &str,
    page_size: i64,
    next_page_token: &str
) -> Result<Vec<Contacts>>

Search company contacts.

This function performs a GET to the /contacts endpoint.

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

Parameters:

• search_key: &str – Provide the keyword - either first name, last name or email of the contact whom you have to search for.
• query_presence_status: &str – Set query_presence_status to true in order to include the presence status of a contact in the response.
• page_size: i64 – The number of records to be returned with a single API call.
• next_page_token: &str – 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.

pub async fn get_all_search_company(
    &self,
    search_key: &str,
    query_presence_status: &str
) -> Result<Vec<Contacts>>

Search company contacts.

This function performs a GET to the /contacts endpoint.

As opposed to search_company, this function returns all the pages of the request at once.

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

pub async fn get_user(
    &self,
    type_: &str,
    page_size: i64,
    next_page_token: &str
) -> Result<Vec<GetUserContactsResponse>>

List user’s contacts.

This function performs a GET to the /chat/users/me/contacts endpoint.

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

Parameters:

• type_: &str – The type of contact. The value can be one of the following: company: Contacts from the user’s organization. external: External contacts. .
• page_size: i64 – The number of records returned with a single API call.
• next_page_token: &str – 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.

pub async fn get_all_user(
    &self,
    type_: &str
) -> Result<Vec<GetUserContactsResponse>>

List user’s contacts.

This function performs a GET to the /chat/users/me/contacts endpoint.

As opposed to get_user, this function returns all the pages of the request at once.

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

pub async fn get_user_contact(
    &self,
    contact_id: &str,
    query_presence_status: bool
) -> Result<GetUserContactResponse>

Get user’s contact details.

This function performs a GET to the /chat/users/me/contacts/{contactId} endpoint.

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 get information on a specific contact of the Zoom user.

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

Scope: chat_contact:read

Rate Limit Label: Medium

Parameters:

• contact_id: &str – The user’s contact Id or email address. The contact can be either a company contact or an external contact.
• query_presence_status: bool – Enable/disable the option for a sub account to use shared Virtual Room Connector(s) that are set up by the master account. Virtual Room Connectors can only be used by On-prem users.