# mulesoft Zoom Connector - Full Documentation

<!-- document id=adc2a0c9020d760de6a659e847cdbb5ec00da4930fee3640a11558fe79798cef url=/mulesoft/current/en-us/zoom-connector/latest/index.md -->

---
product: Zoom Connector
version: 1.0.0
is-latest-version: true
---

# Zoom Connector

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Connector for Zoom (Zoom Connector) enables you to access the Zoom API.

For information about compatibility and fixed issues, refer to the Zoom Connector Release Notes.

## Before You Begin

To use this connector, you must be familiar with:

- The Zoom Connector’s API

- Anypoint Connectors

- Mule runtime engine (Mule)

- Elements and global elements in a Mule flow

- How to create a Mule app using Anypoint Studio

Before creating an app, you must have:

- Credentials to access the Zoom target resource

- Anypoint Platform

- Anypoint Studio or Anypoint Code Builder

## Connection Types

Zoom connections use the following authentication types:

- Client Credentials Config

  - Client Credentials Connection Provider

- Zoom Connector Configuration

  - Bearer Connection Provider

  - Oauth Connection Provider

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange)

- [Zoom Connector Reference](https://docs.mulesoft.com/zoom-connector/latest/zoom-connector-reference)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=b6e504bb1bc5f1e9be7f0e3a5a3a5446f75e05356bbf8b28220170403f54e2df url=/mulesoft/current/en-us/zoom-connector/latest/zoom-connector-reference.md -->

---
product: Zoom Connector
version: 1.0.0
is-latest-version: true
---

# Zoom Connector 1.0 Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

> [!NOTE] This topic is large and might take longer than usual to load in your browser. Allow extra
> time for the content to render or switch to another browser.

> [!NOTE] Where possible, we changed noninclusive terms to align with our company value of Equality.
> We maintained certain terms to avoid any effect on customer implementations.

## Configurations

---

### Client Credentials Config

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Name</p></td><td><p>String</p></td><td><p>Name for this configuration. Connectors reference the configuration with this name.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Connection</p></td><td><div><div><p><a href="#ClientCredentialsConfig_ClientCredentials">Client Credentials Connection Provider</a></p></div></div></td><td><p>Connection types for this configuration.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td><p>60</p></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td><p>SECONDS</p></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td><p>AUTO</p></td><td></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>ID used to reference this configuration.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Expiration Policy</p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><p>Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.</p></td><td></td><td></td></tr></tbody></table>

#### Connection Types

##### Client Credentials Connection Provider

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Default Headers</p></td><td><div><div><p>Array of <a href="#DefaultHeader">Default Header</a>.</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Query Parameters</p></td><td><div><div><p>Array of <a href="#DefaultQueryParam">Default Query Param</a>.</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long the connector waits before timing out when establishing a connection to the remote service.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Connection Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Connection Timeout</strong> field.</p></td><td><p>SECONDS</p></td><td></td></tr><tr><td><p>Use Persistent Connections</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Indicates whether to use persistent connections:</p><p>* <code>true</code></p><p>Mule uses persistent connections.</p><p>* <code>false</code></p><p>Mule closes the connection after the first request completes.</p></td><td><p>true</p></td><td></td></tr><tr><td><p>Max Connections</p></td><td><div><div><p>Number</p></div></div></td><td><p>Maximum number of outbound connections to keep open at the same time.</p></td><td><p>-1</p></td><td></td></tr><tr><td><p>Connection Idle Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>When persistent connections are enabled, how long a connection can remain idle before Mule closes it.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Connection Idle Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Connection Idle Timeout</strong> field.</p></td><td><p>SECONDS</p></td><td></td></tr><tr><td><p>Proxy Config</p></td><td><div><div><p><a href="#Proxy">Proxy</a></p></div></div></td><td><p>Configures a proxy for outbound connections.</p></td><td></td><td></td></tr><tr><td><p>Stream Response</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If this value is <code>true</code>, Mule streams received responses.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Response Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Size of the buffer that stores the HTTP response, in bytes.</p></td><td><p>-1</p></td><td></td></tr><tr><td><p>Base Uri</p></td><td><div><div><p>String</p></div></div></td><td><p>Parameter base URI. Each instance or tenant gets its own.</p></td><td><p><code>https://api.zoom.us/v2</code></p></td><td></td></tr><tr><td><p>Protocol</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>HTTP</p></li><li><p>HTTPS</p></li></ul></div></div></td><td><p>Protocol to use for communication.</p></td><td><p>HTTP</p></td><td></td></tr><tr><td><p>TLS Configuration</p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><p>Configures TLS. If using the HTTPS protocol, you must configure TLS.</p></td><td></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>Configures a reconnection strategy to use when a connector operation fails to connect to an external server.</p></td><td></td><td></td></tr><tr><td><p>Client Id</p></td><td><div><div><p>String</p></div></div></td><td><p>OAuth client ID registered with the service provider.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Client Secret</p></td><td><div><div><p>String</p></div></div></td><td><p>OAuth client secret registered with the service provider.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Token Url</p></td><td><div><div><p>String</p></div></div></td><td><p>Service provider’s token endpoint URL.</p></td><td><p><code>https://api.zoom.us/oauth/token</code></p></td><td></td></tr><tr><td><p>Scopes</p></td><td><div><div><p>String</p></div></div></td><td><p>OAuth scopes requested during the dance. If not provided, it defaults to those in the annotation.</p></td><td></td><td></td></tr><tr><td><p>Object Store</p></td><td><div><div><p>String</p></div></div></td><td><p>A reference to the object store used to store each resource owner ID’s data. If not specified, Mule automatically provisions the default one.</p></td><td></td><td></td></tr></tbody></table>

## Supported Operations

- [Delete A Chatbot Message](#DeleteAchatbotMessage)

- [Edit Chatbot Message](#EditChatbotMessage)

- [Sendchatbot](#Sendchatbot)

- [Unauthorize](#Unauthorize)

---

### Zoom Connector Configuration

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Name</p></td><td><p>String</p></td><td><p>Name for this configuration. Connectors reference the configuration with this name.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Connection</p></td><td><div><div><ul><li><p><a href="#ZoomConfig_Bearer">Bearer Connection Provider</a></p></li><li><p><a href="#ZoomConfig_Oauth">Oauth Connection Provider</a></p></li></ul></div></div></td><td><p>Connection types for this configuration.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td><p>60</p></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td><p>SECONDS</p></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content. * <code>ALWAYS</code> &lt;p&gt;Connector always streams the request content. &lt;li&gt;`NEVER` &lt;p&gt; Connector does not stream the request content."</p></td><td><p>AUTO</p></td><td></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>ID used to reference this configuration.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Expiration Policy</p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><p>Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.</p></td><td></td><td></td></tr></tbody></table>

#### Connection Types

##### Bearer Connection Provider

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Default Headers</p></td><td><div><div><p>Array of <a href="#DefaultHeader">Default Header</a>.</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Query Parameters</p></td><td><div><div><p>Array of <a href="#DefaultQueryParam">Default Query Param</a>.</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long the connector waits before timing out when establishing a connection to the remote service.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Connection Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Connection Timeout</strong> field.</p></td><td><p>SECONDS</p></td><td></td></tr><tr><td><p>Use Persistent Connections</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Indicates whether to use persistent connections:</p><p>* <code>true</code></p><p>Mule uses persistent connections.</p><p>* <code>false</code></p><p>Mule closes the connection after the first request completes.</p></td><td><p>true</p></td><td></td></tr><tr><td><p>Max Connections</p></td><td><div><div><p>Number</p></div></div></td><td><p>Maximum number of outbound connections to keep open at the same time.</p></td><td><p>-1</p></td><td></td></tr><tr><td><p>Connection Idle Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>When persistent connections are enabled, how long a connection can remain idle before Mule closes it.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Connection Idle Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Connection Idle Timeout</strong> field.</p></td><td><p>SECONDS</p></td><td></td></tr><tr><td><p>Proxy Config</p></td><td><div><div><p><a href="#Proxy">Proxy</a></p></div></div></td><td><p>Configures a proxy for outbound connections.</p></td><td></td><td></td></tr><tr><td><p>Stream Response</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If this value is <code>true</code>, Mule streams received responses.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Response Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Size of the buffer that stores the HTTP response, in bytes.</p></td><td><p>-1</p></td><td></td></tr><tr><td><p>Base Uri</p></td><td><div><div><p>String</p></div></div></td><td><p>Parameter base URI. Each instance or tenant gets its own.</p></td><td><p><code>https://api.zoom.us/v2</code></p></td><td></td></tr><tr><td><p>Authorization</p></td><td><div><div><p>String</p></div></div></td><td><p>Authorization.</p></td><td></td><td></td></tr><tr><td><p>Protocol</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>HTTP</p></li><li><p>HTTPS</p></li></ul></div></div></td><td><p>Protocol to use for communication.</p></td><td><p>HTTP</p></td><td></td></tr><tr><td><p>TLS Configuration</p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><p>Configures TLS. If using the HTTPS protocol, you must configure TLS.</p></td><td></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>Configures a reconnection strategy to use when a connector operation fails to connect to an external server.</p></td><td></td><td></td></tr></tbody></table>

##### Oauth Connection Provider

Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more
information, refer to
[Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2),
[Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub),
or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth).

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Default Headers</p></td><td><div><div><p>Array of <a href="#DefaultHeader">Default Header</a>.</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Query Parameters</p></td><td><div><div><p>Array of <a href="#DefaultQueryParam">Default Query Param</a>.</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long the connector waits before timing out when establishing a connection to the remote service.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Connection Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Connection Timeout</strong> field.</p></td><td><p>SECONDS</p></td><td></td></tr><tr><td><p>Use Persistent Connections</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Indicates whether to use persistent connections:</p><p>* <code>true</code></p><p>Mule uses persistent connections.</p><p>* <code>false</code></p><p>Mule closes the connection after the first request completes.</p></td><td><p>true</p></td><td></td></tr><tr><td><p>Max Connections</p></td><td><div><div><p>Number</p></div></div></td><td><p>Maximum number of outbound connections to keep open at the same time.</p></td><td><p>-1</p></td><td></td></tr><tr><td><p>Connection Idle Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>When persistent connections are enabled, how long a connection can remain idle before Mule closes it.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Connection Idle Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Connection Idle Timeout</strong> field.</p></td><td><p>SECONDS</p></td><td></td></tr><tr><td><p>Proxy Config</p></td><td><div><div><p><a href="#Proxy">Proxy</a></p></div></div></td><td><p>Configures a proxy for outbound connections.</p></td><td></td><td></td></tr><tr><td><p>Stream Response</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If this value is <code>true</code>, Mule streams received responses.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Response Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Size of the buffer that stores the HTTP response, in bytes.</p></td><td><p>-1</p></td><td></td></tr><tr><td><p>Base Uri</p></td><td><div><div><p>String</p></div></div></td><td><p>Parameter base URI. Each instance or tenant gets its own.</p></td><td><p><code>https://api.zoom.us/v2</code></p></td><td></td></tr><tr><td><p>Protocol</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>HTTP</p></li><li><p>HTTPS</p></li></ul></div></div></td><td><p>Protocol to use for communication.</p></td><td><p>HTTP</p></td><td></td></tr><tr><td><p>TLS Configuration</p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><p>Configures TLS. If using the HTTPS protocol, you must configure TLS.</p></td><td></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>Configures a reconnection strategy to use when a connector operation fails to connect to an external server.</p></td><td></td><td></td></tr><tr><td><p>Consumer Key</p></td><td><div><div><p>String</p></div></div></td><td><p>OAuth consumerKey registered with the service provider.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Consumer Secret</p></td><td><div><div><p>String</p></div></div></td><td><p>OAuth consumerSecret registered with the service provider.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Authorization Url</p></td><td><div><div><p>String</p></div></div></td><td><p>Service provider’s authorization endpoint URL.</p></td><td><p><code>https://www.zoom.com/oauth/authorize</code></p></td><td></td></tr><tr><td><p>Access Token Url</p></td><td><div><div><p>String</p></div></div></td><td><p>Service provider’s accessToken endpoint URL.</p></td><td><p><code>https://www.zoom.com/oauth/token</code></p></td><td></td></tr><tr><td><p>Scopes</p></td><td><div><div><p>String</p></div></div></td><td><p>OAuth scopes requested during the dance. If not provided, it defaults to those in the annotation.</p></td><td></td><td></td></tr><tr><td><p>Resource Owner Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The resourceOwnerId which each component should use if it doesn’t reference otherwise.</p></td><td></td><td></td></tr><tr><td><p>Before</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the flow to execute immediately before starting the OAuth dance.</p></td><td></td><td></td></tr><tr><td><p>After</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the flow to execute right after receiving an accessToken.</p></td><td></td><td></td></tr><tr><td><p>Listener Config</p></td><td><div><div><p>String</p></div></div></td><td><p>A reference to an &lt;http:listener-config /&gt; used to create the listener that catches the access token callback endpoint.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Callback Path</p></td><td><div><div><p>String</p></div></div></td><td><p>Path of the access token callback endpoint.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Authorize Path</p></td><td><div><div><p>String</p></div></div></td><td><p>Path of the local HTTP endpoint that triggers the OAuth dance.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>External Callback Url</p></td><td><div><div><p>String</p></div></div></td><td><p>URL that the OAuth provider uses to access the callback endpoint if the endpoint is behind a proxy or accessed through an indirect URL.</p></td><td></td><td></td></tr><tr><td><p>Object Store</p></td><td><div><div><p>String</p></div></div></td><td><p>A reference to the object store used to store each resource owner ID’s data. If not specified, Mule automatically provisions the default one.</p></td><td></td><td></td></tr></tbody></table>

## Supported Operations

- [Account](#Account)

- [Account Billing](#AccountBilling)

- [Account Billing Invoices](#AccountBillingInvoices)

- [Account Billing Update](#AccountBillingUpdate)

- [Account Call Logs](#AccountCallLogs)

- [Account Create](#AccountCreate)

- [Account Disassociate](#AccountDisassociate)

- [Account Managed Domain](#AccountManagedDomain)

- [Account Options Update](#AccountOptionsUpdate)

- [Account Plan Addon Cancel](#AccountPlanAddonCancel)

- [Account Plan Addon Create](#AccountPlanAddonCreate)

- [Account Plan Addon Update](#AccountPlanAddonUpdate)

- [Account Plan Base Delete](#AccountPlanBaseDelete)

- [Account Plan Base Update](#AccountPlanBaseUpdate)

- [Account Plan Create](#AccountPlanCreate)

- [Account Plans](#AccountPlans)

- [Account Settings](#AccountSettings)

- [Account Settings Update](#AccountSettingsUpdate)

- [Account Trusted Domain](#AccountTrustedDomain)

- [Accounts](#Accounts)

- [Add Anumber To Blocked List](#AddAnumberToBlockedList)

- [Add A Room](#AddAroom)

- [Add Auto Receptionist](#AddAutoReceptionist)

- [Add Azr Location](#AddAzrlocation)

- [Add Batch Registrants](#AddBatchRegistrants)

- [Add Batch Webinar Registrants](#AddBatchWebinarRegistrants)

- [Add Byoc Number](#AddByocnumber)

- [Add Callout Countries](#AddCalloutCountries)

- [Add Common Area Phone](#AddCommonAreaPhone)

- [Add External Contact](#AddExternalContact)

- [Add Internal Numbers](#AddInternalNumbers)

- [Add Location](#AddLocation)

- [Add Members To Call Queue](#AddMembersToCallQueue)

- [Add Members To Shared Line Group](#AddMembersToSharedLineGroup)

- [Add Phone Device](#AddPhoneDevice)

- [Add Role Members](#AddRoleMembers)

- [Add Setting Template](#AddSettingTemplate)

- [Add User Setting](#AddUserSetting)

- [Assign Calling Plan](#AssignCallingPlan)

- [Assign Calling Plans To Common Area Phone](#AssignCallingPlansToCommonAreaPhone)

- [Assign Phone Number](#AssignPhoneNumber)

- [Assign Phone Numbers Auto Receptionist](#AssignPhoneNumbersAutoReceptionist)

- [Assign Phone Numbers Slg](#AssignPhoneNumbersSlg)

- [Assign Phone Numbers To Common Area Phone](#AssignPhoneNumbersToCommonAreaPhone)

- [Assign Phone To Call Queue](#AssignPhoneToCallQueue)

- [Assign Sip Trunk Numbers](#AssignSipTrunkNumbers)

- [Assign Sip Config](#AssignSipconfig)

- [Assign Sip Trunks](#AssignSiptrunks)

- [Batch Add Locations](#BatchAddLocations)

- [Change Call Queue Manager](#ChangeCallQueueManager)

- [Change Main Company Number](#ChangeMainCompanyNumber)

- [Change Parent Location](#ChangeParentLocation)

- [Change Zoom Rooms App Version](#ChangeZoomRoomsAppVersion)

- [Change Zr Location](#ChangeZrlocation)

- [Check In Rooms](#CheckInRooms)

- [Create A Shared Line Group](#CreateAsharedLineGroup)

- [Create Batch Polls](#CreateBatchPolls)

- [Create Call Queue](#CreateCallQueue)

- [Create Channel](#CreateChannel)

- [Create Phone Site](#CreatePhoneSite)

- [Create Role](#CreateRole)

- [Create Sip Phone](#CreateSipphone)

- [Dashboard Chat](#DashboardChat)

- [Dashboard Client Feedback](#DashboardClientFeedback)

- [Dashboard Client Feedback Detail](#DashboardClientFeedbackDetail)

- [Dashboard Crc](#DashboardCrc)

- [Dashboard Im](#DashboardIm)

- [Dashboard Issue Detail Zoom Room](#DashboardIssueDetailZoomRoom)

- [Dashboard Issue Zoom Room](#DashboardIssueZoomRoom)

- [Dashboard Meeting Detail](#DashboardMeetingDetail)

- [Dashboard Meeting Participant Qos](#DashboardMeetingParticipantQos)

- [Dashboard Meeting Participant Share](#DashboardMeetingParticipantShare)

- [Dashboard Meeting Participants](#DashboardMeetingParticipants)

- [Dashboard Meeting Participants Qos](#DashboardMeetingParticipantsQos)

- [Dashboard Meetings](#DashboardMeetings)

- [Dashboard Webinar Detail](#DashboardWebinarDetail)

- [Dashboard Webinar Participant Qos](#DashboardWebinarParticipantQos)

- [Dashboard Webinar Participant Share](#DashboardWebinarParticipantShare)

- [Dashboard Webinar Participants](#DashboardWebinarParticipants)

- [Dashboard Webinar Participants Qos](#DashboardWebinarParticipantsQos)

- [Dashboard Webinars](#DashboardWebinars)

- [Dashboard Zoom Room](#DashboardZoomRoom)

- [Dashboard Zoom Room Issue](#DashboardZoomRoomIssue)

- [Dashboard Zoom Rooms](#DashboardZoomRooms)

- [Del Group Vb](#DelGroupVb)

- [Del User Vb](#DelUserVb)

- [Del Vb](#DelVb)

- [Delete A Blocked List](#DeleteAblockedList)

- [Delete A Call Queue](#DeleteAcallQueue)

- [Delete A Device](#DeleteAdevice)

- [Delete A External Contact](#DeleteAexternalContact)

- [Delete All Sip Numbers](#DeleteAllSipNumbers)

- [Delete A Member Slg](#DeleteAmemberSlg)

- [Delete A Phone Number Slg](#DeleteAphoneNumberSlg)

- [Delete A Shared Line Group](#DeleteAsharedLineGroup)

- [Delete A Zoom Room](#DeleteAzoomRoom)

- [Delete Call Log](#DeleteCallLog)

- [Delete Channel](#DeleteChannel)

- [Delete Chat Message](#DeleteChatMessage)

- [Delete Common Area Phone](#DeleteCommonAreaPhone)

- [Delete Internal Call Out Country](#DeleteInternalCallOutCountry)

- [Delete Internal Number](#DeleteInternalNumber)

- [Delete Location](#DeleteLocation)

- [Delete Members Of Slg](#DeleteMembersOfSlg)

- [Delete Phone Numbers Slg](#DeletePhoneNumbersSlg)

- [Delete Phone Site](#DeletePhoneSite)

- [Delete Role](#DeleteRole)

- [Delete Sip Phone](#DeleteSipphone)

- [Delete Sip Trunk](#DeleteSiptrunk)

- [Delete User Level Channel](#DeleteUserLevelChannel)

- [Delete User Setting](#DeleteUserSetting)

- [Delete Voicemail](#DeleteVoicemail)

- [Delete Webinar Registrant](#DeleteWebinarRegistrant)

- [Device Create](#DeviceCreate)

- [Device Delete](#DeviceDelete)

- [Device List](#DeviceList)

- [Device Update](#DeviceUpdate)

- [Download Invoice Pdf](#DownloadInvoicePdf)

- [Edit Message](#EditMessage)

- [Get A Blocked List](#GetAblockedList)

- [Get A Call Queue](#GetAcallQueue)

- [Get Account Billing Invoice](#GetAccountBillingInvoice)

- [Get Account Cloud Recording](#GetAccountCloudRecording)

- [Get Account Lock Settings](#GetAccountLockSettings)

- [Get A Common Area Phone](#GetAcommonAreaPhone)

- [Get A Device](#GetAdevice)

- [Get A External Contact](#GetAexternalContact)

- [Get A Shared Line Group](#GetAsharedLineGroup)

- [Get A Site](#GetAsite)

- [Get Billing Invoices Reports](#GetBillingInvoicesReports)

- [Get Billing Report](#GetBillingReport)

- [Get Call Log Details](#GetCallLogDetails)

- [Get Call Log Metrics Details](#GetCallLogMetricsDetails)

- [Get Call Qo S](#GetCallQoS)

- [Get Call Queue Recordings](#GetCallQueueRecordings)

- [Get Channel](#GetChannel)

- [Get Channels](#GetChannels)

- [Get Chat Message](#GetChatMessage)

- [Get Chat Messages](#GetChatMessages)

- [Get Group Lock Settings](#GetGroupLockSettings)

- [Get Group Settings](#GetGroupSettings)

- [Get Live Stream Details For Meeting](#GetLiveStreamDetailsForMeeting)

- [Get Live Stream Details For Webinar](#GetLiveStreamDetailsForWebinar)

- [Get Location](#GetLocation)

- [Get Phone Number Details](#GetPhoneNumberDetails)

- [Get Phone Recordings](#GetPhoneRecordings)

- [Get Plan Usage](#GetPlanUsage)

- [Get Ps Operation Logs](#GetPsoperationLogs)

- [Get Role Information](#GetRoleInformation)

- [Get Setting Template](#GetSettingTemplate)

- [Get Tracking Sources](#GetTrackingSources)

- [Get User Contact](#GetUserContact)

- [Get User Contacts](#GetUserContacts)

- [Get User Level Channel](#GetUserLevelChannel)

- [Get Zr Account Profile](#GetZraccountProfile)

- [Get Zr Account Settings](#GetZraccountSettings)

- [Get Zr Location Profile](#GetZrlocationProfile)

- [Get Zr Location Settings](#GetZrlocationSettings)

- [Get Zr Location Structure](#GetZrlocationStructure)

- [Get Zr Profile](#GetZrprofile)

- [Get Zr Settings](#GetZrsettings)

- [Group](#Group)

- [Group Create](#GroupCreate)

- [Group Delete](#GroupDelete)

- [Group Locked Settings](#GroupLockedSettings)

- [Group Members](#GroupMembers)

- [Group Members Create](#GroupMembersCreate)

- [Group Members Delete](#GroupMembersDelete)

- [Group Update](#GroupUpdate)

- [Groups](#Groups)

- [Im Chat Messages](#ImChatMessages)

- [Im Chat Sessions](#ImChatSessions)

- [Im Group](#ImGroup)

- [Im Group Create](#ImGroupCreate)

- [Im Group Delete](#ImGroupDelete)

- [Im Group Members](#ImGroupMembers)

- [Im Group Members Create](#ImGroupMembersCreate)

- [Im Group Members Delete](#ImGroupMembersDelete)

- [Im Group Update](#ImGroupUpdate)

- [Im Groups](#ImGroups)

- [In Meeting Recording Control](#InMeetingRecordingControl)

- [Invite Channel Members](#InviteChannelMembers)

- [Join Channel](#JoinChannel)

- [Leave Channel](#LeaveChannel)

- [List Account Phone Numbers](#ListAccountPhoneNumbers)

- [List Archived Files](#ListArchivedFiles)

- [List Blocked List](#ListBlockedList)

- [List Byocsip Trunk](#ListByocsiptrunk)

- [List Call Logs Metrics](#ListCallLogsMetrics)

- [List Call Queues](#ListCallQueues)

- [List Calling Plans](#ListCallingPlans)

- [List Channel Members](#ListChannelMembers)

- [List Common Area Phones](#ListCommonAreaPhones)

- [List Digital Signage Content](#ListDigitalSignageContent)

- [List External Contacts](#ListExternalContacts)

- [List Internal Callout Countries](#ListInternalCalloutCountries)

- [List Internal Numbers](#ListInternalNumbers)

- [List Locations](#ListLocations)

- [List Meeting Satisfaction](#ListMeetingSatisfaction)

- [List Meeting Templates](#ListMeetingTemplates)

- [List Past Meeting Files](#ListPastMeetingFiles)

- [List Past Meeting Polls](#ListPastMeetingPolls)

- [List Past Webinar Files](#ListPastWebinarFiles)

- [List Past Webinar Poll Results](#ListPastWebinarPollResults)

- [List Past Webinar Qa](#ListPastWebinarQa)

- [List Phone Devices](#ListPhoneDevices)

- [List Phone Sites](#ListPhoneSites)

- [List Phone Users](#ListPhoneUsers)

- [List Setting Templates](#ListSettingTemplates)

- [List Shared Line Groups](#ListSharedLineGroups)

- [List Sip Groups](#ListSipGroups)

- [List Sip Phones](#ListSipPhones)

- [List Sip Trunk Numbers](#ListSipTrunkNumbers)

- [List Sip Trunks](#ListSiptrunks)

- [List Webinar Participants](#ListWebinarParticipants)

- [List Webinar Templates](#ListWebinarTemplates)

- [List Zoom Rooms](#ListZoomRooms)

- [List Zr Devices](#ListZrdevices)

- [List Zr Locations](#ListZrlocations)

- [Listimmessages](#Listimmessages)

- [Manage E911signage](#ManageE911signage)

- [Mark Message](#MarkMessage)

- [Meeting](#Meeting)

- [Meeting Create](#MeetingCreate)

- [Meeting Delete](#MeetingDelete)

- [Meeting Invitation](#MeetingInvitation)

- [Meeting Invite Links Create](#MeetingInviteLinksCreate)

- [Meeting Live Stream Status Update](#MeetingLiveStreamStatusUpdate)

- [Meeting Live Stream Update](#MeetingLiveStreamUpdate)

- [Meeting Poll Create](#MeetingPollCreate)

- [Meeting Poll Delete](#MeetingPollDelete)

- [Meeting Poll Get](#MeetingPollGet)

- [Meeting Poll Update](#MeetingPollUpdate)

- [Meeting Polls](#MeetingPolls)

- [Meeting Quality Score](#MeetingQualityScore)

- [Meeting Recording Registrant Create](#MeetingRecordingRegistrantCreate)

- [Meeting Recording Registrant Status](#MeetingRecordingRegistrantStatus)

- [Meeting Recording Registrants](#MeetingRecordingRegistrants)

- [Meeting Registrant Create](#MeetingRegistrantCreate)

- [Meeting Registrant Question Update](#MeetingRegistrantQuestionUpdate)

- [Meeting Registrant Status](#MeetingRegistrantStatus)

- [Meeting Registrants](#MeetingRegistrants)

- [Meeting Registrants Questions Get](#MeetingRegistrantsQuestionsGet)

- [Meeting Status](#MeetingStatus)

- [Meeting Update](#MeetingUpdate)

- [Meetingregistrantdelete](#Meetingregistrantdelete)

- [Meetings](#Meetings)

- [Participant Feedback](#ParticipantFeedback)

- [Participant Webinar Feedback](#ParticipantWebinarFeedback)

- [Past Meeting Details](#PastMeetingDetails)

- [Past Meeting Participants](#PastMeetingParticipants)

- [Past Meetings](#PastMeetings)

- [Past Webinars](#PastWebinars)

- [Phone Setting](#PhoneSetting)

- [Phone User](#PhoneUser)

- [Phone User Call Logs](#PhoneUserCallLogs)

- [Phone User Recordings](#PhoneUserRecordings)

- [Phone User Settings](#PhoneUserSettings)

- [Phone User Voice Mails](#PhoneUserVoiceMails)

- [Post Phone Sip Trunk](#PostPhoneSiptrunk)

- [React Message](#ReactMessage)

- [Recording Delete](#RecordingDelete)

- [Recording Delete One](#RecordingDeleteOne)

- [Recording Get](#RecordingGet)

- [Recording Registrant Question Update](#RecordingRegistrantQuestionUpdate)

- [Recording Registrants Questions Get](#RecordingRegistrantsQuestionsGet)

- [Recording Setting Update](#RecordingSettingUpdate)

- [Recording Settings Update](#RecordingSettingsUpdate)

- [Recording Status Update](#RecordingStatusUpdate)

- [Recording Status Update One](#RecordingStatusUpdateOne)

- [Recordings List](#RecordingsList)

- [Remove A Channel Member](#RemoveAchannelMember)

- [Remove A User Level Channel Member](#RemoveAuserLevelChannelMember)

- [Report Cloud Recording](#ReportCloudRecording)

- [Report Daily](#ReportDaily)

- [Report Meeting Details](#ReportMeetingDetails)

- [Report Meeting Participants](#ReportMeetingParticipants)

- [Report Meeting Polls](#ReportMeetingPolls)

- [Report Meetings](#ReportMeetings)

- [Report Operation Logs](#ReportOperationLogs)

- [Report Sign In Sign Out Activities](#ReportSignInSignOutActivities)

- [Report Telephone](#ReportTelephone)

- [Report Users](#ReportUsers)

- [Report Webinar Details](#ReportWebinarDetails)

- [Report Webinar Participants](#ReportWebinarParticipants)

- [Report Webinar Polls](#ReportWebinarPolls)

- [Report Webinar Qa](#ReportWebinarQa)

- [Role Member Delete](#RoleMemberDelete)

- [Role Members](#RoleMembers)

- [Roles](#Roles)

- [Search Company Contacts](#SearchCompanyContacts)

- [Senda Chat Message](#SendaChatMessage)

- [Sendimmessages](#Sendimmessages)

- [Set Up Account](#SetUpAccount)

- [Switch User Account](#SwitchUserAccount)

- [Testget Record Archived Files](#TestgetRecordArchivedFiles)

- [Trackingfield Create](#TrackingfieldCreate)

- [Trackingfield Delete](#TrackingfieldDelete)

- [Trackingfield Get](#TrackingfieldGet)

- [Trackingfield List](#TrackingfieldList)

- [Trackingfield Update](#TrackingfieldUpdate)

- [Tsp](#Tsp)

- [Tsp Update](#TspUpdate)

- [Tsp Url Update](#TspUrlUpdate)

- [Un Assign Phone Num Call Queue](#UnAssignPhoneNumCallQueue)

- [Unassign All Members](#UnassignAllMembers)

- [Unassign All Phone Nums Auto Receptionist](#UnassignAllPhoneNumsAutoReceptionist)

- [Unassign A Phone Num Auto Receptionist](#UnassignAphoneNumAutoReceptionist)

- [Unassign A Phone Num Call Queue](#UnassignAphoneNumCallQueue)

- [Unassign Calling Plan](#UnassignCallingPlan)

- [Unassign Calling Plans From Common Area Phone](#UnassignCallingPlansFromCommonAreaPhone)

- [Unassign Member From Call Queue](#UnassignMemberFromCallQueue)

- [Unassign Phone Number](#UnassignPhoneNumber)

- [Unassign Phone Numbers From Common Area Phone](#UnassignPhoneNumbersFromCommonAreaPhone)

- [Unauthorize](#Unauthorize)

- [Update Account Lock Settings](#UpdateAccountLockSettings)

- [Update Account Owner](#UpdateAccountOwner)

- [Update A Device](#UpdateAdevice)

- [Update A Group Member](#UpdateAgroupMember)

- [Update A Shared Line Group](#UpdateAsharedLineGroup)

- [Update Auto Receptionist](#UpdateAutoReceptionist)

- [Update Blocked List](#UpdateBlockedList)

- [Update Call Queue](#UpdateCallQueue)

- [Update Channel](#UpdateChannel)

- [Update Common Area Phone](#UpdateCommonAreaPhone)

- [Update External Contact](#UpdateExternalContact)

- [Update Group Settings](#UpdateGroupSettings)

- [Update Location](#UpdateLocation)

- [Update Phone Number Details](#UpdatePhoneNumberDetails)

- [Update Phone Settings](#UpdatePhoneSettings)

- [Update Phone Sip Trunk](#UpdatePhoneSiptrunk)

- [Update Presence Status](#UpdatePresenceStatus)

- [Update Role](#UpdateRole)

- [Update Room Profile](#UpdateRoomProfile)

- [Update Setting Template](#UpdateSettingTemplate)

- [Update Sip Phone](#UpdateSipphone)

- [Update Site Details](#UpdateSiteDetails)

- [Update User Level Channel](#UpdateUserLevelChannel)

- [Update User Profile](#UpdateUserProfile)

- [Update User Setting](#UpdateUserSetting)

- [Update Zoom Room Acc Settings](#UpdateZoomRoomAccSettings)

- [Update Zoom Rooms Location Structure](#UpdateZoomRoomsLocationStructure)

- [Update Zr Acc Profile](#UpdateZraccProfile)

- [Update Zr Location Profile](#UpdateZrlocationProfile)

- [Update Zr Location Settings](#UpdateZrlocationSettings)

- [Update Zr Settings](#UpdateZrsettings)

- [Upload Group Vb](#UploadGroupVb)

- [Upload Vb](#UploadVb)

- [Upload V Buser](#UploadVbuser)

- [User](#User)

- [User Assistant Create](#UserAssistantCreate)

- [User Assistant Delete](#UserAssistantDelete)

- [User Assistants](#UserAssistants)

- [User Assistants Delete](#UserAssistantsDelete)

- [User Create](#UserCreate)

- [User Delete](#UserDelete)

- [User Email](#UserEmail)

- [User Email Update](#UserEmailUpdate)

- [User Pa Cs](#UserPacs)

- [User Password](#UserPassword)

- [User Permission](#UserPermission)

- [User Picture](#UserPicture)

- [User Scheduler Delete](#UserSchedulerDelete)

- [User Schedulers](#UserSchedulers)

- [User Schedulers Delete](#UserSchedulersDelete)

- [User Settings](#UserSettings)

- [User Settings Update](#UserSettingsUpdate)

- [User Sso Token Delete](#UserSsotokenDelete)

- [User Status](#UserStatus)

- [User Token](#UserToken)

- [User Tsp](#UserTsp)

- [User Tsp Create](#UserTspcreate)

- [User Tsp Delete](#UserTspdelete)

- [User Ts Ps](#UserTsps)

- [User Tsp Update](#UserTspupdate)

- [User Update](#UserUpdate)

- [User Vanity Name](#UserVanityName)

- [User Zak](#UserZak)

- [Users](#Users)

- [Webinar](#Webinar)

- [Webinar Absentees](#WebinarAbsentees)

- [Webinar Create](#WebinarCreate)

- [Webinar Delete](#WebinarDelete)

- [Webinar Invite Links Create](#WebinarInviteLinksCreate)

- [Webinar Live Stream Status Update](#WebinarLiveStreamStatusUpdate)

- [Webinar Live Stream Update](#WebinarLiveStreamUpdate)

- [Webinar Panelist Create](#WebinarPanelistCreate)

- [Webinar Panelist Delete](#WebinarPanelistDelete)

- [Webinar Panelists](#WebinarPanelists)

- [Webinar Panelists Delete](#WebinarPanelistsDelete)

- [Webinar Poll Create](#WebinarPollCreate)

- [Webinar Poll Delete](#WebinarPollDelete)

- [Webinar Poll Get](#WebinarPollGet)

- [Webinar Poll Update](#WebinarPollUpdate)

- [Webinar Polls](#WebinarPolls)

- [Webinar Registrant Create](#WebinarRegistrantCreate)

- [Webinar Registrant Get](#WebinarRegistrantGet)

- [Webinar Registrant Question Update](#WebinarRegistrantQuestionUpdate)

- [Webinar Registrant Status](#WebinarRegistrantStatus)

- [Webinar Registrants](#WebinarRegistrants)

- [Webinar Registrants Questions Get](#WebinarRegistrantsQuestionsGet)

- [Webinar Status](#WebinarStatus)

- [Webinar Update](#WebinarUpdate)

- [Webinars](#Webinars)

## Associated Sources

- [On New Meeting Trigger](#OnNewMeetingTrigger)

- [On New Registrant Trigger](#OnNewRegistrantTrigger)

## Delete A Chatbot Message

`<zoom-connector-mule-4:delete-achatbot-message>`

Deletes a message sent by your Chatbot app. To get authorized, make a POST request to the
`/oauth/token` endpoint with the `client_credentials` grant type. Use
`https://api.zoom.us/oauth/token?grant_type=client_credentials` as the endpoint for the request. You
must send your clientID and secret as a basic base64 encoded authorization header, such as
`Basic base64Encode({client_id}:{client_sceret})`. Next, use the token received (access\_token) as a
bearer token while making the DELETE /im/chat/messages/{message\_id} request to delete a message.
Learn more about how to authorize chatbots in the
[Chatbot Authorization](https://developers.zoom.us/docs/team-chat/installation-and-authentication/)
guide. This operation makes an HTTP DELETE request to the /im/chat/messages/{message\_id} endpoint.

- Scope: `imchat:bot`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

- Authorization Flow: Client Credentials Flow

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Message ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Message ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Client Credentials Config](#ClientCredentialsConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Edit Chatbot Message

`<zoom-connector-mule-4:edit-chatbot-message>`

Edits a message that was
[sent](https://developers.zoom.us/docs/api/chatbot/#tag/chatbot-messages/POST/im/chat/messages) by
your Chatbot app. After sending a message using the Send Chatbot Message API, you must store the
messageId returned in the response so that you can make edits to the associated message using this
API. To get authorized, make a POST request to the `/oauth/token` endpoint with the
`client_credentials` grant type. Use `https://api.zoom.us/oauth/token?grant_type=client_credentials`
as the endpoint for the request. You must send your clientID and secret as a basic base64 encoded
authorization header, such as `Basic base64Encode({client_id}:{client_sceret})`. Next, use the token
received (access\_token) as a bearer token while making the PUT /im/chat/messages/{message\_id}
request to edit a chatbot message. Learn more about how to authorize chatbots in the
[Chatbot Authorization](https://developers.zoom.us/docs/team-chat/installation-and-authentication/)
guide. This operation makes an HTTP PUT request to the /im/chat/messages/{message\_id} endpoint.

- Scope: `imchat:bot`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

- Authorization Flow: Client Credentials Flow

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Message ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the message that needs to be updated. This is retrieved from the response of the <a href="https://developers.zoom.us/docs/api/chatbot/#tag/chatbot-messages/POST/im/chat/messages">Send Chatbot Message API</a>.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Client Credentials Config](#ClientCredentialsConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Sendchatbot

`<zoom-connector-mule-4:sendchatbot>`

Send chatbot messages from your marketplace Chatbot app. To get authorized, make a POST request to
the `/oauth/token` endpoint with the `client_credentials` grant type. Use
`https://api.zoom.us/oauth/token?grant_type=client_credentials` as the endpoint for the request. You
will need to send your clientID and secret as a basic base64 encoded authorization header, such as
`Basic base64Encode({client_id}:{client_sceret})`. Next, use the token received (access\_token) as a
bearer token while making the POST /im/chat/messages request to send chatbot messages. Learn more
about how to authorize chatbots in the
[Chatbot Authorization](https://developers.zoom.us/docs/team-chat/installation-and-authentication/)
guide. This operation makes an HTTP POST request to the /im/chat/messages endpoint.

- Scope: `imchat:bot`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

- Authorization Flow: Client Credentials Flow

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Client Credentials Config](#ClientCredentialsConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Unauthorize

`<zoom-connector-mule-4:unauthorize>`

Deletes all the access token information of a given resource owner ID so that it is impossible to
execute any operation for that user without doing the authorization dance again.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Resource Owner Id</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the resource owner whose access should be invalidated.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr></tbody></table>

### For Configurations

- [Client Credentials Config](#ClientCredentialsConfig)

- [Zoom Connector Configuration](#ZoomConfig)

## Account

`<zoom-connector-mule-4:account>`

Gets details of a sub account that is listed under a master account. Your account must be a master
account to retrieve sub accounts' details. Zoom allows only
[approved partners](https://developers.zoom.us/docs/api/ma/) to use master APIs and create sub
accounts. Email the partner programs team at **partner-success@zoom.us** for more details. This
operation makes an HTTP GET request to the /accounts/{accountId} endpoint.

- Prerequisites: Pro or a higher paid account with master account option enabled.

- Scope: `account:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The account ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Account Billing

`<zoom-connector-mule-4:account-billing>`

Gets
[billing information](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060580) of
a sub account. Only master accounts can use this API. Zoom allows only
[approved partners](https://developers.zoom.us/docs/api/ma/) to use master APIs and manage sub
accounts' billing information. Email the partner programs team at **partner-success@zoom.us** for
more details. This operation makes an HTTP GET request to the /accounts/{accountId}/billing
endpoint.

- Prerequisites: Pro or a higher paid account with master account option enabled.

- Scope: `billing:master`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The account ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Account Billing Invoices

`<zoom-connector-mule-4:account-billing-invoices>`

Lists [invoices](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064306) of a
Zoom account. To list a regular Zoom account’s invoices or a master account’s invoices, provide `me`
as the value of the `accountId` path parameter. To list a sub account’s invoices, provide the
account ID of the sub account in the `accountId` path parameter. You can make one API request per
account (`accountId`) every five minutes until the daily limit is reached. This API has a daily
limit of six requests per account (`accountId`). This operation makes an HTTP GET request to the
/accounts/{accountId}/billing/invoices endpoint.

- Prerequisites: Account must be enrolled in Pro or a higher plan.

- Scope: `billing:master`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The account ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>from</p></td><td><div><div><p>String</p></div></div></td><td><p>Start date for the invoice query in <code>yyyy-mm-dd</code> format. The date range between <code>from</code> and <code>to</code> must not exceed one year. The range defined must fall within the past three years.</p></td><td></td><td></td></tr><tr><td><p>to</p></td><td><div><div><p>String</p></div></div></td><td><p>End date for the invoice query in <code>yyyy-mm-dd</code> format.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Account Billing Update

`<zoom-connector-mule-4:account-billing-update>`

Updates
[billing information](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060580) of
a sub account. This API can only be used by master accounts that pay all billing charges of their
associated sub accounts. Zoom allows only
[approved partners](https://developers.zoom.us/docs/api/ma/) to use master APIs and manage sub
accounts' billing information. Email the partner programs team at **partner-success@zoom.us** for
more details. This operation makes an HTTP PATCH request to the /accounts/{accountId}/billing
endpoint.

- Prerequisites: Pro or a higher paid account with master account option enabled.

- Scope: `billing:master`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The account ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Account Call Logs

`<zoom-connector-mule-4:account-call-logs>`

Use this API to return an account’s
[call logs](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0069950). This
operation makes an HTTP GET request to the /phone/call\_logs endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>from</p></td><td><div><div><p>String</p></div></div></td><td><p>Start date from which you would like to get the call logs. The start date must be within the past six months. The API only returns data pertaining to a month. Thus, the date range (defined using <code>from</code> and <code>to</code> fields) for which the call logs are returned must not exceed a month.</p></td><td></td><td></td></tr><tr><td><p>to</p></td><td><div><div><p>String</p></div></div></td><td><p>The end date up to which you would like to get the call logs for. The end date must be within the past six months.</p></td><td></td><td></td></tr><tr><td><p>type</p></td><td><div><div><p>String</p></div></div></td><td><p>The type of the call logs. The value can be either <code>all</code> or <code>missed</code>.</p></td><td></td><td></td></tr><tr><td><p>path</p></td><td><div><div><p>String</p></div></div></td><td><p>Filter the API response by <a href="https://support.zoom.com/hc/en/article?id=zm_kb&amp;sysparm_article=KB0069950">path</a> of the call. The value of this field can be one of the following: <code>voiceMail</code>, <code>message</code>, <code>forward</code>, <code>extension</code>, <code>callQueue</code>, <code>ivrMenu</code>, <code>companyDirectory</code>, <code>autoReceptionist</code>, <code>contactCenter</code>, <code>disconnected</code>, <code>commonAreaPhone</code>, <code>pstn</code>, <code>transfer</code>, <code>sharedLines</code>, <code>sharedLineGroup</code>, <code>tollFreeBilling</code>, <code>meetingService</code>, <code>parkPickup</code>, <code>parkTimeout</code>, <code>monitor</code>, <code>takeover</code>, or <code>sipGroup</code>.</p></td><td></td><td></td></tr><tr><td><p>Time type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>START_TIME</p></li><li><p>END_TIME</p></li></ul></div></div></td><td><p>Enables you to sort call logs by start or end time. Choose the sort time value. Values include <code>startTime</code> or <code>endTime</code>.</p></td><td><p>START_TIME</p></td><td></td></tr><tr><td><p>Site ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the <a href="https://support.zoom.com/hc/en/article?id=zm_kb&amp;sysparm_article=KB0069716">site</a>. Use this query parameter if you have enabled multiple sites and would like to filter the response of this API call by call logs of a specific phone site.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Account Create

`<zoom-connector-mule-4:account-create>`

Creates a sub account under a master account. Your account must be a master account to create sub
accounts. Zoom allows only [approved partners](https://developers.zoom.us/docs/api/ma/) to use
master APIs and manage sub accounts. Email the partner programs team at
[partner-success@zoom.us](mailto:partner-success@zoom.us) for more details. The created account user
will receive a confirmation email. This operation makes an HTTP POST request to the /accounts
endpoint.

- Prerequisites: Pro or a higher paid account with master account option enabled.

- Scope: `account:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Account Disassociate

`<zoom-connector-mule-4:account-disassociate>`

Disassociate a sub account from its master account. This will leave the sub account intact but it
will no longer be associated with the master account. This operation makes an HTTP DELETE request to
the /accounts/{accountId} endpoint.

- Prerequisites: Pro or a higher paid account with master account option enabled. The account making
  this API request must be a [master account](https://developers.zoom.us/docs/api/ma/).

- Scope: `account:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The account ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Account Managed Domain

`<zoom-connector-mule-4:account-managed-domain>`

Get a sub account’s
[managed domains](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066259). This
API can be used by Zoom Accounts that are on a Pro or a higher plan as well accounts that have
master and sub accounts options enabled. To get managed domains of the master account, provide `me`
as the value for accountId in the path parameter. Provide the sub account’s Account ID as the value
of accountId path parameter to get managed domains of the sub account. This operation makes an HTTP
GET request to the /accounts/{accountId}/managed\_domains endpoint.

- Prerequisites: Pro or a higher paid account with master account option enabled.

- Scope: `account:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the account. To retrieve locked settings of the master account or a regular account, provide "me" as the value of this field. To retrieve locked settings of a sub account, provide the Account ID of the sub account in this field.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Account Options Update

`<zoom-connector-mule-4:account-options-update>`

Update a sub account’s options under the master account. Your account must be a master account to
update the options for sub accounts. Zoom only assigns this privilege to trusted partners. This
operation makes an HTTP PATCH request to the /accounts/{accountId}/options endpoint.

- Prerequisites: Pro or a higher paid account with master account option enabled. The account making
  this API request must be a [master account](https://developers.zoom.us/docs/api/ma/).

- Scope: `account:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The account ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Account Plan Addon Cancel

`<zoom-connector-mule-4:account-plan-addon-cancel>`

[Cancel additional plan](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066687)
of a sub account. The cancellation does not provide a refund for the current subscription. The
service remains active for the current session. This API can only be used by master accounts that
pay all billing charges of their associated Pro or higher sub accounts. Zoom allows only
[approved partners](https://developers.zoom.us/docs/api/ma/) to use master APIs and manage sub
accounts' subscriptions. Email the partner programs team at **partner-success@zoom.us** for more
details. This operation makes an HTTP PATCH request to the /accounts/{accountId}/plans/addons/status
endpoint.

- Prerequisites: Pro or a higher plan with master account option enabled. The sub account must be a
  paid account.

- Scope: `billing:master`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Account ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Account Plan Addon Create

`<zoom-connector-mule-4:account-plan-addon-create>`

Subscribe a sub account to a Zoom add-on plan. This API can only be used by master accounts that pay
all billing charges of their associated Pro or higher subaccounts. Zoom allows only approved
partners to use [master APIs](https://developers.zoom.us/docs/api/ma/) and manage subaccounts'
subscriptions. For more information, email the partner programs team at **partner-success@zoom.us**.
This operation makes an HTTP POST request to the /accounts/{accountId}/plans/addons endpoint.

- Prerequisites: Pro or a higher plan with master account option enabled. The subaccount must be a
  paid account whose billing charges are paid by its master account.

- Scopes: `billing:master`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The account ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Account Plan Addon Update

`<zoom-connector-mule-4:account-plan-addon-update>`

Update an additional plan for a sub account. This API can only be used by master accounts that pay
all billing charges of their associated Pro or higher sub accounts. Zoom allows only
[approved partners](https://developers.zoom.us/docs/api/ma/) to use master APIs and manage sub
accounts' subscriptions. Email the partner programs team at **partner-success@zoom.us** for more
details. This operation makes an HTTP PUT request to the /accounts/{accountId}/plans/addons
endpoint.

- Prerequisites: Pro or a higher plan with master account enabled. The sub account must be a paid
  account. The billing charges for the sub account must be paid by the master account.

- Scopes: `billing:master`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The account ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Account Plan Base Delete

`<zoom-connector-mule-4:account-plan-base-delete>`

[Cancel a base plan](https://docs.mulesoft.com/zoom-connector/latest/%3Chttps://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066687)>)
for a sub account. This API can only be used by master accounts that pay all billing charges of
their associated Pro or higher sub accounts. Zoom allows only
[approved partners](https://developers.zoom.us/docs/api/ma/) to use master APIs and manage sub
accounts' subscriptions. Email the partner programs team at **partner-success@zoom.us** for more
details. This operation makes an HTTP PATCH request to the /accounts/{accountId}/plans/base/status
endpoint.

- Prerequisites: The sub account must have a Pro or a higher plan.

- Scopes: `billing:master`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Account ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Account Plan Base Update

`<zoom-connector-mule-4:account-plan-base-update>`

Update a base plan of a sub account. This API can only be used by master accounts that pay all
billing charges of their associated Pro or higher subaccounts. Zoom allows only
[approved partners](https://developers.zoom.us/docs/api/ma/) to use master APIs and manage
subaccounts' subscriptions. Email the partner programs team at **partner-success@zoom.us** for more
details. This operation makes an HTTP PUT request to the /accounts/{accountId}/plans/base endpoint.

- Prerequisites: The subaccount must have a Pro or a higher plan.

- Scopes: `billing:master`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The account ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Account Plan Create

`<zoom-connector-mule-4:account-plan-create>`

Subscribe a sub account to a Zoom plan using your master account. This API can only be used by
master accounts that pay all billing charges of their associated Pro or higher sub accounts. Zoom
allows only [approved partners](https://developers.zoom.us/docs/api/ma/) to use master APIs and
manage sub accounts' subscriptions. Email the partner programs team at **partner-success@zoom.us**
for more details. This operation makes an HTTP POST request to the /accounts/{accountId}/plans
endpoint.

- Scopes: `billing:master`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The account ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>String</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Account Plans

`<zoom-connector-mule-4:account-plans>`

Get plan information of a sub account that is managed by a master account. This API can only be used
by master accounts that pay all billing charges of their associated Pro or higher sub accounts. Zoom
allows only [approved partners](https://developers.zoom.us/docs/api/ma/) to use master APIs and
manage sub accounts' billing information. Email the partner programs team at
**partner-success@zoom.us** for more details. This operation makes an HTTP GET request to the
/accounts/{accountId}/plans endpoint.

- Scopes: `billing:master`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The account ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Account Settings

`<zoom-connector-mule-4:account-settings>`

Use this API to get an account’s settings information. To get the settings of a master account, use
`me` as the value for the `accountId` path parameter. This operation makes an HTTP GET request to
the /accounts/{accountId}/settings endpoint.

- Prerequisites: The account must be a paid account.

- Scopes: `account:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The account ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>option</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>MEETING_AUTHENTICATION</p></li><li><p>RECORDING_AUTHENTICATION</p></li></ul></div></div></td><td><p>Use the following options to filter the results of the account’s information:</p><p>* <code>meeting_authentication</code></p><p>View the account’s <a href="https://support.zoom.com/hc/en/article?id=zm_kb&amp;sysparm_article=KB0061263">meeting authentication settings</a>.</p><p>* <code>recording_authentication</code></p><p>View the account’s <a href="https://support.zoom.com/hc/en/article?id=zm_kb&amp;sysparm_article=KB0067223">recording authentication settings</a>.</p><p>* <code>security</code></p><p>View the account’s security settings, for example, password requirements for user login or two-factor authentication.</p><p>* <code>meeting_security</code> ”</p><p>View the account’s meeting security settings.</p></td><td></td><td></td></tr><tr><td><p>Custom query fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the field by which to filter the response, for example, if you provide the <code>host_video</code> value for this field, you will get a response similar to the following: <code>{ "schedule_meeting": { "host_video": false } }</code>. To use multiple values, comma-separate each value, for example, <code>host_video,participant_video</code>.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Account Settings Update

`<zoom-connector-mule-4:account-settings-update>`

Update the settings of a sub account that is under a master account. To update the settings of the
master account, use `me` as the value of the `accountId` path parameter. This operation makes an
HTTP PATCH request to the /accounts/{accountId}/settings endpoint.

- Prerequisites: The sub account must be a paid account.

- Scopes: `account:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The account ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>option</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>MEETING_AUTHENTICATION</p></li><li><p>RECORDING_AUTHENTICATION</p></li><li><p>SECURITY</p></li><li><p>MEETING_SECURITY</p></li></ul></div></div></td><td><p>Use the following options to filter the results of the account’s information:</p><p>* <code>meeting_authentication</code></p><p>View the account’s <a href="https://support.zoom.com/hc/en/article?id=zm_kb&amp;sysparm_article=KB0061263">meeting authentication settings</a>.</p><p>* <code>recording_authentication</code></p><p>View the account’s <a href="https://support.zoom.com/hc/en/article?id=zm_kb&amp;sysparm_article=KB0067223">recording authentication settings</a>.</p><p>* <code>security</code></p><p>View the account’s security settings, for example, password requirements for user login or two-factor authentication.</p><p>* <code>meeting_security</code> ”</p><p>View the account’s meeting security settings.</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Account Trusted Domain

`<zoom-connector-mule-4:account-trusted-domain>`

Get trusted domains of a sub account. To get the trusted domains of a master account, use `me` as
the value for the `accountId` path parameter. This operation makes an HTTP GET request to the
/accounts/{accountId}/trusted\_domains endpoint.

- Prerequisites: The sub account must be a paid account.

- Scope: `account:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The account ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Accounts

`<zoom-connector-mule-4:accounts>`

List all the sub accounts that have been created by a master account. Zoom allows only
[approved partners](https://developers.zoom.us/docs/api/ma/) to use master APIs and manage sub
accounts. Email the partner programs team at **partner-success@zoom.us** for more details. This
operation makes an HTTP GET request to the /accounts endpoint.

- Prerequisites: Pro or a higher paid account with master account option enabled.

- Scope: `account:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Add Anumber To Blocked List

`<zoom-connector-mule-4:add-anumber-to-blocked-list>`

A Zoom account owner or a user with admin privilege can block phone numbers for phone users in an
account. Blocked numbers can be inbound (numbers will be blocked from calling in) and outbound
(phone users in your account won’t be able to dial those numbers). Blocked callers will hear a
generic message stating that the person they are calling is not available. Use this API to create a
blocked list and add a number to that blocked list. This operation makes an HTTP POST request to the
/phone/blocked\_list endpoint.

- Prerequisites: Pro or higher account plan with Zoom phone license.

- Scope: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Add A Room

`<zoom-connector-mule-4:add-aroom>`

Use this API to
[add a Zoom Room](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061644) to a
Zoom account. This operation makes an HTTP POST request to the /rooms endpoint.

- Prerequisites: Pro or a higher plan with Zoom Room license.

- Scopes: `room:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Add Auto Receptionist

`<zoom-connector-mule-4:add-auto-receptionist>`

Auto receptionists answer calls with a personalized recording and routes calls to a phone user, call
queue, common area phone, voicemail or an IVR system. Use this API to add an
[auto receptionist](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061421) to a
Zoom Phone. This operation makes an HTTP POST request to the /phone/auto\_receptionists endpoint.

- Prerequisites: Pro or higher account with Zoom Phone license.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Add Azr Location

`<zoom-connector-mule-4:add-azrlocation>`

Add a location to the
[location hierarchial structure(s)](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063345)
of Zoom Rooms in an account. This operation makes an HTTP POST request to the /rooms/locations
endpoint.

- Prerequisites: Account owner or admin permissions. Zoom Rooms Version 4.0 or higher.

- Scopes: `room:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Add Batch Registrants

`<zoom-connector-mule-4:add-batch-registrants>`

Register up to 30 registrants at once for a meeting that requires
[registration](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065026). This
operation makes an HTTP POST request to the /meetings/{meetingId}/batch\_registrants endpoint.

- Prerequisites: The meeting host must be a licensed user. The meeting must require registration and
  should be of type `2`, which means they should be scheduled meetings. Instant meetings and
  recurring meetings are not supported by this API.

- Scope: `meeting:write`, `meeting:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the meeting (Meeting Number).</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Add Batch Webinar Registrants

`<zoom-connector-mule-4:add-batch-webinar-registrants>`

Use this API to register up to 30 registrants at once for a scheduled webinar that requires
[registration](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061631). This
operation makes an HTTP POST request to the /webinars/{webinarId}/batch\_registrants endpoint.

- Prerequisites: The webinar host must be a Licensed user. The webinar should be of type `5`, which
  means it should be a scheduled webinar. Other types of webinars are not supported by this API.

- Scope: `webinar:write`, `webinar:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the webinar.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Add Byoc Number

`<zoom-connector-mule-4:add-byocnumber>`

Use this API to add BYOC (Bring Your Own Carrier) phone numbers to Zoom Phone. This operation makes
an HTTP POST request to the /phone/byoc\_numbers endpoint.

- Prerequisites: A Business or Enterprise plan. A Zoom Phone license.

- Scopes: `phone:write:admin`, `phone:write`, or `phone:master`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Add Callout Countries

`<zoom-connector-mule-4:add-callout-countries>`

Specify the list of
[call-out](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061683) countries for
a master account or a sub account. To add call-out enabled countries to a sub account, provide the
account ID of the sub account in the `accountId` path parameter. To add call-out enabled countries
to a master account, provide `me` as the value of the `accountId` path parameter. This operation
makes an HTTP POST request to the /accounts/{accountId}/sip\_trunk/callout\_countries endpoint.

- Prerequisites: The account making this API request must be a
  [master account](https://developers.zoom.us/docs/api/ma/) with SIP Connected Audio Plan.

- Scope: `sip_trunk:master`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the account. To add Call-out enabled countries to a sub account, provide the account ID of the sub account in the <code>accountId</code> path parameter. To add Call-out enabled countries to a master account, provide <code>me</code> as the value of the <code>accountId</code> path parameter.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Add Common Area Phone

`<zoom-connector-mule-4:add-common-area-phone>`

Use this API to
[add a common area phone](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066552).
A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an
organization can use it, for example, if your office has shared desks that don’t belong to a
specific employees, you could add a common area phone so that any person can use it. This operation
makes an HTTP POST request to the /phone/common\_area\_phones endpoint.

- Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin
  permissions. A
  [supported device](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060242).

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Add External Contact

`<zoom-connector-mule-4:add-external-contact>`

Use this API to add an external contact. This operation makes an HTTP POST request to the
/phone/external\_contacts endpoint.

- Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin
  permissions.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Add Internal Numbers

`<zoom-connector-mule-4:add-internal-numbers>`

This API allows a master account with a SIP Connected Audio plan to assign internal phone numbers,
such as for numbers that are not provided by Zoom but are owned by the organization consuming the
API, to a master account or a sub account. To add internal numbers to a sub account, provide the
account ID of the sub account in the `accountId` path parameter. To add internal numbers to a master
account, provide `me` as the value of the `accountId` path parameter. This operation makes an HTTP
POST request to the /accounts/{accountId}/sip\_trunk/internal\_numbers endpoint.

- Prerequisites: The account making this API request must be a
  [master account](https://developers.zoom.us/docs/api/ma/) with SIP Connected Audio Plan.

- Scope: `sip_trunk:master`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the account. To add internal numbers to a sub account, provide the account ID of the sub account in the <code>accountId</code> path parameter. To add internal numbers to a master account, provide <code>me</code> as the value of the <code>accountId</code> path parameter.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Add Location

`<zoom-connector-mule-4:add-location>`

Use this API to add an emergency service location. This operation makes an HTTP POST request to the
/phone/locations endpoint.

- Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin
  permissions.

- Scopes: `phone:write:adminRate`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Add Members To Call Queue

`<zoom-connector-mule-4:add-members-to-call-queue>`

Add phone users and/or
[common area phones](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066552) as
members to a specific Call Queue. This operation makes an HTTP POST request to the
/phone/call\_queues/{callQueueId}/members endpoint.

- Prerequisites: Pro or higher account plan. Zoom Phone license.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Call Queue Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the call queue.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Add Members To Shared Line Group

`<zoom-connector-mule-4:add-members-to-shared-line-group>`

A [shared line group](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066509)
allows Zoom Phone admins to share a phone number and extension with a group of phone users or common
area phones. This gives members of the shared line group access to the group’s direct phone number
and voicemail. Use this API to
[add members](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066509-Setting-up-shared-line-groups#h_7cb42370-48f6-4a8f-84f4-c6eee4d9f0ca)
to a Shared Line Group. Note that a member can only be added to one shared line group. This
operation makes an HTTP POST request to the /phone/shared\_line\_groups/{sharedLineGroupId}/members
endpoint.

- Prerequisites: Pro or higher account with Zoom Phone license. A valid Shared Line Group. Account
  owner or admin privileges.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Shared Line Group Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the shared line group.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Add Phone Device

`<zoom-connector-mule-4:add-phone-device>`

By default, all Zoom Phone users can make and receive calls using the Zoom desktop and mobile
applications. Additionally, if a desk phone is required, use this API to
[add a desk phone and assign it](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061431)
to a user. This operation makes an HTTP POST request to the /phone/devices endpoint.

- Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin
  permissions. A
  [supported device](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060242).

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Add Role Members

`<zoom-connector-mule-4:add-role-members>`

User [roles](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983) can have a
set of permissions that allows access only to the pages a user needs to view or edit. Use this API
to
[assign a role](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983#h_748b6fd8-5057-4cf4-bbfd-787909c09db0)
to members. This operation makes an HTTP POST request to the /roles/{roleId}/members endpoint.

- Prerequisites: A Pro or a higher plan.

- Scopes: `role:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Role Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The role ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Add Setting Template

`<zoom-connector-mule-4:add-setting-template>`

Use this API to create a Zoom Phone setting template for an account. After creating a phone
template, the defined settings will become the default settings for an account. This operation makes
an HTTP POST request to the /phone/setting\_templates endpoint.

- Prerequisites: A Business or enterprise Zoom account. A Zoom Phone license.

- Scopes: `phone:write:admin`, `phone:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Add User Setting

`<zoom-connector-mule-4:add-user-setting>`

Use this API to define the voicemail access permissions of a user. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. Phone users can access
[shared voicemail inboxes](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0069406)
in the Zoom desktop client, web portal, or provisioned desk phone. To view these settings in the
Zoom web portal, navigate to the **Admin Phone System Management and Users Rooms interface. Click
the Users tab and select \*User Settings**. Scroll down to **Voicemail Call Recordings**. This
operation makes an HTTP POST request to the /phone/users/{userId}/settings/{settingType} endpoint.

- Prerequisites: A Business or Enterprise account.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the user.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Setting Type</p></td><td><div><div><p>String</p></div></div></td><td><p>Corresponds to the setting item you wish to modify. Allowed values: <code>voice_mail</code>.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Assign Calling Plan

`<zoom-connector-mule-4:assign-calling-plan>`

Use this API to assign a
[calling plan](https://developers.zoom.us/docs/api/references/billing-plans/#zoom-phone-calling-plans)
to a
[Zoom phone](https://support.zoom.com/hc/en/category?id=kb_category&kb_category=5b8432168720391089a37408dabb35b0)
user. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. This operation makes an HTTP POST request to the
/phone/users/{userId}/calling\_plans endpoint.

- Prerequisites: A Business or Enterprise account. A Zoom Phone license.

- Scopes: `phone:write`, `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>User ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Assign Calling Plans To Common Area Phone

`<zoom-connector-mule-4:assign-calling-plans-to-common-area-phone>`

Assign calling plans to common area phone. This operation makes an HTTP POST request to the
/phone/common\_area\_phones/{commonAreaPhoneId}/calling\_plans endpoint.

- Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin
  permissions.

- Scope: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Assign Phone Number

`<zoom-connector-mule-4:assign-phone-number>`

Use this API to assign a
[phone number](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060212) to a user
who has already enabled Zoom Phone. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. This operation makes an HTTP POST request to the
/phone/users/{userId}/phone\_numbers endpoint.

- Prerequisites: A Business or Enterprise account. A Zoom Phone license.

- Scopes: `phone:write`, `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>User ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Assign Phone Numbers Auto Receptionist

`<zoom-connector-mule-4:assign-phone-numbers-auto-receptionist>`

Assign available phone numbers to an
[auto receptionist](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061421). The
available numbers can be retrieved using the List Phone Numbers API with `type` query parameter set
to "unassigned". This operation makes an HTTP POST request to the
/phone/auto\_receptionists/{autoReceptionistId}/phone\_numbers endpoint.

- Prerequisites: Pro or higher account plan with Zoom Phone License. Account owner or admin
  permissions.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Auto Receptionist Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the Auto Receptionist. It can be retrieved from the [List Sites API](https://docs.mulesoft.com/zoom-connector/latest/%3Ca href="https://developers.zoom.us/docs/api/phone/#tag/sites/GET/phone/sites">https://developers.zoom.us/docs/api/phone/#tag/sites/GET/phone/sites</a>).</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Assign Phone Numbers Slg

`<zoom-connector-mule-4:assign-phone-numbers-slg>`

Use this API to assign phone numbers to a shared line groups. These direct phone numbers will be
shared among members of the
[shared line group](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066509-Setting-up-shared-line-groups).
This operation makes an HTTP POST request to the
/phone/shared\_line\_groups/{sharedLineGroupId}/phone\_numbers endpoint.

- Prerequisites: Pro or higher account with Zoom Phone license. A valid Shared Line Group. Account
  owner or admin privileges

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Shared Line Group Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the shared line group.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Assign Phone Numbers To Common Area Phone

`<zoom-connector-mule-4:assign-phone-numbers-to-common-area-phone>`

Assign phone numbers to common area phone. This operation makes an HTTP POST request to the
/phone/common\_area\_phones/{commonAreaPhoneId}/phone\_numbers endpoint.

- Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin
  permissions.

- Scope: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Assign Phone To Call Queue

`<zoom-connector-mule-4:assign-phone-to-call-queue>`

After
[buying phone numbers](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060212),
you can assign them, allowing callers to directly dial a number to reach a
[call queue](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064844). This
operation makes an HTTP POST request to the /phone/call\_queues/{callQueueId}/phone\_numbers
endpoint.

- Prerequisites: Pro or higher account plan. Account owner or admin permissions. Zoom Phone license.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Call Queue Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the call queue.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Assign Sip Trunk Numbers

`<zoom-connector-mule-4:assign-sip-trunk-numbers>`

With SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed
to make and deliver phone calls) over a direct and private connection between the customer’s network
and the Zoom cloud. Meeting participants that dial into a meeting or have the meeting call them, and
are On-Net from the perspective of the customer’s IP telephony network, will be connected over this
trunk rather than over the PSTN. Use this API to assign internal numbers to a sub account. This
operation makes an HTTP POST request to the /accounts/{accountId}/sip\_trunk/numbers endpoint.

- Prerequisites: Pro or a higher account with SIP Connected Audio plan enabled. The account must be
  a master account.

- Scopes: `sip_trunk:master`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the sub account.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Assign Sip Config

`<zoom-connector-mule-4:assign-sipconfig>`

Use this API to copy the Session Initiation Protocol (SIP) Connected Audio configurations applied on
the Master account and enable or disable those configurations on a subaccount. With SIP-connected
audio, Zoom establishes a [SIP trunk](https://en.wikipedia.org/wiki/SIP_trunking) (a network
connection specifically designed to make and deliver phone calls) over a direct and private
connection between the customer’s network and the Zoom cloud. Meeting participants that dial into a
meeting or have the meeting call them, and are On-Net from the perspective of the customers' IP
telephony network, will be connected over this trunk rather than over the PSTN. This operation makes
an HTTP PATCH request to the /accounts/{accountId}/sip\_trunk/settings endpoint.

- Prerequisites: Pro or a higher account with SIP Connected Audio plan enabled. A Master account
  owner.

- Scopes: `sip_trunk:master`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Account ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Assign Sip Trunks

`<zoom-connector-mule-4:assign-siptrunks>`

With SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed
to make and deliver phone calls) over a direct and private connection between the customer’s network
and the Zoom cloud. Meeting participants that dial into a meeting or have the meeting call them, and
are On-Net from the perspective of the customer’s IP telephony network, will be connected over this
trunk rather than over the PSTN. Use this API to assign SIP trunk(s) that are available on a master
account to a sub account. This operation makes an HTTP POST request to the
/accounts/{accountId}/sip\_trunk/trunks endpoint.

- Prerequisites: The account making this API request must be a master account with an
  [API Partner Plan](https://explore.zoom.us/docs/en-us/plan/api.html) and SIP Connected Audio Plan.

- Scope: `sip_trunk:master`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the sub account.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Batch Add Locations

`<zoom-connector-mule-4:batch-add-locations>`

Use this API to batch add emergency service locations. This operation makes an HTTP POST request to
the /phone/batch\_locations endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Change Call Queue Manager

`<zoom-connector-mule-4:change-call-queue-manager>`

A call queue manager has the privileges to manage the call queue’s voicemail inbox and recordings,
and change all call queue settings and call queue policy settings. Use this API to set another phone
user as the
[call queue manager](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064844#h_db06854b-e6a3-4afe-ba15-baf58f31f90c).
This operation makes an HTTP PUT request to the /phone/call\_queues/{callQueueId}/manager endpoint.

- Prerequisites: Pro or higher account plan. Account owner or admin permissions. Zoom Phone license.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Call Queue Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the call queue.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Change Main Company Number

`<zoom-connector-mule-4:change-main-company-number>`

Use this API to
[change an account’s main company number](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064090).
External users can use the
[main company number](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064090) to
reach your Zoom Phone users by dialing the main company number and the user’s extension. It can also
be used by your account’s Zoom Phone users as their caller ID when making calls. This operation
makes an HTTP PUT request to the /phone/company\_number endpoint.

- Prerequisites: A Pro or higher account plan. Account owner or admin permissions.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Change Parent Location

`<zoom-connector-mule-4:change-parent-location>`

An account owner of a Zoom account can establish a
[Zoom Rooms Location Hierarchy](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063345)
to better organize Zoom Rooms spread accross various location. The location can be structured in a
hierarchy with Country being the top-level location, followed by city, campus, building, and floor.
The location in the lower level in the hierarchy is considered as a child of the location that is a
level above in the hierarchy. Use this API to change the parent location of a child location. For
instance, if the location hierarchy is structured in a way where there are two campuses (Campus 1,
and Campus 2) in a City and Campus 1 consists of a building named Building 1 with a floor where Zoom
Rooms are located, and you would like to rearrange the structure so that Building 1 along with its
child locations (floor and Zoom Rooms) are relocated directly under Campus 2 instead of Campus 1,
you must provide the location ID of Building 1 in the path parameter of this request and the
location ID of Campus 2 as the value of `parent_location_id` in the request body. This operation
makes an HTTP PUT request to the /rooms/locations/{locationId}/location endpoint.

- Prerequisites: Account owner or admin permission. Zoom Rooms version 4.0 or higher.

- Scopes: `room:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Location Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Location Id</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Change Zoom Rooms App Version

`<zoom-connector-mule-4:change-zoom-rooms-app-version>`

[Upgrade](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060443) or
[downgrade](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060443) the version
of Zoom Rooms App installed on your Mac or Windows device. This operation makes an HTTP PUT request
to the /rooms/{roomId}/devices/{deviceId}/app\_version endpoint.

- Prerequisites: Pro or a higher account with Zoom Rooms. Zoom Rooms software must be installed
  either on a Mac or a Windows device. This API does not support other devices.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Room Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the Zoom Room.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Device Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the Mac or the Windows device. The value of this field can be retrieved from the [List Zoom Room Devices API](https://docs.mulesoft.com/zoom-connector/latest/%3Ca href="https://developers.zoom.us/docs/api/rooms/#tag/zoom-rooms/GET/rooms/{roomId}/devices">https://developers.zoom.us/docs/api/rooms/#tag/zoom-rooms/GET/rooms/{roomId}/devices</a>).</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Change Zr Location

`<zoom-connector-mule-4:change-zrlocation>`

An account owner of a Zoom account can establish a
[Zoom Rooms Location Hierarchy](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063345)
to better organize Zoom Rooms spread accress various location. The location can be structured in a
hierarchy with Country being the top-level location, followed by city, campus, building, and floor.
Use this API to assign a new location for a Zoom Room. Note that the Zoom Room can be assigned only
to the lowest level location available in the hierarchy. This operation makes an HTTP PUT request to
the /rooms/{roomId}/location endpoint.

- Prerequisites: Account owner or admin permission. Zoom Rooms version 4.0 or higher.

- Scopes: `room:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Room Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the Zoom Room.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Check In Rooms

`<zoom-connector-mule-4:check-in-rooms>`

The Zoom Rooms check-in feature helps maximize your room utilization. Use this API to either check
in and confirm that you are utilizing the room reservation or to check out of the room so that the
room gets released from the scheduled meeting and will be made available for others to use. Learn
more from the
[Using the Zoom Rooms check-in feature](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061441)
guide. This operation makes an HTTP PATCH request to the /rooms/{id}/events endpoint.

- Prerequisites:
  [Zoom Rooms](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063391) must have
  been set up for use for the account and must be online. You must have access to the Calendar
  Integration APIs (either Microsoft Exchange or Google Calendar APIs) to get calendar information
  associated with the room.

- Scope: `room:write:admin`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Room ID</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Create A Shared Line Group

`<zoom-connector-mule-4:create-ashared-line-group>`

A [shared line group](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066509)
allows Zoom Phone admins to share a phone number and extension with a group of phone users or common
area phones. This gives members of the shared line group access to the group’s direct phone number
and voicemail. Use this API to create a shared line group. This operation makes an HTTP POST request
to the /phone/shared\_line\_groups endpoint.

- Prerequisites: Pro or higher account with Zoom Phone license. Account owner or admin privileges.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Create Batch Polls

`<zoom-connector-mule-4:create-batch-polls>`

Polls allow the meeting host to survey attendees. Use this API to create batch
[polls](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066150) for a meeting.
This operation makes an HTTP POST request to the /meetings/{meetingId}/batch\_polls endpoint.

- Prerequisites: Host user type must be a Pro or higher plan. Polling feature must be enabled in the
  host’s account. Meeting must be a scheduled meeting. Instant meetings do not have polling features
  enabled.

- Scopes: `meeting:write:admin` `meeting:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Meeting Id</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Create Call Queue

`<zoom-connector-mule-4:create-call-queue>`

Call queues allow you to route incoming calls to a group of users. For instance, you can use call
queues to route calls to various departments in your organization such as sales, engineering,
billing, customer service etc. Use this API to
[create a call queue](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064844#h_e81faeeb-9184-429a-aaea-df49ff5ff413).
You can add phone users or common area phones to call queues. This operation makes an HTTP POST
request to the /phone/call\_queues endpoint.

- Prerequisites: Pro, Business, or Education account. Account owner or admin permissions. Zoom Phone
  license.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Create Channel

`<zoom-connector-mule-4:create-channel>`

Use this API to create a channel for a user. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. Zoom chat channels allow users to communicate via chat in private or public
groups. This operation makes an HTTP POST request to the /chat/users/{userId}/channels endpoint.

- Scopes: `chat_channel:write` or `chat_channel:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

Note that this API supports both user-managed apps and account-level apps. However, in an
account-level [OAuth app](https://developers.zoom.us/docs/integrations/create/), to create a channel
on behalf of another user in the same Zoom account, the user calling this API must have a
[role](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit)
that has the Edit permission for the Chat channels feature.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the user.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Create Phone Site

`<zoom-connector-mule-4:create-phone-site>`

Sites enable you to organize Zoom Phone users in your organization. Use this API to create a
[site](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0069716). This operation
makes an HTTP POST request to the /phone/sites endpoint.

- Prerequisites: Multiple Sites must be
  [enabled](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0069716-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15).
  Pro or a higher account with Zoom Phone enabled.

- Scope: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Create Role

`<zoom-connector-mule-4:create-role>`

Each Zoom user automatically has a role which can either be owner, administrator, or a member. This
operation makes an HTTP POST request to the /roles endpoint.

- Prerequisites: Pro or higher plan. For setting the initial role, you must be the Account Owner.
  For subsequent role management, you must be the Account Owner or user with role management
  permissions.

- Scopes: `role:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Create Sip Phone

`<zoom-connector-mule-4:create-sipphone>`

Zoom’s Phone System Integration (PSI), also referred as SIP phones, enables an organization to
leverage the Zoom client to complete a softphone registration to supported premise based PBX system.
End users will have the ability to have softphone functionality within a single client while
maintaining a comparable interface to Zoom Phone. Use this API to enable a user to use SIP phone.
This operation makes an HTTP POST request to the /sip\_phones endpoint.

- Prerequisites: Currently only supported on Cisco and Avaya PBX systems. The account owner or
  account admin must first enable SIP Phone Integration by contacting the Zoom Sales team.

- Scope: `sip_phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Dashboard Chat

`<zoom-connector-mule-4:dashboard-chat>`

Get [metrics](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061622) for how
users are utilizing Zoom Chat to send messages. Use the `from` and `to` query parameters to specify
a monthly date range for the dashboard data. The monthly date range must be within the last six
months. Note that to query chat metrics from July 1, 2021 and later, use this endpoint instead of
the [Get IM metrics API](https://developers.zoom.us/docs/api/). This operation makes an HTTP GET
request to the /metrics/chat endpoint.

- Prerequisites: Business or a higher plan.

- Scope: `dashboard_im:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Resource-intensive`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>from</p></td><td><div><div><p>String</p></div></div></td><td><p>Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>to</p></td><td><div><div><p>String</p></div></div></td><td><p>End date.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Dashboard Client Feedback

`<zoom-connector-mule-4:dashboard-client-feedback>`

Retrieve survey results from
[Zoom meetings client feedback](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067520).
You can specify a monthly date range for the dashboard data using the `from` and `to` query
parameters. The month should fall within the last six months. This operation makes an HTTP GET
request to the /metrics/client/feedback endpoint.

- Prerequisites: Business or higher account.
  [Feedback to Zoom](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0068808)
  enabled.

- Scope: `account:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>from</p></td><td><div><div><p>String</p></div></div></td><td><p>Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>to</p></td><td><div><div><p>String</p></div></div></td><td><p>End date.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Dashboard Client Feedback Detail

`<zoom-connector-mule-4:dashboard-client-feedback-detail>`

Retrieve detailed information on a
[Zoom meetings client feedback](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067520).
You can specify a monthly date range for the dashboard data using the `from` and `to` query
parameters. The month should fall within the last six months. This operation makes an HTTP GET
request to the /metrics/client/feedback/{feedbackId} endpoint.

- Prerequisites: Business or higher account.
  [Feedback to Zoom](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0068808)
  enabled.

- Scope: `dashboard_home:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Feedback Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Feedback Detail ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>from</p></td><td><div><div><p>String</p></div></div></td><td><p>Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.</p></td><td></td><td></td></tr><tr><td><p>to</p></td><td><div><div><p>String</p></div></div></td><td><p>End date.</p></td><td></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Page size.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Dashboard Crc

`<zoom-connector-mule-4:dashboard-crc>`

A Cloud Room Connector allows H.323/SIP endpoints to connect to a Zoom meeting. Use this API to get
the hour by hour CRC Port usage for a specified period of time. We will provide the report for a
maximum of one month. For example, if "from" is set to "2017-08-05" and "to" is set to "2017-10-10",
we will adjust "from" to "2017-09-10". This operation makes an HTTP GET request to the /metrics/crc
endpoint.

- Prerequisites: Business, Education, or API Plan. Room Connector must be enabled on the account.

- Scopes: `dashboard_crc:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>from</p></td><td><div><div><p>String</p></div></div></td><td><p>Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>to</p></td><td><div><div><p>String</p></div></div></td><td><p>End date.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Dashboard Im

`<zoom-connector-mule-4:dashboard-im>`

Get [metrics](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061622) on how
users are utilizing the Zoom Chat client. You can specify a monthly date range for the dashboard
data using the `from` and `to` query parameters. The month should fall within the last six months.
Deprecated: We will completely deprecate this endpoint in a future release. You can continue using
this endpoint to query data for messages sent before July 1, 2021. To get metrics on chat messages
sent on and after July 1, 2021, use the
[Get chat metrics API](https://developers.zoom.us/docs/api/). This operation makes an HTTP GET
request to the /metrics/im endpoint.

- Prerequisites: Business or a higher plan.

- Scopes: `dashboard_im:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Resource-intensive`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>from</p></td><td><div><div><p>String</p></div></div></td><td><p>Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>to</p></td><td><div><div><p>String</p></div></div></td><td><p>End date.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Dashboard Issue Detail Zoom Room

`<zoom-connector-mule-4:dashboard-issue-detail-zoom-room>`

Get information about the issues that occurred on the Top 25 Zoom Rooms with issues in an account.
You can specify a monthly date range for the dashboard data using the `from` and `to` query
parameters. The month should fall within the last six months. This operation makes an HTTP GET
request to the /metrics/issues/zoomrooms/{zoomroomId} endpoint.

- Prerequisites: Business or a higher plan. Zoom Room must be enabled in the account.

- Scope: `dashboard_home:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Zoomroom Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The Zoom room ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>from</p></td><td><div><div><p>String</p></div></div></td><td><p>Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>to</p></td><td><div><div><p>String</p></div></div></td><td><p>End date.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Dashboard Issue Zoom Room

`<zoom-connector-mule-4:dashboard-issue-zoom-room>`

Get information on top 25 Zoom Rooms with issues in a month. The month specified with the "from" and
"to" range should fall within the last six months. This operation makes an HTTP GET request to the
/metrics/issues/zoomrooms endpoint.

- Prerequisites: Business or a higher plan. Zoom Room must be enabled in the account.

- Scope: `dashboard_home:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>from</p></td><td><div><div><p>String</p></div></div></td><td><p>Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>to</p></td><td><div><div><p>String</p></div></div></td><td><p>End date.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Dashboard Meeting Detail

`<zoom-connector-mule-4:dashboard-meeting-detail>`

Get details on live or past meetings. This overview will show if features such as audio, video,
screen sharing, and recording were being used in the meeting. You can also see the license types of
each user on your account. You can specify a monthly date range for the dashboard data using the
`from` and `to` query parameters. The month should fall within the last six months. This operation
makes an HTTP GET request to the /metrics/meetings/{meetingId} endpoint.

- Prerequisites: Business or a higher plan.

- Scopes: `dashboard_meetings:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The meeting ID or the meeting UUID. If a meeting ID is provided in the request instead of a UUID, the response will be for the latest meeting instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must double encode the UUID before making an API request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>PAST</p></li><li><p>PAST_ONE</p></li><li><p>LIVE</p></li></ul></div></div></td><td><p>The meeting types: <code>past</code> - Past meetings. <code>pastOne</code> - Past one user meetings. <code>live</code> - Live meetings.</p></td><td><p>LIVE</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Dashboard Meeting Participant Qos

`<zoom-connector-mule-4:dashboard-meeting-participant-qos>`

Use this API to retrieve the quality of service (QoS) for participants from live or past meetings.
The data returned indicates the connection quality for sending or receiving video, audio, and shared
content. The API returns this data for either the API request or when the API request was last
received. This API will not return data if there is no data being sent or received at the time of
request. Note that when the sender sends its data, a timestamp is attached to the sender’s data
packet. The receiver then returns this timestamp to the sender. This helps determine the upstream
and downstream latency, which includes the application processing time. The latency data returned is
the five second average and five second maximum. This operation makes an HTTP GET request to the
/metrics/meetings/{meetingId}/participants/{participantId}/qos endpoint.

- Scopes: `dashboard_meetings:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The meeting ID or the meeting UUID. If a meeting ID is provided in the request instead of a UUID, the response will be for the latest meeting instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must double encode the UUID before making an API request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Participant Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Participant ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>PAST</p></li><li><p>PAST_ONE</p></li><li><p>LIVE</p></li></ul></div></div></td><td><p>The meeting types: <code>past</code> - Past meetings. <code>live</code> - Live Meetings.</p></td><td><p>LIVE</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Dashboard Meeting Participant Share

`<zoom-connector-mule-4:dashboard-meeting-participant-share>`

Retrieve the sharing and recording details of participants from live or past meetings. This
operation makes an HTTP GET request to the /metrics/meetings/{meetingId}/participants/sharing
endpoint.

- Prerequisites: Business or a higher plan.

- Scopes: `dashboard_meetings:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The meeting ID or the meeting UUID. If a meeting ID is provided in the request instead of a UUID, the response will be for the latest meeting instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must double encode the UUID before making an API request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>PAST</p></li><li><p>PAST_ONE</p></li><li><p>LIVE</p></li></ul></div></div></td><td><p>The meeting types: <code>past</code> - Past meetings. <code>live</code> - Live Meetings.</p></td><td><p>LIVE</p></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Dashboard Meeting Participants

`<zoom-connector-mule-4:dashboard-meeting-participants>`

Get a list of participants from live or past meetings. If you do not provide the `type` query
parameter, the default value will be set to `live` and thus, you will only see metrics for
participants in a live meeting, if any meeting is currently being conducted. To view metrics on past
meeting participants, provide the appropriate value for `type`. You can specify a monthly date range
for the dashboard data using the `from` and `to` query parameters. The month should fall within the
last six months. This operation makes an HTTP GET request to the
/metrics/meetings/{meetingId}/participants endpoint.

- Prerequisites: Business or a higher plan.

- Scopes: `dashboard_meetings:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The meeting ID or the meeting UUID. If a meeting ID is provided in the request instead of a UUID, the response will be for the latest meeting instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must double encode the UUID before making an API request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>PAST</p></li><li><p>PAST_ONE</p></li><li><p>LIVE</p></li></ul></div></div></td><td><p>The meeting types: <code>past</code> - Past meetings. <code>pastOne</code> - Past one user meetings. <code>live</code> - Live meetings.</p></td><td><p>LIVE</p></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Include fields</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>REGISTRANT_ID</p></li></ul></div></div></td><td><p>Provide <code>registrant_id</code> as the value for this field if you would like to see the registrant ID attribute in the response of this API call. A registrant ID is a unique identifier of a <a href="https://developers.zoom.us/docs/api/meetings/">meeting registrant</a>. This is not supported for <code>live</code> meeting types.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Dashboard Meeting Participants Qos

`<zoom-connector-mule-4:dashboard-meeting-participants-qos>`

Get a list of meeting participants from live or past meetings along with the quality of service they
receive during the meeting such as connection quality for sending or receiving video, audio, and
shared content. If you do not provide the `type` query parameter, the default value will be set to
`live` and thus, you will only see metrics for participants in a live meeting, if any meeting is
currently being conducted. To view metrics on past meeting participants, provide the appropriate
value for `type`. You can specify a monthly date range for the dashboard data using the `from` and
`to` query parameters. The month should fall within the last six months. This operation makes an
HTTP GET request to the /metrics/meetings/{meetingId}/participants/qos endpoint.

- Prerequisites: Business or a higher plan.

- Scopes: `dashboard_meetings:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The meeting ID or the meeting UUID. If a meeting ID is provided in the request instead of a UUID, the response will be for the latest meeting instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must double encode the UUID before making an API request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>PAST</p></li><li><p>PAST_ONE</p></li><li><p>LIVE</p></li></ul></div></div></td><td><p>The meeting types: <code>past</code> - Past meetings. <code>live</code> - Live Meetings.</p></td><td><p>LIVE</p></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>The number of items returned per page.</p></td><td><p>1</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Dashboard Meetings

`<zoom-connector-mule-4:dashboard-meetings>`

List total live or past meetings that occurred during a specified period of time. This overview will
show if features such as audio, video, screen sharing, and recording were being used in the meeting.
You can also see the license types of each user on your account. You can specify a monthly date
range for the dashboard data using the `from` and `to` query parameters. The month should fall
within the last six months. This operation makes an HTTP GET request to the /metrics/meetings
endpoint.

- Prerequisites: Business or a higher plan.

- Scopes: `dashboard_meetings:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Resource-intensive`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>PAST</p></li><li><p>PAST_ONE</p></li><li><p>LIVE</p></li></ul></div></div></td><td><p>Specify a value to get the response for the corresponding meeting type. The value of this field can be one of the following: <code>past</code> - Meeting that already occurred in the specified date range. <code>pastOne</code> - Past meetings that were attended by only one user. <code>live</code> - Live meetings. If you do not provide this field, the default value will be <code>live</code> and thus, the API will only query responses for live meetings.</p></td><td><p>LIVE</p></td><td></td></tr><tr><td><p>from</p></td><td><div><div><p>String</p></div></div></td><td><p>Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>to</p></td><td><div><div><p>String</p></div></div></td><td><p>End date.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Include fields</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>TRACKING_FIELDS</p></li></ul></div></div></td><td><p>Set the value of this field to "tracking_fields" if you would like to include tracking fields of each meeting in the response.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Dashboard Webinar Detail

`<zoom-connector-mule-4:dashboard-webinar-detail>`

Retrieve details from live or past webinars. This operation makes an HTTP GET request to the
/metrics/webinars/{webinarId} endpoint.

- Prerequisites: Business, Education, or API Plan with Webinar add-on.

- Scopes: `dashboard_webinars:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a UUID, the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must double encode the UUID before making an API request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>PAST</p></li><li><p>LIVE</p></li></ul></div></div></td><td><p>The webinar type.</p></td><td><p>LIVE</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Dashboard Webinar Participant Qos

`<zoom-connector-mule-4:dashboard-webinar-participant-qos>`

Retrieve details on the quality of service that participants from live or past webinars received.
This data indicates the connection quality for sending or receiving video, audio, and shared
content. If nothing is being sent or received at that time, no information will be shown in the
fields. This operation makes an HTTP GET request to the
/metrics/webinars/{webinarId}/participants/{participantId}/qos endpoint.

- Prerequisites: Business, Education, or API Plan with Zoom Rooms set up.

- Scopes: `dashboard_webinars:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a UUID, the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must double encode the UUID before making an API request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Participant Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Participant ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>PAST</p></li><li><p>LIVE</p></li></ul></div></div></td><td><p>The webinar type.</p></td><td><p>LIVE</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Dashboard Webinar Participant Share

`<zoom-connector-mule-4:dashboard-webinar-participant-share>`

Retrieve the sharing and recording details of participants from live or past webinars. This
operation makes an HTTP GET request to the /metrics/webinars/{webinarId}/participants/sharing
endpoint.

- Prerequisites: Business, Education, or API Plan with Webinar add-on.

- Scopes: `dashboard_webinars:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a UUID, the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must double encode the UUID before making an API request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>PAST</p></li><li><p>LIVE</p></li></ul></div></div></td><td><p>The webinar type.</p></td><td><p>LIVE</p></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Dashboard Webinar Participants

`<zoom-connector-mule-4:dashboard-webinar-participants>`

Retrieve details on participants from live or past webinars. This operation makes an HTTP GET
request to the /metrics/webinars/{webinarId}/participants endpoint.

- Prerequisites: Business, Education, or API Plan with Webinar add-on.

- Scopes: `dashboard_webinars:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a UUID, the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must double encode the UUID before making an API request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>PAST</p></li><li><p>LIVE</p></li></ul></div></div></td><td><p>The webinar type.</p></td><td><p>LIVE</p></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Include fields</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>REGISTRANT_ID</p></li></ul></div></div></td><td><p>Provide 'registrant_id' as the value for this field if you would like to see the registrant ID attribute in the response of this API call. A registrant ID is a unique identifier of a <a href="https://developers.zoom.us/docs/api/">webinar registrant</a>.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Dashboard Webinar Participants Qos

`<zoom-connector-mule-4:dashboard-webinar-participants-qos>`

Retrieve a list of participants from live or past webinars and the quality of service they received.
This data indicates the connection quality for sending or receiving video, audio, and shared
content. If nothing is being sent or received at that time, no information will be shown in the
fields. This operation makes an HTTP GET request to the
/metrics/webinars/{webinarId}/participants/qos endpoint.

- Prerequisites: Business, Education, or API Plan with Webinar add-on.

- Scopes: `dashboard_webinars:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a UUID, the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must double encode the UUID before making an API request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>PAST</p></li><li><p>LIVE</p></li></ul></div></div></td><td><p>The webinar type.</p></td><td><p>LIVE</p></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>The number of items returned per page.</p></td><td><p>1</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Dashboard Webinars

`<zoom-connector-mule-4:dashboard-webinars>`

List all the live or past webinars from a specified period of time. This operation makes an HTTP GET
request to the /metrics/webinars endpoint.

- Prerequisites: Business, Education, or API Plan with Webinar add-on.

- Scopes: `dashboard_webinars:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Resource-intensive`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>PAST</p></li><li><p>LIVE</p></li></ul></div></div></td><td><p>The webinar type.</p></td><td><p>LIVE</p></td><td></td></tr><tr><td><p>from</p></td><td><div><div><p>String</p></div></div></td><td><p>Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>to</p></td><td><div><div><p>String</p></div></div></td><td><p>End date.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Dashboard Zoom Room

`<zoom-connector-mule-4:dashboard-zoom-room>`

The Zoom Rooms dashboard metrics lets you know the type of configuration a Zoom room has and details
on the meetings held in that room. Use this API to retrieve information on a specific room. This
operation makes an HTTP GET request to the /metrics/zoomrooms/{zoomroomId} endpoint.

- Prerequisites: Business, Education, or API Plan with Zoom Rooms set up.

- Scopes: `dashboard_zr:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Zoomroom Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The Zoom room ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>from</p></td><td><div><div><p>String</p></div></div></td><td><p>Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>to</p></td><td><div><div><p>String</p></div></div></td><td><p>End date.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Dashboard Zoom Room Issue

`<zoom-connector-mule-4:dashboard-zoom-room-issue>`

Get the top 25 issues of Zoom Rooms. This operation makes an HTTP GET request to the
/metrics/zoomrooms/issues endpoint.

- Prerequisites: Business, Education, or API Plan with Zoom Rooms set up.

- Scopes: `dashboard_zr:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>from</p></td><td><div><div><p>String</p></div></div></td><td><p>Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>to</p></td><td><div><div><p>String</p></div></div></td><td><p>End date.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Dashboard Zoom Rooms

`<zoom-connector-mule-4:dashboard-zoom-rooms>`

List information on all Zoom Rooms in an account. This operation makes an HTTP GET request to the
/metrics/zoomrooms endpoint.

- Prerequisites: Business, Education, or API Plan with Zoom Rooms set up.

- Scopes: `dashboard_zr:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Resource-intensive`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Del Group Vb

`<zoom-connector-mule-4:del-group-vb>`

Delete existing virtual background file(s) from an account. This operation makes an HTTP DELETE
request to the /groups/{groupId}/settings/virtual\_backgrounds endpoint.

- Prerequisites: Virtual background feature must be
  [enabled](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060387) on the
  account.

- Scope: `group:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Group Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the group. Retrieve the value for this field by calling the [List groups](https://docs.mulesoft.com/zoom-connector/latest/%3Ca href="https://developers.zoom.us/docs/api/">https://developers.zoom.us/docs/api/</a>) API.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>File ids</p></td><td><div><div><p>String</p></div></div></td><td><p>Provide the ID of the file that is to be deleted. To delete multiple files, provide comma-separated values for this field.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Del User Vb

`<zoom-connector-mule-4:del-user-vb>`

Delete existing virtual background file(s) of a user. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. This operation makes an HTTP DELETE request to the
/users/{userId}/settings/virtual\_backgrounds endpoint.

- Prerequisites: Virtual background feature must be
  [enabled](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060387) on the
  account.

- Scopes: `user:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the user. Retrieve the value of this field by calling the <a href="https://developers.zoom.us/docs/api/">List users</a> API.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>File ids</p></td><td><div><div><p>String</p></div></div></td><td><p>Provide the ID of the file that is to be deleted. To delete multiple files, provide comma-separated values for this field.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Del Vb

`<zoom-connector-mule-4:del-vb>`

Delete existing virtual background file(s) from an account. This operation makes an HTTP DELETE
request to the /accounts/{accountId}/settings/virtual\_backgrounds endpoint.

- Prerequisites: Virtual background feature must be
  [enabled](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060387) on the
  account.

- Scope: `account:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Account ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>File ids</p></td><td><div><div><p>String</p></div></div></td><td><p>Provide the ID of the file that is to be deleted. To delete multiple files, provide comma-separated values for this field.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Delete A Blocked List

`<zoom-connector-mule-4:delete-ablocked-list>`

A Zoom account owner or a user with admin privilege can block phone numbers for phone users in an
account. Blocked numbers can be inbound (numbers will be blocked from calling in) and outbound
(phone users in your account won’t be able to dial those numbers). Use this API to delete a blocked
list and therefore removing the associated number from the blocked list. The number will be
unblocked after the deletion. This operation makes an HTTP DELETE request to the
/phone/blocked\_list/{blockedListId} endpoint.

- Prerequisites: Pro or higher account plan with Zoom phone license.

- Scope: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Blocked List Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the blocked list. This can be retrieved from the List Blocked List API.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Delete A Call Queue

`<zoom-connector-mule-4:delete-acall-queue>`

Call queues allow you to route incoming calls to a group of users. For instance, you can use call
queues to route calls to various departments in your organization such as sales, engineering,
billing, customer service, etc. Use this API to delete a Call Queue. This operation makes an HTTP
DELETE request to the /phone/call\_queues/{callQueueId} endpoint.

- Prerequisites: Pro, Business, or Education account. Account owner or admin permissions. Zoom Phone
  license.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Call Queue Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the call queue.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Delete A Device

`<zoom-connector-mule-4:delete-adevice>`

Remove a
[desk phone device](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061431) from
the Zoom Phone System Management. This operation makes an HTTP DELETE request to the
/phone/devices/{deviceId} endpoint.

- Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin
  permissions. Device must not have been assigned to a user.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Device Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the device.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Delete A External Contact

`<zoom-connector-mule-4:delete-aexternal-contact>`

Use this API to remove an external contact. This operation makes an HTTP DELETE request to the
/phone/external\_contacts/{externalContactId} endpoint.

- Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin
  permissions.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>External Contact Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The external contact''s ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Delete All Sip Numbers

`<zoom-connector-mule-4:delete-all-sip-numbers>`

With SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed
to make and deliver phone calls) over a direct and private connection between the customer’s network
and the Zoom cloud. Meeting participants that dial into a meeting or have the meeting call them, and
are On-Net from the perspective of the customers' IP telephony network, will be connected over this
trunk rather than over the PSTN. Use this API to delete all internal numbers assigned to a sub
account. This operation makes an HTTP DELETE request to the /accounts/{accountId}/sip\_trunk/numbers
endpoint.

- Prerequisites: Pro or a higher account with SIP Connected Audio plan enabled. The account must be
  a master account.

- Scopes: `sip_trunk:master`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Account ID of the sub account from which the numbers are to be deleted. This can be retrieved from [List sub accounts](https://docs.mulesoft.com/zoom-connector/latest/%3Ca href="https://developers.zoom.us/docs/api/">https://developers.zoom.us/docs/api/</a>) API.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Delete A Member Slg

`<zoom-connector-mule-4:delete-amember-slg>`

Members of the
[shared line group](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066509) have
access to the group’s phone number and voicemail. Use this API to unassign a specific member from a
Shared Line Group. This operation makes an HTTP DELETE request to the
/phone/shared\_line\_groups/{sharedLineGroupId}/members/{memberId} endpoint.

- Prerequisites: Pro or higher account with Zoom Phone license. A valid Shared Line Group. Account
  owner or admin privileges.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Shared Line Group Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the shared line group from which you would like to remove a member.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Member Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the member who is to be removed.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Delete A Phone Number Slg

`<zoom-connector-mule-4:delete-aphone-number-slg>`

Use this API to unassign a specific phone number that was assigned to the
[shared line group](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066509-Setting-up-shared-line-groups).
This operation makes an HTTP DELETE request to the
/phone/shared\_line\_groups/{sharedLineGroupId}/phone\_numbers/{phoneNumberId} endpoint.

- Prerequisites: Pro or higher account with Zoom Phone license. A valid Shared Line Group. Account
  owner or admin privileges.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Shared Line Group Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the shared line group from which you would like to unassign a phone number.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Phone Number Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the phone number which is to be unassigned. This can be retrieved from the Get a Shared Line Group API.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Delete A Shared Line Group

`<zoom-connector-mule-4:delete-ashared-line-group>`

A [shared line group](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066509)
allows Zoom Phone admins to share a phone number and extension with a group of phone users or common
area phones. Use this API to delete a Shared Line Group. This operation makes an HTTP DELETE request
to the /phone/shared\_line\_groups/{sharedLineGroupId} endpoint.

- Prerequisites: Pro or higher account with Zoom Phone license. Account owner or admin privileges.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Shared Line Group Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the shared line group that you would like to delete.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Delete A Zoom Room

`<zoom-connector-mule-4:delete-azoom-room>`

[Remove](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067245) a specific Zoom
Room profile from a Zoom account. This operation makes an HTTP DELETE request to the /rooms/{roomId}
endpoint.

- Prerequisites: Pro or a higher plan with Zoom Room license.

- Scopes: `room:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Room Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of a Zoom Room.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Delete Call Log

`<zoom-connector-mule-4:delete-call-log>`

Use this API to delete a user’s
[call logs](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0069950). For
user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. This operation makes an HTTP DELETE request to the
/phone/users/{userId}/call\_logs/{callLogId} endpoint.

- Prerequisites: User must belong to a Business or Enterprise account. User must have a Zoom Phone
  license.

- Scopes: `phone:write`, `phone:write:admin`, `phone_call_log:write`, `phone_call_log:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>User ID or email address of the user.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Call Log Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the call log. The value for this field can be retrieved from <a href="https://developers.zoom.us/docs/api/">account’s call logs</a> or <a href="https://developers.zoom.us/docs/api/">user’s call logs</a>.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Delete Channel

`<zoom-connector-mule-4:delete-channel>`

Use this API to delete a specific channel. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. Zoom chat
[channels](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063548) allow users to
communicate via chat in private or public groups. This operation makes an HTTP DELETE request to the
/chat/users/{userId}/channels/{channelId} endpoint.

- Scopes: `chat_channel:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

Note that this API only supports a user-managed
[OAuth app](https://developers.zoom.us/docs/integrations/create/).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>User ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Channel Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of a channel.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Delete Chat Message

`<zoom-connector-mule-4:delete-chat-message>`

Delete a chat message that you previously sent to a contact or a channel. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. In the query parameter, you must provide either of the following: \*
`to_contact`: The email address of the contact to whom you sent the message. Use this parameter to
delete a message sent to an individual contact in Zoom. \* `to_channel`: The channel ID of the
channel where you sent the message. Use this parameter to delete a message sent to a channel in
Zoom. This operation makes an HTTP DELETE request to the /chat/users/{userId}/messages/{messageId}
endpoint.

- Scopes: `chat_message:write`, `chat_message:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

Note: For an account-level [OAuth app](https://developers.zoom.us/docs/integrations/create/), this
API can only be used on behalf of a user who is assigned with a
[role](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit)
that has the Edit permission for Chat Messages.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>User ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Message ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Message ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>To contact</p></td><td><div><div><p>String</p></div></div></td><td><p>The userId or email address of a chat contact to whom you previously sent the message. Note: You must provide either <code>to_contact</code> or <code>to_channel</code> as a query parameter to delete a message that was previously sent to either an individual or a chat channel respectively.</p></td><td></td><td></td></tr><tr><td><p>To channel</p></td><td><div><div><p>String</p></div></div></td><td><p>The channel Id of the channel where you would like to send the message. You must provide either <code>to_contact</code> or <code>to_channel</code> as a query parameter to delete a message that was previously sent to either an individual or a chat channel</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Delete Common Area Phone

`<zoom-connector-mule-4:delete-common-area-phone>`

A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an
organization can use it, for example, if your office has shared desks that don’t belong to a
specific employees, you could add a common area phone so that any person can use it. Use this API to
remove the
[common area phone](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066552) from
Zoom Phone System in an account. This operation makes an HTTP DELETE request to the
/phone/common\_area\_phones/{commonAreaPhoneId} endpoint.

- Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin
  permissions. A
  [supported device](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060242).

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Common Area Phone Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the common area phone.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Delete Internal Call Out Country

`<zoom-connector-mule-4:delete-internal-call-out-country>`

Delete a previously assigned
[call-out](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061683) country from a
master account or a sub account. To remove call-out country from a sub account, provide the account
ID of the sub account in the `accountId` path parameter. To remove call-out country from a master
account, provide `me` as the value of the `accountId` path parameter. This operation makes an HTTP
DELETE request to the /accounts/{accountId}/sip\_trunk/callout\_countries/{countryId} endpoint.

- Prerequisites: The account making this API request must be a
  [master account](https://developers.zoom.us/docs/api/ma/) with SIP Connected Audio Plan.

- Scope: `sip_trunk:master`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the account. To remove Call-out country from a sub account, provide the account ID of the sub account in the <code>accountId</code> path parameter. To remove Call-out country from a master account, provide <code>me</code> as the value of the <code>accountId</code> path parameter.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Country Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Two lettered ID of the country.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Delete Internal Number

`<zoom-connector-mule-4:delete-internal-number>`

This API allows a master account with SIP Connected Audio plan to delete a previously assigned
internal phone number from a master account or a sub account. To delete an internal number from a
sub account, provide the account ID of the sub account in the `accountId` path parameter. To delete
an internal number from a master account, provide `me` as the value of the `accountId` path
parameter. This operation makes an HTTP DELETE request to the
/accounts/{accountId}/sip\_trunk/internal\_numbers/{numberId} endpoint.

- Prerequisites: The account making this API request must be a
  [master account](https://developers.zoom.us/docs/api/ma/) with SIP Connected Audio Plan.

- Scope: `sip_trunk:master`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the account. To delete an internal number from a sub account, provide the account ID of the sub account in the <code>accountId</code> path parameter. To delete an internal number from a master account, provide <code>me</code> as the value of the <code>accountId</code> path parameter.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Number Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the phone number. This value can be retrieved by calling the List Internal Numbers API.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Delete Location

`<zoom-connector-mule-4:delete-location>`

Use this API to remove an emergency location. This operation makes an HTTP DELETE request to the
/phone/locations/{locationId} endpoint.

- Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin
  permissions.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Location Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The emergency service location’s ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Delete Members Of Slg

`<zoom-connector-mule-4:delete-members-of-slg>`

Members of the
[shared line group](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066509) have
access to the group’s phone number and voicemail. Use this API to unassign all the existing members
from a Shared Line Group. This operation makes an HTTP DELETE request to the
/phone/shared\_line\_groups/{sharedLineGroupId}/members endpoint.

- Prerequisites: Pro or higher account with Zoom Phone license. A valid Shared Line Group. Account
  owner or admin privileges.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Shared Line Group Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the shared line group that you would like to delete.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Delete Phone Numbers Slg

`<zoom-connector-mule-4:delete-phone-numbers-slg>`

Use this API to unassign all the phone numbers that have been assigned to the
[shared line group](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066509-Setting-up-shared-line-groups).
This operation makes an HTTP DELETE request to the
/phone/shared\_line\_groups/{sharedLineGroupId}/phone\_numbers endpoint.

- Prerequisites: Pro or higher account with Zoom Phone license. A valid Shared Line Group. Account
  owner or admin privileges.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Shared Line Group Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the shared line group.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Delete Phone Site

`<zoom-connector-mule-4:delete-phone-site>`

Sites enable you to organize Zoom Phone users in your organization. Use this API to delete a
specific [site](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0069716) in a Zoom
account. To delete a site, in the query parameter, you must provide the Site ID of another site
where the assets of current site (users, numbers and phones) can be transferred to. You cannot use
this API to delete the main site. This operation makes an HTTP DELETE request to the
/phone/sites/{siteId} endpoint.

- Prerequisites: Account must have a Pro or a higher plan with Zoom Phone license.
  [Multiple sites](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0069716-Managing-Multiple-Sites)
  must be enabled.

- Scope: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the site.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Transfer site ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID of another site where the assets of the current site (users, numbers and phones) can be transferred to.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Delete Role

`<zoom-connector-mule-4:delete-role>`

Each Zoom user automatically has a role which can either be owner, administrator, or a member.
Account Owners and users with edit privileges for Role management can add customized roles with a
list. Use this API to delete a role. This operation makes an HTTP DELETE request to the
/roles/{roleId} endpoint.

- Prerequisites: A Pro or higher plan. For role management and updates, you must be the Account
  Owner or user with role management permissions.

- Scopes: `role:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Role Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Role ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Delete Sip Phone

`<zoom-connector-mule-4:delete-sipphone>`

Zoom’s Phone System Integration (PSI), also referred as SIP phones, enables an organization to
leverage the Zoom client to complete a softphone registration to supported premise based PBX system.
End users will have the ability to have softphone functionality within a single client while
maintaining a comparable interface to Zoom Phone. Use this API to delete a specific SIP phone on a
Zoom account. This operation makes an HTTP DELETE request to the /sip\_phones/{phoneId} endpoint.

- Prerequisites: Currently only supported on Cisco and Avaya PBX systems. User must enable SIP Phone
  Integration by contacting the Zoom Sales team.

- Scope: `sip_phone:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Phone Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the SIP Phone. It can be retrieved from the List SIP Phones API.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Delete Sip Trunk

`<zoom-connector-mule-4:delete-siptrunk>`

Use this API to remove existing SIP trunk of a sub account. This operation makes an HTTP DELETE
request to the /accounts/{accountId}/sip\_trunk/trunks/{trunkId} endpoint.

- Prerequisites: The account making this API request must be a master account with
  [API Partner Plan](https://explore.zoom.us/docs/en-us/plan/api.html) and SIP Connected Audio Plan.

- Scope: `sip_trunk:master`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the sub account.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Trunk Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the SIP Trunk that was previously assigned to a sub account. To retrieve the value of this field, use the List SIP Trunks API.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Delete User Level Channel

`<zoom-connector-mule-4:delete-user-level-channel>`

Zoom chat [channels](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063548)
allow users to communicate via chat in private or public groups. Use this API to delete a specific
channel. This operation makes an HTTP DELETE request to the /chat/channels/{channelId} endpoint.

- Scope: `chat_channel:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

Note that this API only supports user-managed
[OAuth app](https://developers.zoom.us/docs/integrations/create/).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Channel Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of a channel.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Delete User Setting

`<zoom-connector-mule-4:delete-user-setting>`

Use this API to remove a user’s shared voicemail access settings. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. To view these settings in your Zoom web portal, navigate to the **Admin Phone
System Management and Users Rooms interface. Click the Users tab and select \*User Settings**.
Scroll down to **Voicemail Call Recordings**. This operation makes an HTTP DELETE request to the
/phone/users/{userId}/settings/{settingType} endpoint.

- Prerequisites: A Business or Enterprise account.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the user.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Setting Type</p></td><td><div><div><p>String</p></div></div></td><td><p>Corresponds to the setting item you wish to remove. Allowed values: <code>voice_mail</code></p></td><td></td><td><p>x</p></td></tr><tr><td><p>Shared ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Required only for voicemail setting type.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Delete Voicemail

`<zoom-connector-mule-4:delete-voicemail>`

Use this API to delete an account’s
[voicemail message](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0068876). This
operation makes an HTTP DELETE request to the /phone/voice\_mails/{voicemailId} endpoint.

- Prerequisites: A Zoom Phone license.

- Scopes: `phone:write:admin`, `phone:write`, `phone_voicemail:write`, `phone_voicemail:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Voicemail Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the voicemail. Retrieve the value for this field by calling the [Get voicemails](https://docs.mulesoft.com/zoom-connector/latest/%3Ca href="https://developers.zoom.us/docs/api/">https://developers.zoom.us/docs/api/</a>) API.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Delete Webinar Registrant

`<zoom-connector-mule-4:delete-webinar-registrant>`

Delete a webinar registrant. This operation makes an HTTP DELETE request to the
/webinars/{webinarId}/registrants/{registrantId} endpoint.

- Scopes: `webinar:write:admin` `webinar:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The webinar ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Registrant Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The registrant ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Occurrence ID</p></td><td><div><div><p>String</p></div></div></td><td><p>The webinar occurence ID.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Device Create

`<zoom-connector-mule-4:device-create>`

An H.323 or SIP device can make a video call to a
[Room Connector](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060661) to join
a Zoom cloud meeting. A Room Connector can also call out to an H.323 or SIP device to join a Zoom
cloud meeting. Use this API to add an H.323/SIP device to your Zoom account. This operation makes an
HTTP POST request to the /h323/devices endpoint.

- Scopes: `h323:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Device Delete

`<zoom-connector-mule-4:device-delete>`

An H.323 or SIP device can make a video call to a
[Room Connector](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060661) to join
a Zoom cloud meeting. A Room Connector can also call out to an H.323 or SIP device to join a Zoom
cloud meeting. Use this API to delete an H.323/SIP device from your Zoom account. This operation
makes an HTTP DELETE request to the /h323/devices/{deviceId} endpoint.

- Scopes: `h323:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Device Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The device ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Device List

`<zoom-connector-mule-4:device-list>`

An H.323 or SIP device can make a video call to a
[Room Connector](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060661) to join
a Zoom cloud meeting. A Room Connector can also call out to an H.323 or SIP device to join a Zoom
cloud meeting. Use this API to list all H.323/SIP Devices on a Zoom account. This operation makes an
HTTP GET request to the /h323/devices endpoint.

- Scopes: `h323:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Device Update

`<zoom-connector-mule-4:device-update>`

An H.323 or SIP device can make a video call to a
[Room Connector](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060661) to join
a Zoom cloud meeting. A Room Connector can also call out to an H.323 or SIP device to join a Zoom
cloud meeting. Use this API to edit H.323/SIP device information from your Zoom account. This
operation makes an HTTP PATCH request to the /h323/devices/{deviceId} endpoint.

- Scopes: `h323:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Device Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The device ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Download Invoice Pdf

`<zoom-connector-mule-4:download-invoice-pdf>`

Use this API to download a Zoom account’s
[billed](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060580) invoice file, in
PDF format. To get an account’s invoice ID, use the
[List billing invoices](https://developers.zoom.us/docs/api/) API. This operation makes an HTTP GET
request to the /api/download/billing/invoices/{invoiceId} endpoint.

- Scopes: `billing:master`

- Rate Limits: You can make one request to this API every 30 minutes until the daily limit is
  reached. This API has a daily limit of 100 requests per account.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Invoice Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Invoice ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Edit Message

`<zoom-connector-mule-4:edit-message>`

Use this API to edit a chat message that you previously sent to either a contact or a channel in
Zoom by providing the ID of the message as the value of the `messageId` parameter. You can get the
ID from the List User’s Chat Messages API. Additionally, as a query parameter, you must provide
either the contact’s email address of the contact or the Channel ID of the channel where the message
was sent. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/<mark>the-me-keyword) instead
of the `userId` parameter. Note: For an account-level
[OAuth app](https://developers.zoom.us/docs/integrations/create/), this API can only be used on
behalf of a user who is assigned with a
[role](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983</mark>:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit)
that has the Edit permission for Chat Messages. This operation makes an HTTP PUT request to the
/chat/users/{userId}/messages/{messageId} endpoint.

- Scope: `chat_message:write`,`chat_message:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>User ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Message Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the message.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get A Blocked List

`<zoom-connector-mule-4:get-ablocked-list>`

A Zoom account owner or a user with admin privilege can block phone numbers for phone users in an
account. Blocked numbers can be inbound (numbers will be blocked from calling in) and outbound
(phone users in your account won’t be able to dial those numbers). Blocked callers will hear a
generic message stating that the person they are calling is not available. Use this API to get
information about a specific blocked list. This operation makes an HTTP GET request to the
/phone/blocked\_list/{blockedListId} endpoint.

- Prerequisites: Pro or higher account plan with Zoom phone license.

- Scope: `phone:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Blocked List Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the blocked list.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get A Call Queue

`<zoom-connector-mule-4:get-acall-queue>`

Call queues allow you to route incoming calls to a group of users. For instance, you can use call
queues to route calls to various departments in your organization such as sales, engineering,
billing, customer service etc. Use this API to get information on a specific Call Queue. This
operation makes an HTTP GET request to the /phone/call\_queues/{callQueueId} endpoint.

- Prerequisites: Pro, Business, or Education account. Account owner or admin permissions. Zoom Phone
  license.

- Scopes: `phone:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Call Queue Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the call queue. This can be retrieved from [List Call Queues API](https://docs.mulesoft.com/zoom-connector/latest/%3Ca href="https://developers.zoom.us/docs/api/">https://developers.zoom.us/docs/api/</a>).</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get Account Billing Invoice

`<zoom-connector-mule-4:get-account-billing-invoice>`

Get detailed information about a specific
[invoice](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064306). To retrieve a
regular Zoom account’s invoice details or a master account’s invoice details, provide `me` as the
value of `accountId` path parameter. To list a sub account’s invoice details, provide the account ID
of the sub account in the `accountId` path parameter. This operation makes an HTTP GET request to
the /accounts/{accountId}/billing/invoices/{invoiceId} endpoint.

- Prerequisites: Account must be enrolled in Pro or a higher plan. You can make one API request
  every thirty minutes until the daily limit is reached. This API has a daily limit of 100 requests
  per account.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The account ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Invoice Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The invoice ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get Account Cloud Recording

`<zoom-connector-mule-4:get-account-cloud-recording>`

List [cloud recordings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062627)
available on an Account. To access a password protected cloud recording, add an "access\_token"
parameter to the download URL and provide JWT as the value of the "access\_token". This operation
makes an HTTP GET request to the /accounts/{accountId}/recordings endpoint.

- Prerequisites: A Pro or a higher paid plan with Cloud Recording option enabled.

- Scopes: `recording:read:admin` or `account:read:admin`. If the scope `recording:read:admin` is
  used, the Account ID of the Account must be provided in the `accountId` path parameter to list
  recordings that belong to the Account. This scope only works for sub accounts. To list recordings
  of a master account, the scope must be `account:read:admin` and the value of `accountId` should be
  `me`.

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the account.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>from</p></td><td><div><div><p>String</p></div></div></td><td><p>The start date in UTC for the monthly range for which you would like to retrieve recordings. The maximum range can be a month. If no value is provided for this field, the default will be the current date. For example, if you make the API request on June 30, 2020, without providing the <code>from</code> and <code>to</code> parameters, the default value of the <code>from</code> field will be 2020-06-30 and the value of the <code>to</code> field will be 2020-07-01.</p></td><td></td><td></td></tr><tr><td><p>to</p></td><td><div><div><p>String</p></div></div></td><td><p>The end date for the monthly range for which you would like to retrieve recordings. The maximum range can be a month.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get Account Lock Settings

`<zoom-connector-mule-4:get-account-lock-settings>`

[Account Locked Settings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065579)
allow you turn settings on or off for all users in your account. No user except the account admin or
account owner can change these settings. With lock settings, you force the settings on for all
users. Use this API to retrieve an account’s locked settings. Note that this API can be used by Zoom
Accounts that are on a Pro or a higher plan as well accounts that have master and sub accounts
options enabled. This operation makes an HTTP GET request to the
/accounts/{accountId}/lock\_settings endpoint.

- Prerequisites: Pro or a higher paid account.

- Scope: `account:read:admin`.

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the account. To retrieve locked settings of the master account or a regular account, provide "me" as the value of this field. To retrieve locked settings of a sub account, provide the Account ID of the sub account in this field.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>option</p></td><td><div><div><p>String</p></div></div></td><td><p><code>meeting_security</code>: Use this query parameter to view meeting security settings applied on the account.</p></td><td></td><td></td></tr><tr><td><p>Custom query fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Provide the name of the field by which you would like to filter the response. For example, if you provide "host_video" as the value of this field, you will get a response similar to the following: { "schedule_meeting": { "host_video": false } } You can provide multiple values by separating them with commas(example: "host_video,participant_video).</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get A Common Area Phone

`<zoom-connector-mule-4:get-acommon-area-phone>`

Use this API to get details on a specific
[common area phone](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066552) in an
account. A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that
anyone in an organization can use it. For example, if your office has shared desks that don’t belong
to a specific employees, you could add a common area phone so that any person can use it. This
operation makes an HTTP GET request to the /phone/common\_area\_phones/{commonAreaPhoneId} endpoint.

- Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin
  permissions. A
  [supported device](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060242).

- Scopes: `phone:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Common Area Phone Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the common area phone. Use the unique identifier or the Mac address of the common area phone. The Mac address can be in hyphenated (<code>00-04-f2-5e-ec-3c</code>) or not hyphenated (<code>0004f25eec3c</code>) format. You can get this value from the <a href="https://developers.zoom.us/docs/api/">List Common Area Phones API</a>.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get A Device

`<zoom-connector-mule-4:get-adevice>`

Get detailed information about a specific
[desk phone device](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061431). This
operation makes an HTTP GET request to the /phone/devices/{deviceId} endpoint.

- Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin
  permissions.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Device Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the device.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get A External Contact

`<zoom-connector-mule-4:get-aexternal-contact>`

Use this API to get an external contact’s information. This operation makes an HTTP GET request to
the /phone/external\_contacts/{externalContactId} endpoint.

- Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin
  permissions.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>External Contact Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The external contact’s ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get A Shared Line Group

`<zoom-connector-mule-4:get-ashared-line-group>`

A [shared line group](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066509)
allows Zoom Phone admins to share a phone number and extension with a group of phone users or common
area phones. This gives members of the shared line group access to the group’s direct phone number
and voicemail. Use this API to list all the Shared Line Groups. This operation makes an HTTP GET
request to the /phone/shared\_line\_groups/{sharedLineGroupId} endpoint.

- Prerequisites: Pro or higher account with Zoom Phone license. Account owner or admin privileges.

- Scopes: `phone:read:admin` or `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Shared Line Group Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the shared line group.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get A Site

`<zoom-connector-mule-4:get-asite>`

Sites allow you to organize Zoom Phone users in your organization. Use this API to get information
about a specific [site](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0069716).
This operation makes an HTTP GET request to the /phone/sites/{siteId} endpoint.

- Prerequisites: Account must have a Pro or a higher plan with Zoom Phone license. Multiple Sites
  must be
  [enabled](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0069716-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15).

- Scope: `phone:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the site.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get Billing Invoices Reports

`<zoom-connector-mule-4:get-billing-invoices-reports>`

Get department billing invoices reports for a specific billing period. Provide the `billing_id` of
the billing period for which you would like to retrieve the invoices for. This ID can be retrieved
from Get Billing Reports API. This operation makes an HTTP GET request to the
/report/billing/invoices endpoint.

- Prerequisites: Pro or a higher account with Department Billing option enabled. Contact the Zoom
  Support team to enable this feature.

- Scopes: `report:read:admin`, `report:master`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Billing ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the Billing Report. Retrieve this ID from the response of Get Billing Reports API request.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get Billing Report

`<zoom-connector-mule-4:get-billing-report>`

Get department billing reports of a Zoom account. This operation makes an HTTP GET request to the
/report/billing endpoint.

- Prerequisites: Pro or a higher account with Department Billing option enabled. Contact Zoom
  Support team for details.

- Scopes: `report:read:admin`, `report:master`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get Call Log Details

`<zoom-connector-mule-4:get-call-log-details>`

Use this API to return information about
[call logs](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0069950). This
operation makes an HTTP GET request to the /phone/call\_logs/{callLogId} endpoint.

- Prerequisites: A Business or Enterprise account. A Zoom Phone license.

- Scopes: `phone:read`, `phone:read:admin`, `phone_call_log:read`, `phone_call_log:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Call Log Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the call log. Both <code>callLogId</code> and <code>callId</code> can be used as path parameters. The value for this field can be retrieved from <a href="https://developers.zoom.us/docs/api/">account’s call logs</a> or the <a href="https://developers.zoom.us/docs/api/">user’s call logs</a>.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get Call Log Metrics Details

`<zoom-connector-mule-4:get-call-log-metrics-details>`

Call logs provide a record of all incoming and outgoing calls over Zoom Phone in an account. Use
this API to list call log details of a specific call. This operation makes an HTTP GET request to
the /phone/metrics/call\_logs/{call\_id} endpoint.

- Prerequisites: Business, or Education account. Zoom Phone license.

- Scopes: `phone:read:admin`, `phone:write:admin`

- Rate Limit Label: `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Call ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the phone call. The value of this field can be retrieved from [List Call Logs]() API.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get Call Qo S

`<zoom-connector-mule-4:get-call-qo-s>`

Get call quality of service (QoS) data for a call made or received by a Zoom phone user in the
account. This operation makes an HTTP GET request to the /phone/metrics/call\_logs/{callId}/qos
endpoint.

- Prerequisites: Business, or Education account. Zoom Phone license.

- Scopes: `phone:read:admin`, `phone:write:admin`

- Rate Limit Label: `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Call Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the call.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get Call Queue Recordings

`<zoom-connector-mule-4:get-call-queue-recordings>`

Use this API to view
[call recordings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0069433) from
the call queue. This operation makes an HTTP GET request to the
/phone/call\_queues/{callQueueId}/recordings endpoint.

- Prerequisites: Pro or higher account with Zoom Phone license.
  [Automatic call recordings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0069655)
  must be enabled in the Policy Settings for call queues.

- Scope: `phone:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Call Queue Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the call queue.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>from</p></td><td><div><div><p>String</p></div></div></td><td><p>Start date (within a 6 month range).</p></td><td></td><td></td></tr><tr><td><p>to</p></td><td><div><div><p>String</p></div></div></td><td><p>End date (within a 6 month range).</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get Channel

`<zoom-connector-mule-4:get-channel>`

Use this API to get information about a specific channel. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. Zoom chat
[channels](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063548) allow users to
communicate via chat in private or public groups. This operation makes an HTTP GET request to the
/chat/users/{userId}/channels/{channelId} endpoint.

- Scopes: `chat_channel:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

Note: For an account-level [OAuth app](https://developers.zoom.us/docs/integrations/create/), this
API can only be used on behalf of a user who is assigned with a
[role](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit)
that has the View or Edit permission for Chat Channels.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Channel Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of a channel.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the user who is the owner of the channel.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get Channels

`<zoom-connector-mule-4:get-channels>`

Use this API to list a user’s chat channels. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. Zoom chat
[channels](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063548) allow users to
communicate via chat in private or public groups. This operation makes an HTTP GET request to the
/chat/users/{userId}/channels endpoint.

- Scopes: `chat_channel:read` or `chat_channel:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

Note that this API supports both user-managed apps and account-level apps. However, in an
account-level [OAuth app](https://developers.zoom.us/docs/integrations/create/), to list channels of
another user in the same Zoom account, the user calling this API must have a
[role](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit)
that has the View or Edit permission for the Chat channels feature.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the user.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>The number of records returned from a single API call.</p></td><td><p>10</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get Chat Message

`<zoom-connector-mule-4:get-chat-message>`

Get a chat message previously sent to a contact or a channel. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. You must provide one of the following query parameters: \* `to_contact` - The
email address of the Zoom contact to whom you sent the message. \* `to_channel` - The ID of the Zoom
channel where you sent the message. This operation makes an HTTP GET request to the
/chat/users/{userId}/messages/{messageId} endpoint.

- Scopes: `chat_message:read`, `chat_message:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

Note: For an account-level [OAuth app](https://developers.zoom.us/docs/integrations/create/), you
can only use this API for a user assigned
[the Edit permission for the Chat message role setting](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>User ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Message ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Message ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>To contact</p></td><td><div><div><p>String</p></div></div></td><td><p>The <code>userId</code> or email address of a Zoom Chat contact to whom you sent the message. Note: You must use this query parameter to delete a message sent to a Zoom Chat contact.</p></td><td></td><td></td></tr><tr><td><p>To channel</p></td><td><div><div><p>String</p></div></div></td><td><p>The <code>channelId</code> of the Zoom Chat channel where the message is sent. Note: You must use this query parameter to delete a message sent to Zoom Chat channel.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get Chat Messages

`<zoom-connector-mule-4:get-chat-messages>`

Use this API to list the current user’s chat messages between the user and an individual contact or
a chat channel. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/<mark>the-me-keyword) instead
of the `userId` parameter. In the query parameter, you must provide one of the following: \*
`to_contact`: The email address of the contact with whom the user conversed by sending or receiving
messages. \* `to_channel`: The channel ID of the channel to or from which the user has sent and/or
received messages. Note: For an account-level
[OAuth app](https://developers.zoom.us/docs/integrations/create/), this API can only be used on
behalf of a user who is assigned with a
[role](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983</mark>:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit)
that has the View or Edit permission for Chat Messages. This operation makes an HTTP GET request to
the /chat/users/{userId}/messages endpoint.

- Scopes: `chat_message:read`, `chat_message:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>User ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>To contact</p></td><td><div><div><p>String</p></div></div></td><td><p>The email address of a chat contact with whom the current user chatted. Messages that were sent and/or received between the user and the contact are displayed. Note: You must provide either <code>contact</code> or <code>channel</code> as a query parameter to retrieve messages either from an individual or a chat channel.</p></td><td></td><td></td></tr><tr><td><p>To channel</p></td><td><div><div><p>String</p></div></div></td><td><p>The channel Id of a channel inside which the current user had chat conversations. Messages that were sent and/or received between the user and the channel are displayed. Note: You must provide either <code>contact</code> or <code>channel</code> as a query parameter to retrieve messages either from an individual or a chat channel.</p></td><td></td><td></td></tr><tr><td><p>date</p></td><td><div><div><p>String</p></div></div></td><td><p>The query date for which you would like to get the chat messages. This value defaults to the current date.</p></td><td></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>The number of records returned with a single API call.</p></td><td><p>10</p></td><td></td></tr><tr><td><p>Include deleted and edited message</p></td><td><div><div><p>String</p></div></div></td><td><p><strong>Optional</strong> Set the value of this field to <code>true</code> to include edited and deleted messages in the response.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get Group Lock Settings

`<zoom-connector-mule-4:get-group-lock-settings>`

Retrieve a [group’s](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062584)
locked settings. If you lock a setting, the group members will not be able to modify it
individually. Note: The `force_pmi_jbh_password` field under meeting settings is planned to be
deprecated on September 22, 2019. This field will be replaced by another field that will provide the
same functionality. This operation makes an HTTP GET request to the /groups/{groupId}/lock\_settings
endpoint.

- Prerequisites: Pro, Business, or Education account.

- Scopes: `group:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Group Id</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the group.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Custom query fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Provide the name of the field by which you would like to filter the response. For example, if you provide "host_video" as the value of this field, you will get a response similar to the following: { "schedule_meeting": { "host_video": false } } You can provide multiple values by separating them with commas(example: "host_video,participant_video).</p></td><td></td><td></td></tr><tr><td><p>option</p></td><td><div><div><p>String</p></div></div></td><td><p>Specify <code>meeting_security</code> as the value of this field if you would like to view security settings applied on a meeting hosted by the users in this group.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get Group Settings

`<zoom-connector-mule-4:get-group-settings>`

Get settings for a
[group](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062584). This operation
makes an HTTP GET request to the /groups/{groupId}/settings endpoint.

- Prerequisites: Pro, Business, or Education account.

- Scopes: `group:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Group Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Group ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Custom query fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Provide the name of the field by which you would like to filter the response. For example, if you provide "host_video" as the value of this field, you will get a response similar to the following: { "schedule_meeting": { "host_video": false } } You can provide multiple values by separating them with commas(example: "host_video,participant_video).</p></td><td></td><td></td></tr><tr><td><p>option</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>MEETING_AUTHENTICATION</p></li><li><p>RECORDING_AUTHENTICATION</p></li></ul></div></div></td><td><p>* <code>meeting_authentication</code>: Use this query parameter to view <a href="https://support.zoom.com/hc/en/article?id=zm_kb&amp;sysparm_article=KB0061263">meeting authentication configuration</a> applied on the group.</p><p>* <code>recording_authentication</code>: Use this query parameter to view <a href="https://support.zoom.com/hc/en/article?id=zm_kb&amp;sysparm_article=KB0067223">recording authentication configuration</a> applied on the group.</p><p>* <code>meeting_security</code>: Use this query parameter to view meeting security settings applied on the group.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get Live Stream Details For Meeting

`<zoom-connector-mule-4:get-live-stream-details-for-meeting>`

Zoom allows users to
[live stream a meeting](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064210)
to a custom platform. Use this API to get a meeting’s live stream configuration details such as
Stream URL, Stream Key, and Page URL. This operation makes an HTTP GET request to the
/meetings/{meetingId}/livestream endpoint.

- Prerequisites: Meeting host must be a licensed user with a Pro or higher plan. Live streaming
  details must have been
  [configured](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064210#h_01589a6f-a40a-4e18-a448-cb746e52ebc5)
  for the meeting.

- Scopes: `meeting:read:admin` `meeting:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the meeting.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get Live Stream Details For Webinar

`<zoom-connector-mule-4:get-live-stream-details-for-webinar>`

Zoom allows users to
[live stream a webinar](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064210)
to a custom platform. Use this API to get a webinar’s live stream configuration details such as
Stream URL, Stream Key, and Page URL. This operation makes an HTTP GET request to the
/webinars/{webinarId}/livestream endpoint.

- Prerequisites: Pro or higher plan with a Webinar Add-on. Live streaming details must have been
  [configured](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064210#h_01589a6f-a40a-4e18-a448-cb746e52ebc5)
  for the webinar.

- Scopes: `webinar:read:admin` `webinar:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The webinar’s unique ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get Location

`<zoom-connector-mule-4:get-location>`

Use this API to return an emergency service location’s information. This operation makes an HTTP GET
request to the /phone/locations/{locationId} endpoint.

- Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin
  permissions.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Location Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The emergency service location’s ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get Phone Number Details

`<zoom-connector-mule-4:get-phone-number-details>`

Use this API to get information about an account’s Zoom Phone number. This operation makes an HTTP
GET request to the /phone/numbers/{numberId} endpoint.

- Prerequisites: A Pro or higher account plan. A Zoom phone license.

- Scopes: `phone:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Number Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the Phone Number. This can be retrieved from the List Phone Numbers API.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get Phone Recordings

`<zoom-connector-mule-4:get-phone-recordings>`

Use this API to list an account’s
[call recordings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0069433). This
operation makes an HTTP GET request to the /phone/recordings endpoint.

- Prerequisites: A Pro or higher account plan. A Zoom phone license. Account owner or admin
  privileges.

- Scopes: `phone:read:admin`, `phone:write:admin`, `phone_recording:read:admin`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call. The default is 30, and the maximum is 100.</p></td><td></td><td></td></tr><tr><td><p>from</p></td><td><div><div><p>String</p></div></div></td><td><p>Start date and time in <strong>yyyy-mm-dd</strong> format or <strong>yyyy-MM-dd</strong> HH:mm:ss format. The date range defined by the from and to parameters should only be one month as the report includes only one month worth of data at once.</p></td><td></td><td></td></tr><tr><td><p>to</p></td><td><div><div><p>String</p></div></div></td><td><p>End date and time in <strong>yyyy-mm-dd</strong> format or <strong>yyyy-MM-dd</strong> HH:mm:ss format, the same formats supported by the <code>from</code> parameter.</p></td><td></td><td></td></tr><tr><td><p>Owner type</p></td><td><div><div><p>String</p></div></div></td><td><p>The owner type. The allowed values are null, <code>user</code>, or <code>callQueue</code>. The default is null. If null, returns all owner types.</p></td><td><p>all</p></td><td></td></tr><tr><td><p>Recording type</p></td><td><div><div><p>String</p></div></div></td><td><p>The recording type. The allowed values are null, <code>OnDemand</code>, or <code>Automatic</code>. The default is null. If null, returns all recording types.</p></td><td></td><td></td></tr><tr><td><p>Site ID</p></td><td><div><div><p>String</p></div></div></td><td><p>The site ID. The default is <code>All sites</code>.</p></td><td><p>All sites</p></td><td></td></tr><tr><td><p>Query date type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>START_TIME</p></li><li><p>END_TIME</p></li></ul></div></div></td><td><p>The query’s date type.</p></td><td><p>START_TIME</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get Plan Usage

`<zoom-connector-mule-4:get-plan-usage>`

Get information on usage of [plans](https://developers.zoom.us/docs/api/references/billing-plans/)
of an account. This API supports regular accounts as well as master and sub accounts. To get the
plan usage of a regular account, use the `account:read:admin` scope and provide `me` as the value of
the `accountId` path parameter. To get plan usage of a master account, provide the keyword "me" as
the value of the `accountId` path parameter and use the `billing:master` scope. To get plan usage of
a sub account, provide the actual account Id of the sub account as the value of the `accountId` path
parameter and use the `billing:master` scope. This operation makes an HTTP GET request to the
/accounts/{accountId}/plans/usage endpoint.

- Prerequisites: Account type: master account on a paid Pro, Business, or Enterprise plan.

- Scope: `billing:master` for master and sub accounts. `account:read:admin` for regular Zoom
  accounts.

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Account ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get Ps Operation Logs

`<zoom-connector-mule-4:get-psoperation-logs>`

The Phone System operation logs report allows account owners and admins to view monthly Zoom phone
related admin operation details. Use this API to retrieve the Phone System Operation Logs Report.
Account owners and admins can also access this information by logging into their Zoom accounts and
navigating to
[phone system operation logs](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0069964).
This operation makes an HTTP GET request to the /phone/reports/operationlogs endpoint.

- Prerequisites: Account must be enrolled in Pro or a higher plan. Account must be enrolled in a
  [Zoom phone](https://zoom.us/pricing/zoom-phone) plan.

- Scopes: `phone:read:admin`, `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>from</p></td><td><div><div><p>String</p></div></div></td><td><p>Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report provides only one month worth of data per API request.</p></td><td></td><td></td></tr><tr><td><p>to</p></td><td><div><div><p>String</p></div></div></td><td><p>End date in 'yyyy-mm-dd' format.</p></td><td></td><td></td></tr><tr><td><p>Category type</p></td><td><div><div><p>String</p></div></div></td><td><p>Filter the response by the category of the action performed. By default, the value of this field is "all" and thus, the response will include log of all operations for the defined period. To only include response for a specific category type, provide a value for <code>category_type</code>.</p></td><td><p>all</p></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get Role Information

`<zoom-connector-mule-4:get-role-information>`

Each Zoom user automatically has a role which can either be owner, administrator, or a member.
Account Owners and users with edit privileges for Role management can add customized roles with a
list of privileges. Use this API to get information including specific privileges assigned to a
[role](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983). This operation
makes an HTTP GET request to the /roles/{roleId} endpoint.

- Prerequisites: A Pro or higher plan. For role management and updates, you must be the Account
  Owner or user with role management permissions.

- Scopes: `role:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Role Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Role ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get Setting Template

`<zoom-connector-mule-4:get-setting-template>`

Use this API to return information about an account’s phone template. This operation makes an HTTP
GET request to the /phone/setting\_templates/{templateId} endpoint.

- Prerequisites: A Business or Enterprise account. A Zoom Phone license.

- Scopes: `phone:write:admin` or `phone:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Template Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the template.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Custom query fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Provide the name of the field to use to filter the response. For example, if you provide "description" as the value of the field, you will get a response similar to the following: {description: template description}.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get Tracking Sources

`<zoom-connector-mule-4:get-tracking-sources>`

[Webinar Registration Tracking Sources](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065543)
allow you to see where your registrants are coming from if you share the webinar registration page
in multiple platforms. You can then use the source tracking to see the number of registrants
generated from each platform. Use this API to list information on all the tracking sources of a
webinar. This operation makes an HTTP GET request to the /webinars/{webinarId}/tracking\_sources
endpoint.

- Prerequisites: Webinar license. Registration must be required for the Webinar.

- Scopes: `webinar:read:admin`, `webinar:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The webinar ID in "<strong>long</strong>" format (represented as int64 data type in JSON).</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get User Contact

`<zoom-connector-mule-4:get-user-contact>`

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.com/hc/en/article?id=zm_kb&sysparm_article=KB0065609). Call this API
to get information on a specific contact of the Zoom user. Note that this API only supports
user-managed [OAuth app](https://developers.zoom.us/docs/integrations/create/). This operation makes
an HTTP GET request to the /chat/users/me/contacts/{contactId} endpoint.

- Scope: `chat_contact:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Contact Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user’s contact ID or email address. The contact can be either a company contact or an external contact.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Query presence status</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>The presence status of the contact. Include this query parameter with a value of <code>true</code> to get the presence status of the contact in the response.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get User Contacts

`<zoom-connector-mule-4:get-user-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](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065609). 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 that this API only supports
user-managed [OAuth app](https://developers.zoom.us/docs/integrations/create/). This operation makes
an HTTP GET request to the /chat/users/me/contacts endpoint.

- Scope: `chat_contact:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>type</p></td><td><div><div><p>String</p></div></div></td><td><p>The type of contact. The value can be one of the following:</p><p>* <code>company</code></p><p>Contacts from the user’s organization.</p><p>* <code>external</code></p><p>External contacts.</p></td><td><p>company</p></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>The number of records returned with a single API call.</p></td><td><p>10</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get User Level Channel

`<zoom-connector-mule-4:get-user-level-channel>`

Zoom chat [channels](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063548)
allow users to communicate via chat in private or public groups. Use this API to get information
about a specific channel. This operation makes an HTTP GET request to the /chat/channels/{channelId}
endpoint.

- Scope: `chat_channel:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

Note that this API supports only user-managed
[OAuth apps](https://developers.zoom.us/docs/integrations/create/). If you use an Account-Level
OAuth Access token, you can only retrieve the channel information for the authorized user. You can’t
retrieve the channel information of other account users. Use the
[Account-Level Get Channel Info API](https://developers.zoom.us/docs/api/) to retrieve the channel
information of other account users.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Channel Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of a channel.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get Zr Account Profile

`<zoom-connector-mule-4:get-zraccount-profile>`

Get details on the account profile of a Zoom Room. This information can only by accessed either by
the Zoom Room Account Owner or a user with Zoom Rooms admin permission. To get information on an
individual Room Profile, use [Get Zoom Room Profile API](https://developers.zoom.us/docs/api/)
instead. This operation makes an HTTP GET request to the /rooms/account\_profile endpoint.

- Prerequisites: Zoom account owner or Zoom Rooms admin permissions.

- Scopes: `room:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get Zr Account Settings

`<zoom-connector-mule-4:get-zraccount-settings>`

Get details on Account Settings of a Zoom Room. With this API, you can view either the Account
Meeting Settings or the Alert Settings (Client Alert Settings and Notfication Settings) of the Zoom
Rooms account. By default, only Account Meeting Settings are returned. To view only Alert Settings,
specify `alert` as the value of the `setting_type` query parameter. This operation makes an HTTP GET
request to the /rooms/account\_settings endpoint.

- Prerequisites: Zoom Room licenses. Owner or Admin privileges on the Zoom Account.

- Scopes: `room:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Setting type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>MEETING</p></li><li><p>ALERT</p></li></ul></div></div></td><td><p>The type of setting that you would like to retrieve:</p><p>* <code>meeting</code></p><p>Meeting settings of the Zoom Rooms Account.</p><p>* <code>alert</code></p><p>Alert Settings applied on the Zoom Rooms Account.</p><p>* <code>signage</code></p><p>View digital signage settings of the Zoom Rooms Account.</p></td><td><p>MEETING</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get Zr Location Profile

`<zoom-connector-mule-4:get-zrlocation-profile>`

Each location type of the
[Zoom Rooms Location Hierarchy](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063345)
has a profile page that includes information such as name of the location, address, or support
email. Use this API to retrieve information about a specific Zoom Rooms location type such as
information about the city where the Zoom Rooms is located. This operation makes an HTTP GET request
to the /rooms/locations/{locationId} endpoint.

- Prerequisites: Account owner or admin permission. Zoom Rooms version 4.0 or higher.

- Scopes: `room:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Location Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the location type. This can be retrieved using the [List Zoom Room Location API](https://docs.mulesoft.com/zoom-connector/latest/%3Ca href="https://developers.zoom.us/docs/api/">https://developers.zoom.us/docs/api/</a>) (Id property in the response).</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get Zr Location Settings

`<zoom-connector-mule-4:get-zrlocation-settings>`

Get information on meeting or alert settings applied to Zoom Rooms located in a specific location.
By default, only **Meeting Settings** are returned. To view only Alert Settings, specify `alert` as
the value of the `setting_type` query parameter. This operation makes an HTTP GET request to the
/rooms/locations/{locationId}/settings endpoint.

- Prerequisites: Zoom Room licenses. Owner or Admin privileges on the Zoom Account.

- Scopes: `room:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Location Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the location type. This can be retrieved using the [List Zoom Room Location API](https://docs.mulesoft.com/zoom-connector/latest/%3Ca href="https://developers.zoom.us/docs/api/">https://developers.zoom.us/docs/api/</a>) (Id property in the response).</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Setting type</p></td><td><div><div><p>String</p></div></div></td><td><p>The type of setting that you would like to retrieve. <code>alert</code>: Alert Settings applied on the Zoom Rooms Account. <code>meeting</code>: Meeting settings of the Zoom Rooms Account. <code>signage</code>: Digital signage settings of the Zoom Rooms Account.</p></td><td><p>meeting</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get Zr Location Structure

`<zoom-connector-mule-4:get-zrlocation-structure>`

Get the
[location hierarchial structure(s)](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063345)
applied on the Zoom Rooms in an account. This operation makes an HTTP GET request to the
/rooms/locations/structure endpoint.

- Prerequisites: Zoom Rooms version 4.0 or higher. Account owner or admin permissions.

- Scopes: `room:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get Zr Profile

`<zoom-connector-mule-4:get-zrprofile>`

Zoom Rooms is a software-based room system that provides an integrated experience for audio
conferencing, wireless screen sharing and video conferencing. Use this API to get detailed
information on a specific Zoom Room in a Zoom account. This operation makes an HTTP GET request to
the /rooms/{roomId} endpoint.

- Prerequisites: Pro or a higher plan with Zoom Room license.

- Scopes: `room:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Room Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the Zoom Room. This can be retrieved from the response of <a href="https://developers.zoom.us/docs/api/">List Zoom Rooms</a> API.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Get Zr Settings

`<zoom-connector-mule-4:get-zrsettings>`

Get information on meeting or alert settings applied to a specific Zoom Room. By default, only
**Meeting Settings** are returned. To view only Alert Settings, specify `alert` as the value of the
`setting_type` query parameter. This operation makes an HTTP GET request to the
/rooms/{roomId}/settings endpoint.

- Prerequisites: Zoom Room licenses. Owner or Admin privileges on the Zoom Account.

- Scopes: `room:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Room Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the Zoom Room.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Setting type</p></td><td><div><div><p>String</p></div></div></td><td><p>The type of setting that you would like to retrieve. <code>alert</code>: Alert Settings applied on the Zoom Rooms Account. <code>meeting</code>: Meeting settings of the Zoom Rooms Account.</p></td><td><p>meeting</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Group

`<zoom-connector-mule-4:group>`

Get a [group](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062584) under an
account. This operation makes an HTTP GET request to the /groups/{groupId} endpoint.

- Prerequisites: Pro, Business, or Education account.

- Scopes: `group:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Group Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The group ID. Can be retrieved by calling <a href="https://developers.zoom.us/docs/api/">GET /groups</a>.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Group Create

`<zoom-connector-mule-4:group-create>`

Create a [group](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062584) under an
account. You can add a maximum of 100 groups in one account per day. If you go over, you will get an
error. You can add a maximum of 5000 groups in one account. This operation makes an HTTP POST
request to the /groups endpoint.

- Prerequisites: Pro or higher account.

- Scopes: `group:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Group Delete

`<zoom-connector-mule-4:group-delete>`

Delete a [group](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062584). This
operation makes an HTTP DELETE request to the /groups/{groupId} endpoint.

- Prerequisites: Pro, Business, or Education account.

- Scopes: `group:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Group Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The group ID. Can be retrieved by calling <a href="https://developers.zoom.us/docs/api/">GET /groups</a>.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Group Locked Settings

`<zoom-connector-mule-4:group-locked-settings>`

Update a [group’s](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062584) locked
settings. If you lock a setting, the group members will not be able to modify it individually. Note
that the `force_pmi_jbh_password` field under meeting settings is planned to be deprecated on
September 22, 2019. This field will be replaced by another field that will provide the same
functionality. This operation makes an HTTP PATCH request to the /groups/{groupId}/lock\_settings
endpoint.

- Prerequisites: Pro, Business, or Education account.

- Scopes: `group:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Group Id</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the group.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Custom query fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Provide the name of the field by which you would like to filter the response. For example, if you provide "host_video" as the value of this field, you will get a response similar to the following: { "schedule_meeting": { "host_video": false } }. You can provide multiple values by separating them with commas (example: "host_video,participant_video).</p></td><td></td><td></td></tr><tr><td><p>option</p></td><td><div><div><p>String</p></div></div></td><td><p>Specify <code>meeting_security</code> as the value of this field if you would like to view security settings applied on a meeting hosted by the users in this group.</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Group Members

`<zoom-connector-mule-4:group-members>`

List the members of a
[group](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062584) under your
account. This operation makes an HTTP GET request to the /groups/{groupId}/members endpoint.

- Prerequisites: Pro, Business, or Education account.

- Scopes: `group:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Group Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The group ID. Can be retrieved by calling <a href="https://developers.zoom.us/docs/api/">GET /groups</a>.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Group Members Create

`<zoom-connector-mule-4:group-members-create>`

Add members to a [group](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062584)
under your account. This operation makes an HTTP POST request to the /groups/{groupId}/members
endpoint.

- Prerequisites: Pro, Business, or Education account.

- Scopes: `group:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Group Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The group ID. Can be retrieved by calling <a href="https://developers.zoom.us/docs/api/">GET /groups</a>.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Group Members Delete

`<zoom-connector-mule-4:group-members-delete>`

Delete a member from a
[group](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062584) in a Zoom
account. This operation makes an HTTP DELETE request to the /groups/{groupId}/members/{memberId}
endpoint.

- Prerequisites: Pro, Business, or Education account.

- Scopes: `group:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Group Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The group ID. Can be retrieved by calling <a href="https://developers.zoom.us/docs/api/">GET /groups</a>.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Member Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The member ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Group Update

`<zoom-connector-mule-4:group-update>`

Update a [group](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062584) under
your account. This operation makes an HTTP PATCH request to the /groups/{groupId} endpoint.

- Prerequisites: Pro, Business, or Education account.

- Scopes: `group:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Group Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The group ID. Can be retrieved by calling <a href="https://developers.zoom.us/docs/api/">GET /groups</a>.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Groups

`<zoom-connector-mule-4:groups>`

List [groups](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062584) under an
account. This operation makes an HTTP GET request to the /groups endpoint.

- Prerequisites: Pro or higher account.

- Scopes: `group:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Im Chat Messages

`<zoom-connector-mule-4:im-chat-messages>`

Retrieve IM chat messages for a specified period of time. This API only supports oauth2. This
operation makes an HTTP GET request to the /im/chat/sessions/{sessionId} endpoint.

- Scopes: `imchat:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

Deprecated: By the end of 2021, Zoom will deprecate this API in favor of a consolidated set of APIs.
The API will still be available for you to use, though Zoom will no longer provide support for it.
For further information, refer to
[Announcements: IM APIs Deprecation](https://developers.zoom.us/changelog/).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Session Id</p></td><td><div><div><p>String</p></div></div></td><td><p>IM chat session ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>from</p></td><td><div><div><p>String</p></div></div></td><td><p>Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>to</p></td><td><div><div><p>String</p></div></div></td><td><p>End date.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Im Chat Sessions

`<zoom-connector-mule-4:im-chat-sessions>`

Retrieve IM Chat sessions for a specified period of time. This API only supports Oauth2. This
operation makes an HTTP GET request to the /im/chat/sessions endpoint.

- Scopes: `imchat:read, imchat:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

Deprecated: By the end of 2021, Zoom will deprecate this API in favor of a consolidated set of APIs.
The API will still be available for you to use, though Zoom will no longer provide support for it.
For further information, refer to
[Announcements: IM APIs Deprecation](https://developers.zoom.us/changelog/).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>from</p></td><td><div><div><p>String</p></div></div></td><td><p>Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>to</p></td><td><div><div><p>String</p></div></div></td><td><p>End date.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Im Group

`<zoom-connector-mule-4:im-group>`

Retrieve an [IM directory group](https://support.zoom.com/hc) under your account. This operation
makes an HTTP GET request to the /im/groups/{groupId} endpoint.

- Scopes: `imgroup:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Group Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The group ID. Can be retrieved by calling <a href="https://developers.zoom.us/docs/api/">GET /groups</a>.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Im Group Create

`<zoom-connector-mule-4:im-group-create>`

Create an [IM directory group](https://support.zoom.com/hc) under your account. This operation makes
an HTTP POST request to the /im/groups endpoint.

- Scopes: `imgroup:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Im Group Delete

`<zoom-connector-mule-4:im-group-delete>`

Delete an [IM directory group](https://support.zoom.com/hc) under your account. This operation makes
an HTTP DELETE request to the /im/groups/{groupId} endpoint.

- Scopes: `imgroup:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Group Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The group ID. Can be retrieved by calling <a href="https://developers.zoom.us/docs/api/">GET /groups</a>.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Im Group Members

`<zoom-connector-mule-4:im-group-members>`

List the members of an [IM directory group](https://support.zoom.com/hc). This operation makes an
HTTP GET request to the /im/groups/{groupId}/members endpoint.

- Scope: `imgroup:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Group Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The group ID. Can be retrieved by calling <a href="https://developers.zoom.us/docs/api/">GET /groups</a>.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Im Group Members Create

`<zoom-connector-mule-4:im-group-members-create>`

Add members to an [IM directory group](https://support.zoom.com/hc) under an account. This operation
makes an HTTP POST request to the /im/groups/{groupId}/members endpoint.

- Scope: `imgroup:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Group Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The group ID. Can be retrieved by calling <a href="https://developers.zoom.us/docs/api/">GET /groups</a>.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Im Group Members Delete

`<zoom-connector-mule-4:im-group-members-delete>`

Delete a member from an [IM directory group](https://support.zoom.com/hc) under an account. This
operation makes an HTTP DELETE request to the /im/groups/{groupId}/members/{memberId} endpoint.

Scopes: `imgroup:write:admin` \*
[Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Group Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The group ID. Can be retrieved by calling <a href="https://developers.zoom.us/docs/api/">GET /groups</a>.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Member Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The member ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Im Group Update

`<zoom-connector-mule-4:im-group-update>`

Update an [IM directory group](https://support.zoom.com/hc) under your account. This operation makes
an HTTP PATCH request to the /im/groups/{groupId} endpoint.

- Scopes: `imgroup:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Group Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The group ID. Can be retrieved by calling <a href="https://developers.zoom.us/docs/api/">GET /groups</a>.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Im Groups

`<zoom-connector-mule-4:im-groups>`

List [IM directory groups](https://support.zoom.com/hc). This operation makes an HTTP GET request to
the /im/groups endpoint.

- Scopes: `imgroup:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## In Meeting Recording Control

`<zoom-connector-mule-4:in-meeting-recording-control>`

Use this API to control the
[in-meeting](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060186) recording
features, such as starting a recording, stopping a recording, pausing a recording, and resuming a
recording. This API only works for Cloud Recordings and not for local recordings. This operation
makes an HTTP PATCH request to the /live\_meetings/{meetingId}/events endpoint.

- Prerequisites: The meeting must be a live meeting. Cloud Recording must be enabled. The user using
  this API must either be the host or alternative host of the meeting.

- Scopes: `meeting:write`, `meeting:write:admin`, `meeting:master`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the live meeting.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Invite Channel Members

`<zoom-connector-mule-4:invite-channel-members>`

Use this API to invite members that are in a user’s contact list to a channel. For user-level apps,
pass [the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead
of the `userId` parameter. This operation makes an HTTP POST request to the
/chat/users/{userId}/channels/{channelId}/members endpoint.

- Scopes: `chat_channel:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

Note: For an account-level [OAuth app](https://developers.zoom.us/docs/integrations/create/), this
API can only be used on behalf of a user who is assigned with a
[role](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit)
that has the Edit permission for Chat Channels.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Channel Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Channel ID: Unique identifier of the channel.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the user who is the owner of this channel.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Join Channel

`<zoom-connector-mule-4:join-channel>`

A [channel](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063548) can have one
or multiple members. Use this API to join a channel that is open for anyone in the same organization
to join. You cannot use this API to join private channels that only allows invited members to be a
part of it. Note that this API only supports user-managed
[OAuth app](https://developers.zoom.us/docs/integrations/create/). This operation makes an HTTP POST
request to the /chat/channels/{channelId}/members/me endpoint.

- Scope: `chat_channel:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Channel Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Channel ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Leave Channel

`<zoom-connector-mule-4:leave-channel>`

If you’re no longer interested in being a member of an existing channel, you can leave the channel
at any time. Use this API to leave a specific channel. After leaving the channel, you can no longer
access information from that channel. Note that this API only supports user-managed
[OAuth app](https://developers.zoom.us/docs/integrations/create/). This operation makes an HTTP
DELETE request to the /chat/channels/{channelId}/members/me endpoint.

- Scope: `chat_channel:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Channel Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of a channel.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## List Account Phone Numbers

`<zoom-connector-mule-4:list-account-phone-numbers>`

Use this API to list all Zoom Phone numbers in a Zoom account. This operation makes an HTTP GET
request to the /phone/numbers endpoint.

- Prerequisites: A Pro or higher account plan. A Zoom phone license.

- Scopes: `phone:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ASSIGNED</p></li><li><p>UNASSIGNED</p></li><li><p>ALL</p></li></ul></div></div></td><td><p>Query response by number assignment. The value can be one of the following:</p><p>* <code>assigned</code></p><p>The number has been assigned to either a user, a call queue, an auto-receptionist, or a common area phone in an account.</p><p>* <code>unassigned</code></p><p>The number is not assigned to anyone.</p><p>* <code>all</code></p><p>Include both assigned and unassigned numbers in the response.</p><p>* <code>byoc</code></p><p>Include Bring Your Own Carrier (BYOC) numbers only in the response.</p></td><td></td><td></td></tr><tr><td><p>Extension type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>USER</p></li><li><p>CALL_QUEUE</p></li><li><p>AUTO_RECEPTIONIST</p></li><li><p>COMMON_AREA_PHONE</p></li></ul></div></div></td><td><p>The type of assignee to whom the number is assigned. The value can be one of the following: <code>user</code> <code>callQueue</code> <code>autoReceptionist</code> <code>commonAreaPhone</code></p></td><td></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Number type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>TOLL</p></li><li><p>TOLLFREE</p></li></ul></div></div></td><td><p>The type of phone number. The value can be either <code>toll</code> or <code>tollfree</code>.</p></td><td></td><td></td></tr><tr><td><p>Pending numbers</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Include or exclude pending numbers in the response. The value can be either <code>true</code> or <code>false</code>.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Site ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the Site. Use this query parameter if you have enabled multiple sites and would like to filter the response of this API call by a specific phone site. See [Managing multiple sites](https://docs.mulesoft.com/zoom-connector/latest/%3Ca href="https://support.zoom.com/hc/en/article?id=zm_kb&amp;sysparm_article=KB0069716">https://support.zoom.com/hc/en/article?id=zm_kb&amp;sysparm_article=KB0069716</a>) or [Adding a site](https://docs.mulesoft.com/zoom-connector/latest/%3Ca href="https://support.zoom.com/hc/en/article?id=zm_kb&amp;sysparm_article=KB0069716#h_05c88e35-1593-491f-b1a8-b7139a75dc15">https://support.zoom.com/hc/en/article?id=zm_kb&amp;sysparm_article=KB0069716#h_05c88e35-1593-491f-b1a8-b7139a75dc15</a>) for details.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## List Archived Files

`<zoom-connector-mule-4:list-archived-files>`

Zoom’s
[archiving solution](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067188)
allows account administrators to set up an automated mechanism to record, collect and archive
meeting data to a 3rd party platform of their choice and hence, satisfy FINRA and/ or other
compliance requirements. Use this API to retrieve the archived meeting or webinar files of an
account. This operation makes an HTTP GET request to the /archive\_files endpoint.

- Prerequisites: Enable cloud recording. Follow the
  [enablement process](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067188#h_01ENPBD3WR68D7FAKTBY92SG45)
  to access the archiving feature.

- Scope: `recording:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>from</p></td><td><div><div><p>String</p></div></div></td><td><p>Start date for the query in "yyyy-MM-dd''T''HH:mm:ss''Z''" format. The duration for the query defined using the "from" and "to" parameters should not exceed 7 days as this API only provides a week’s data at once.</p></td><td></td><td></td></tr><tr><td><p>to</p></td><td><div><div><p>String</p></div></div></td><td><p>End date for the query in "yyyy-MM-dd''T''HH:mm:ss''Z''" format.</p></td><td></td><td></td></tr><tr><td><p>Query date type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>MEETING_START_TIME</p></li><li><p>ARCHIVE_COMPLETE_TIME</p></li></ul></div></div></td><td><p>The query date type for the <code>from</code> and <code>to</code> parameters.</p></td><td><p>MEETING_START_TIME</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## List Blocked List

`<zoom-connector-mule-4:list-blocked-list>`

A Zoom account owner or a user with admin privilege can block phone numbers for phone users in an
account. Blocked numbers can be inbound (numbers will be blocked from calling in) and outbound
(phone users in your account won’t be able to dial those numbers). Blocked callers will hear a
generic message stating that the person they are calling is not available. Use this API to list all
the blocked lists in an acccount. This operation makes an HTTP GET request to the
/phone/blocked\_list endpoint.

- Prerequisites: Pro or higher account plan with Zoom phone license.

- Scope: `phone:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>The total number of records returned from a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## List Byocsip Trunk

`<zoom-connector-mule-4:list-byocsiptrunk>`

Use this API to return a list of an account’s assigned
[BYOC (Bring Your Own Carrier) SIP (Session Initiation Protocol) trunks](https://explore.zoom.us/docs/doc/Zoom-Bring%20Your%20Own%20Carrier.pdf).
This operation makes an HTTP GET request to the /phone/sip\_trunk/trunks endpoint.

- Prerequisites: A Business or Enterprise account.

- Scopes: `phone:write:admin` or `phone:master`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## List Call Logs Metrics

`<zoom-connector-mule-4:list-call-logs-metrics>`

Call logs provide a record of all incoming and outgoing calls over Zoom Phone in an account. Use
this API to list monthly call logs metrics. You can use query parameters to filter the response by
date, site and MOS(Mean Opinion Score) of the call. This operation makes an HTTP GET request to the
/phone/metrics/call\_logs endpoint.

- Prerequisites: Business, or Education account. Zoom Phone license.

- Scopes: `phone:read:admin`, `phone:write:admin`

- Rate Limit Label: `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>from</p></td><td><div><div><p>String</p></div></div></td><td><p>Start date for the report in <code>yyyy-mm-dd</code> format. Specify a 30 day range using the <code>from</code> and <code>to</code> parameters as the response provides a maximum of a month worth of data per API request.</p></td><td></td><td></td></tr><tr><td><p>to</p></td><td><div><div><p>String</p></div></div></td><td><p>End date for the report in <code>yyyy-mm-dd</code> format.</p></td><td></td><td></td></tr><tr><td><p>Site ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the <a href="https://support.zoom.com/hc/en/article?id=zm_kb&amp;sysparm_article=KB0069716">site</a>. Use this query parameter if you have enabled multiple sites and would like to filter the response of this API call by call logs of a specific phone site.</p></td><td></td><td></td></tr><tr><td><p>Quality type</p></td><td><div><div><p>String</p></div></div></td><td><p>Filter call logs by voice quality. Zoom uses MOS of 3.5 as a general baseline to categorize calls by call quality. A MOS greater than or equal to 3.5 means good quality, while below 3.5 means poor quality. The value of this field can be one of the following:</p><p>* <code>good</code></p><p>Retrieve call logs of the call(s) with good quality of voice.</p><p>* <code>bad</code></p><p>Retrieve call logs of the call(s) with good quality of voice.</p><p>* <code>all</code></p><p>Retrieve all call logs without filtering by voice quality.</p></td><td></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>The number of records returned within a single call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## List Call Queues

`<zoom-connector-mule-4:list-call-queues>`

Call queues allow you to route incoming calls to a group of users. For instance, you can use call
queues to route calls to various departments in your organization such as sales, engineering,
billing, customer service, etc. Use this API to list Call queues. This operation makes an HTTP GET
request to the /phone/call\_queues endpoint.

- Prerequisites: Pro, Business, or Education account. Account owner or admin permissions. Zoom Phone
  license.

- Scopes: `phone:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>The number of records returned from a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## List Calling Plans

`<zoom-connector-mule-4:list-calling-plans>`

Use this API to return all of an account’s Zoom Phone
[calling plans](https://developers.zoom.us/docs/api/references/billing-plans/#zoom-phone-calling-plans).
This operation makes an HTTP GET request to the /phone/calling\_plans endpoint.

- Prerequisites: A Pro or a higher account. A Zoom Phone license.

- Scopes: `phone:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## List Channel Members

`<zoom-connector-mule-4:list-channel-members>`

Use this API to list all members of a channel. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. This operation makes an HTTP GET request to the
/chat/users/{userId}/channels/{channelId}/members endpoint.

- Scopes: `chat_channel:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

Note: For an account-level [OAuth app](https://developers.zoom.us/docs/integrations/create/), this
API can only be used on behalf of a user who is assigned with a
[role](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit)
that has the View or Edit permission for Chat Channels.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Channel Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Channel ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the user who is the owner of this channel.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>The number of records returned with a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## List Common Area Phones

`<zoom-connector-mule-4:list-common-area-phones>`

Use this API to list all of an account’s
[common area phones](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066552). A
common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an
organization can use it. For example, if your office has shared desks that don’t belong to a
specific employees, you could add a common area phone so that any person can use it. This operation
makes an HTTP GET request to the /phone/common\_area\_phones endpoint.

- Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin
  permissions. A
  [supported device](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060242).

- Scopes: `phone:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>The total number of records returned from a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## List Digital Signage Content

`<zoom-connector-mule-4:list-digital-signage-content>`

List information about existing
[Zoom Rooms digital signage](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060299)
content in a Zoom account. You can also access this information by logging into your Zoom account in
the Zoom web portal and visiting the Digital Signage Content page listed under Room Management. This
operation makes an HTTP GET request to the /rooms/digital\_signage endpoint.

- Prerequisites: Pro or a higher account with Zoom Rooms. Existing content files or folder in the
  Digital Signage Content page.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>type</p></td><td><div><div><p>String</p></div></div></td><td><p>Specify the type of digital signage resource. The value can be one of the following:</p><p>* <code>content</code></p><p>Returns information about content files.</p><p>* <code>folder</code></p><p>Returns information about the folder where the content files are located.</p></td><td></td><td></td></tr><tr><td><p>Folder ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the folder where the content is located. Provide this field if you would like to filter the response by contents that are only available in a specific folder.</p></td><td></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## List External Contacts

`<zoom-connector-mule-4:list-external-contacts>`

Use this API to list external contacts. This operation makes an HTTP GET request to the
/phone/external\_contacts endpoint.

- Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin
  permissions.

- Scopes: `phone:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## List Internal Callout Countries

`<zoom-connector-mule-4:list-internal-callout-countries>`

Retrieve the list of internal
[call-out](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061683) countries of a
master account or a sub account. To list call-out enabled countries of a sub account, provide the
account ID of the sub account in the `accountId` path parameter. To list call-out enabled countries
of a master account, provide `me` as the value of the `accountId` path parameter. This operation
makes an HTTP GET request to the /accounts/{accountId}/sip\_trunk/callout\_countries endpoint.

- Prerequisites: The account making this API request must be a
  [master account](https://developers.zoom.us/docs/api/ma/) with SIP Connected Audio Plan.

- Scope: `sip_trunk:master`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the account. To list Call-out enabled countries to a sub account, provide the account ID of the sub account in the <code>accountId</code> path parameter. To list Call-out enabled countries of a master account, provide <code>me</code> as the value of the <code>accountId</code> path parameter.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## List Internal Numbers

`<zoom-connector-mule-4:list-internal-numbers>`

This API allows a master account with SIP Connected Audio plan to list internal phone numbers, such
as for numbers that are not provided by Zoom but are owned by the organization consuming the API,
assigned to a master account or a sub account. To list the internal numbers of a sub account,
provide the account ID of the sub account in the `accountId` path parameter. To list internal
numbers of a master account, provide `me` as the value of the `accountId` path parameter. This
operation makes an HTTP GET request to the /accounts/{accountId}/sip\_trunk/internal\_numbers
endpoint.

- Prerequisites: The account making this API request must be a
  [master account](https://developers.zoom.us/docs/api/ma/) with SIP Connected Audio Plan.

- Scope: `sip_trunk:master`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the account. To list the internal numbers of a sub account, provide the account ID of the sub account in the <code>accountId</code> path parameter. To list the internal numbers of a master account, provide <code>me</code> as the value of the <code>accountId</code> path parameter.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## List Locations

`<zoom-connector-mule-4:list-locations>`

Use this API to list emergency service locations. This operation makes an HTTP GET request to the
/phone/locations endpoint.

- Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin
  permissions.

- Scopes: `phone:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## List Meeting Satisfaction

`<zoom-connector-mule-4:list-meeting-satisfaction>`

If the
[End of Meeting Feedback Survey](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067520)
option is enabled, attendees will be prompted with a survey window where they can tap either the
**Thumbs Up** or **Thumbs Down** button that indicates their Zoom meeting experience. With this API,
you can get information on the attendees' meeting satisfaction. Specify a monthly date range for the
query using the from and to query parameters. The month should fall within the last six months. To
get information on the survey results with negative experiences (indicated by **Thumbs Down**), use
the [Get Zoom Meetings Client Feedback API](https://developers.zoom.us/docs/api/). This operation
makes an HTTP GET request to the /metrics/client/satisfaction endpoint.

- Scopes: `dashboard:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>from</p></td><td><div><div><p>String</p></div></div></td><td><p>The start date for the query in the yyyy-mm-dd format.</p></td><td></td><td></td></tr><tr><td><p>to</p></td><td><div><div><p>String</p></div></div></td><td><p>The end date for the query in the yyyy-mm-dd format.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## List Meeting Templates

`<zoom-connector-mule-4:list-meeting-templates>`

Use this API to list
[meeting templates](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067229) that
are available to use by a user. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. This operation makes an HTTP GET request to the
/users/{userId}/meeting\_templates endpoint.

- Scopes: `meeting:read` or `meeting:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the user. Retrieve the value of this field by calling the <a href="https://developers.zoom.us/docs/api/">List users</a> API.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## List Past Meeting Files

`<zoom-connector-mule-4:list-past-meeting-files>`

Note that this API has been deprecated and is no longer supported due to GCM encryption updates for
security purposes. To learn about saving the in-meeting chat files via Zoom Client, refer to the
[Saving in-meeting chat](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067312)
guide. List files sent via in-meeting chat during a meeting. The in-meeting files are deleted after
24 hours of the meeting completion time. This operation makes an HTTP GET request to the
/past\_meetings/{meetingId}/files endpoint.

- Scope: `meeting:read`, `meeting:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The meeting ID in <code>long</code> format. The data type of this field is <code>long</code>, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a <code>long</code> data type and not as an integer, as the meeting IDs can be longer than 10 digits.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## List Past Meeting Polls

`<zoom-connector-mule-4:list-past-meeting-polls>`

[Polls](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066150) allow the meeting
host to survey attendees. Use this API to list poll results of a meeting. This operation makes an
HTTP GET request to the /past\_meetings/{meetingId}/polls endpoint.

- Prerequisites: Host user type must be Pro. Meeting must be a scheduled meeting. Instant meetings
  do not have polling features enabled.

- Scopes: `meeting:read:admin`, `meeting:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The meeting ID or the meeting UUID. If a meeting ID is provided in the request instead of a UUID, the response will be for the latest meeting instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must double encode the UUID before making an API request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## List Past Webinar Files

`<zoom-connector-mule-4:list-past-webinar-files>`

Note that this API has been deprecated and is no longer supported due to GCM encryption updates for
security purposes. List files sent via in-meeting chat during a meeting. The in-meeting files are
deleted after 24 hours of the meeting completion time. This operation makes an HTTP GET request to
the /past\_webinars/{webinarId}/files endpoint.

- Scope: `webinar:read`, `webinar:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Webinar ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## List Past Webinar Poll Results

`<zoom-connector-mule-4:list-past-webinar-poll-results>`

The polling feature for a webinar enables you to create single choice or multiple choice polling
questions for your webinars. Use this API to retrieve the results for Webinar Polls of a specific
Webinar. This operation makes an HTTP GET request to the /past\_webinars/{webinarId}/polls endpoint.

- Prerequisites: Webinar license

- Scopes: `webinar:read:admin`, `webinar:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a UUID, the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must double encode the UUID before making an API request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## List Past Webinar Qa

`<zoom-connector-mule-4:list-past-webinar-qa>`

The
[Question & Answer (Q&A)](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064380)
feature for Webinars allows attendees to ask questions during the Webinar and for the panelists,
co-hosts and host to answer their questions. Use this API to list Q&A of a specific Webinar. This
operation makes an HTTP GET request to the /past\_webinars/{webinarId}/qa endpoint.

- Prerequisites: Webinar license

- Scopes: `webinar:read:admin`, `webinar:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a UUID, the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must double encode the UUID before making an API request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## List Phone Devices

`<zoom-connector-mule-4:list-phone-devices>`

List all the
[desk phone devices](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061431) that
are configured with Zoom Phone on an account. This operation makes an HTTP GET request to the
/phone/devices endpoint.

- Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin
  permissions.

- Scopes: `phone:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ASSIGNED</p></li><li><p>UNASSIGNED</p></li></ul></div></div></td><td><p>State of the device. The value should be either <code>assigned</code> to list devices that have been assigned to user(s) or <code>unassigned</code> to list devices that have not yet been assigned to any user in the Zoom account.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## List Phone Sites

`<zoom-connector-mule-4:list-phone-sites>`

Sites enable you to organize Zoom Phone users in your organization. Use this API to list all the
[sites](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0069716) that have been
created for an account. This operation makes an HTTP GET request to the /phone/sites endpoint.

- Prerequisites: Multiple Sites must be
  [enabled](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0069716-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15).
  Pro or a higher account with Zoom Phone enabled.

- Scope: `phone:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## List Phone Users

`<zoom-connector-mule-4:list-phone-users>`

Use this API to return a list of all of an account’s users who are assigned a Zoom Phone license.
This operation makes an HTTP GET request to the /phone/users endpoint.

- Prerequisites: A Pro or higher account plan. A Zoom phone license.

- Scopes: `phone:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>The number of records returned from a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Site ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the Site. This can be retrieved from the [List Phone Sites](https://docs.mulesoft.com/zoom-connector/latest/%3Ca href="https://developers.zoom.us/docs/api/phone/#tag/sites/GET/phone/sites">https://developers.zoom.us/docs/api/phone/#tag/sites/GET/phone/sites</a>) API.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## List Setting Templates

`<zoom-connector-mule-4:list-setting-templates>`

Use this API to get a list of all the created phone template settings. This operation makes an HTTP
GET request to the /phone/setting\_templates endpoint.

- Prerequisites: A Business or Enterprise account. A Zoom Phone license.

- Scopes: `phone:read:admin` or `phone:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returns within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Site ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the Site. This field is required only if multiple sites have been enabled. of the site. Required only when multiple sites are enabled. See [Managing multiple sites](https://docs.mulesoft.com/zoom-connector/latest/%3Ca href="https://support.zoom.com/hc/en/article?id=zm_kb&amp;sysparm_article=KB0069716">https://support.zoom.com/hc/en/article?id=zm_kb&amp;sysparm_article=KB0069716</a>) for details. If this is not provided, the response lists the account level setting templates.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## List Shared Line Groups

`<zoom-connector-mule-4:list-shared-line-groups>`

A [shared line group](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066509)
allows Zoom Phone admins to share a phone number and extension with a group of phone users or common
area phones. This gives members of the shared line group access to the group’s direct phone number
and voicemail. Use this API to list all the Shared Line Groups. This operation makes an HTTP GET
request to the /phone/shared\_line\_groups endpoint.

- Prerequisites: Pro or higher account with Zoom Phone license. Account owner or admin privileges.

- Scopes: `phone:read:admin`, `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## List Sip Groups

`<zoom-connector-mule-4:list-sip-groups>`

Use this API to list SIP (Session Initiation Protocol) groups. This operation makes an HTTP GET
request to the /phone/sip\_groups endpoint.

- Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin
  permissions.

- Scopes: `phone:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## List Sip Phones

`<zoom-connector-mule-4:list-sip-phones>`

Zoom’s Phone System Integration (PSI), also referred as SIP phones, enables an organization to
leverage the Zoom client to complete a softphone registration to supported premise based PBX system.
End users will have the ability to have softphone functionality within a single client while
maintaining a comparable interface to Zoom Phone. Use this API to list SIP phones on an account.
This operation makes an HTTP GET request to the /sip\_phones endpoint.

- Prerequisites: Currently only supported on Cisco and Avaya PBX systems. User must enable SIP Phone
  Integration by contacting the Zoom Sales team.

- Scope: `sip_phone:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Search key</p></td><td><div><div><p>String</p></div></div></td><td><p>User name or email address of a user. If this parameter is provided, only the SIP phone system integration enabled for that specific user will be returned. Otherwise, all SIP phones on an account will be returned.</p></td><td></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## List Sip Trunk Numbers

`<zoom-connector-mule-4:list-sip-trunk-numbers>`

With SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed
to make and deliver phone calls) over a direct and private connection between the customer’s network
and the Zoom cloud. Meeting participants that dial into a meeting or have the meeting call them, and
are On-Net from the perspective of the customers' IP telephony network, will be connected over this
trunk rather than over the PSTN. Use this API to list all the numbers that are configured for SIP
Connected Audio in a Zoom Account. This operation makes an HTTP GET request to the
/sip\_trunk/numbers endpoint.

- Prerequisites: Pro or a higher account with SIP Connected Audio plan enabled. The account must be
  a master account.

- Scopes: `sip_trunk:master`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## List Sip Trunks

`<zoom-connector-mule-4:list-siptrunks>`

With SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed
to make and deliver phone calls) over a direct and private connection between the customer’s network
and the Zoom cloud. Meeting participants that dial into a meeting or have the meeting call them, and
are On-Net from the perspective of the customer’s IP telephony network, will be connected over this
trunk rather than over the PSTN. Use this API to list all the SIP trunks assigned to a master
account or a sub account of the master account. To retrieve SIP trunks assigned to a sub account,
provide the account ID of the sub account in the `accountId` path parameter. To retrieve SIP trunks
of a master account, provide `me` as the value of the `accountId` path parameter. This operation
makes an HTTP GET request to the /accounts/{accountId}/sip\_trunk/trunks endpoint.

- Prerequisites: The account must either be a master account or a sub account with
  [API Partner Plan](https://explore.zoom.us/docs/en-us/plan/api.html) and SIP Connected Audio Plan.

- Scope: `sip_trunk:read:admin`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the account. To retrieve SIP trunks assigned to a sub account, provide the account ID of the sub account in the as the value of this field. To retrieve SIP trunks of a master account, provide <code>me</code> as the value of this field.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## List Webinar Participants

`<zoom-connector-mule-4:list-webinar-participants>`

Use this API to list all the participants who attended a webinar hosted in the past. This operation
makes an HTTP GET request to the /past\_webinars/{webinarId}/participants endpoint.

- Prerequisites: Pro or higher plan with a Webinar Add-on.

- Scopes: `webinar:read:admin` `webinar:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the webinar. You can retrieve the value of this field by calling the [list webinars](https://docs.mulesoft.com/zoom-connector/latest/%3Ca href="https://developers.zoom.us/docs/api/">https://developers.zoom.us/docs/api/</a>) API.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## List Webinar Templates

`<zoom-connector-mule-4:list-webinar-templates>`

Use this API to list a user’s existing
[webinar templates'](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064225)
information. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. When you schedule a webinar, you can save the settings for that webinar as a
template for scheduling future webinars. This operation makes an HTTP GET request to the
/users/{userId}/webinar\_templates endpoint.

- Prerequisites: Pro or a higher account with Webinar plan enabled.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>User ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## List Zoom Rooms

`<zoom-connector-mule-4:list-zoom-rooms>`

Zoom Rooms is a software-based room system that provides an integrated experience for audio
conferencing, wireless screen sharing and video conferencing. Use this API to list all the existing
[Zoom Rooms](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063391) in a Zoom
account. This operation makes an HTTP GET request to the /rooms endpoint.

- Prerequisites: Pro or a higher plan with Zoom Room license.

- Scopes: `room:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>status</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>OFFLINE</p></li><li><p>AVAILABLE</p></li><li><p>IN_MEETING</p></li><li><p>UNDER_CONSTRUCTION</p></li></ul></div></div></td><td><p>The status of the Zoom Room.</p></td><td></td><td></td></tr><tr><td><p>type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ZOOM_ROOM</p></li><li><p>SCHEDULING_DISPLAY_ONLY</p></li><li><p>DIGITAL_SIGNAGE_ONLY</p></li></ul></div></div></td><td><p>Type of the Zoom Rooms.</p></td><td></td><td></td></tr><tr><td><p>Unassigned rooms</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Use this query parameter with a value of <code>true</code> if you would like to see Zoom Rooms in your account that have not been assigned to anyone yet.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Location ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Parent location ID of the Zoom Room.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## List Zr Devices

`<zoom-connector-mule-4:list-zrdevices>`

List information about the devices that are being used for a specific
[Zoom Room](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063391) in an
account. This operation makes an HTTP GET request to the /rooms/{roomId}/devices endpoint.

- Prerequisites: Pro or a higher plan with Zoom Room license. Account owner or admin permissions.

- Scopes: `room:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Room Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the Zoom Room. This can be retrieved from the response of <a href="https://developers.zoom.us/docs/api/">List Zoom Rooms</a> API.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## List Zr Locations

`<zoom-connector-mule-4:list-zrlocations>`

A Zoom account owner or a Zoom Room administrator can establish a
[location hierarchy](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063345) to
help manage Zoom Rooms that are spread among a variety of locations. Use this API to list the
different location types used for Zoom Rooms in an account. This operation makes an HTTP GET request
to the /rooms/locations endpoint.

- Prerequisites: Account owner or admin permissions. Zoom Rooms Version 4.0 or higher.

- Scopes: `room:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Parent location ID</p></td><td><div><div><p>String</p></div></div></td><td><p>A Unique identifier of the parent location. For instance, if a Zoom Room is located in Floor 1 of Building A, the location of Building A will be the parent location of Floor 1. Use this parameter to filter the response by a specific location hierarchy level.</p></td><td></td><td></td></tr><tr><td><p>type</p></td><td><div><div><p>String</p></div></div></td><td><p>Use this field to filter the response by the type of location. The value can be one of the following: <code>country</code>, <code>states</code>, <code>city</code>, <code>campus</code>, <code>building</code>, <code>floor</code>.</p></td><td></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Listimmessages

`<zoom-connector-mule-4:listimmessages>`

Get IM Chat messages for a specified period of time. This API only supports Oauth2. This operation
makes an HTTP GET request to the /im/users/{userId}/chat/messages endpoint.

- Scopes: `imchat:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

Deprecated: By the end of 2021, Zoom will deprecate this API in favor of a consolidated set of APIs.
The API will still be available for you to use, though Zoom will no longer provide support for it.
For further information, refer to
[Announcements: IM APIs Deprecation](https://developers.zoom.us/changelog/).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Chat user</p></td><td><div><div><p>String</p></div></div></td><td><p>Chat user’s ID or email address.</p></td><td></td><td></td></tr><tr><td><p>channel</p></td><td><div><div><p>String</p></div></div></td><td><p>IM Channel’s ID.</p></td><td></td><td></td></tr><tr><td><p>date</p></td><td><div><div><p>String</p></div></div></td><td><p>IM message''s query date time, format as yyyy-MM-dd.</p></td><td></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Manage E911signage

`<zoom-connector-mule-4:manage-e911signage>`

Display or hide E911 emergency alert text content from
[Zoom Rooms digital signage](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060299).
This operation makes an HTTP PATCH request to the /rooms/events endpoint.

- Prerequisites: [Zoom Rooms](https://explore.zoom.us/docs/en-us/zoomrooms/software.html) 5.3.0 or
  higher. Zoom Rooms digital signage must be
  [enabled](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060299).

- Scope: `room:write:admin`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Mark Message

`<zoom-connector-mule-4:mark-message>`

Mark a message as read or unread. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/<mark>the-me-keyword) instead
of the `userId` parameter. Note that for an account-level
[OAuth app](https://developers.zoom.us/docs/integrations/create/), this API can only be used on
behalf of a user who is assigned with a
[role](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983</mark>:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit)
that has the Edit permission for Chat Messages. This operation makes an HTTP PATCH request to the
/chat/users/{userId}/messages/{messageId}/status endpoint.

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the user.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Message Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the message.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Meeting

`<zoom-connector-mule-4:meeting>`

Retrieve the details of a meeting. This operation makes an HTTP GET request to the
/meetings/{meetingId} endpoint.

- Scopes: `meeting:read:admin` `meeting:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The meeting ID in <code>long</code> format. The data type of this field is <code>long</code>, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a <code>long</code> data type and not as an integer, as the meeting IDs can be longer than 10 digits.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Occurrence ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Meeting Occurrence ID. Provide this field to view meeting details of a particular occurrence of the <a href="https://support.zoom.com/hc/en/article?id=zm_kb&amp;sysparm_article=KB0064248">recurring meeting</a>.</p></td><td></td><td></td></tr><tr><td><p>Show previous occurrences</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Set the value of this field to <code>true</code> if you would like to view meeting details of all previous occurrences of a <a href="https://support.zoom.com/hc/en/article?id=zm_kb&amp;sysparm_article=KB0064248">recurring meeting</a>.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Meeting Create

`<zoom-connector-mule-4:meeting-create>`

[Create a meeting](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060700) for a
user. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. This API has a daily rate limit of 100 requests per day. Therefore, only 100
**Create a Meeting** API requests are permitted within a 24 hour window for a user. The start\_url
of a meeting is a URL using which a host or an alternative host can start a meeting. The expiration
time for the start\_url field is two hours for all regular users. For custCreate meeting hosts (
i.e., users created using the custCreate option via the
[Create Users API](https://developers.zoom.us/docs/api/), the expiration time of the start\_url
field is 90 days from the generation of the start\_url. For security reasons, the recommended way to
retrieve the updated value for the start\_url field programmatically (after expiry) is by calling
the [Retrieve a Meeting API](https://developers.zoom.us/docs/api/meetings/) and referring to the
value of the start\_url field in the response. This operation makes an HTTP POST request to the
/users/{userId}/meetings endpoint.

- Scopes: `meeting:write:admin` `meeting:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Meeting Delete

`<zoom-connector-mule-4:meeting-delete>`

Delete a meeting. This operation makes an HTTP DELETE request to the /meetings/{meetingId} endpoint.

- Scopes: `meeting:write:admin` `meeting:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The meeting ID in <code>long</code> format. The data type of this field is <code>long</code>, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a <code>long</code> data type and not as an integer, as the meeting IDs can be longer than 10 digits.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Occurrence ID</p></td><td><div><div><p>String</p></div></div></td><td><p>The meeting occurrence ID.</p></td><td></td><td></td></tr><tr><td><p>Schedule for reminder</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>* <code>true</code></p><p>Notify host and alternative host about the meeting cancellation via email.</p><p>* <code>false</code></p><p>Do not send any email notification.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Cancel meeting reminder</p></td><td><div><div><p>String</p></div></div></td><td><p>* <code>true</code></p><p>Notify registrants about the meeting cancellation via email.</p><p>* <code>false</code></p><p>Do not send any email notification to meeting registrants.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Meeting Invitation

`<zoom-connector-mule-4:meeting-invitation>`

Retrieve the meeting invite note that was sent for a specific meeting. This operation makes an HTTP
GET request to the /meetings/{meetingId}/invitation endpoint.

- Scopes: `meeting:read:admin` `meeting:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The meeting ID in <code>long</code> format. The data type of this field is <code>long</code>, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a <code>long</code> data type and not as an integer, as the meeting IDs can be longer than 10 digits.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Meeting Invite Links Create

`<zoom-connector-mule-4:meeting-invite-links-create>`

Use this API to create a batch of invitation links for a meeting. This operation makes an HTTP POST
request to the /meetings/{meetingId}/invite\_links endpoint.

- Scopes: `meeting:write:admin`, `meeting:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The meeting ID in <code>long</code> format. The data type of this field is <code>long</code>, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a <code>long</code> data type and not as an integer, as the meeting IDs can be longer than 10 digits.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Meeting Live Stream Status Update

`<zoom-connector-mule-4:meeting-live-stream-status-update>`

Zoom allows users to
[live stream a meeting](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064210)
to a custom platform. Use this API to update the status of a meeting’s live stream. This operation
makes an HTTP PATCH request to the /meetings/{meetingId}/livestream/status endpoint.

- Prerequisites: Meeting host must have a Pro license.

- Scopes: `meeting:write:admin` `meeting:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The meeting ID in <code>long</code> format. The data type of this field is <code>long</code>, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a <code>long</code> data type and not as an integer, as the meeting IDs can be longer than 10 digits.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Meeting Live Stream Update

`<zoom-connector-mule-4:meeting-live-stream-update>`

Use this API to update a meeting’s live stream information. Zoom allows users to
[live stream a meeting](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064210)
to a custom platform. This operation makes an HTTP PATCH request to the
/meetings/{meetingId}/livestream endpoint.

- Prerequisites: Meeting host must have a Pro license.

- Scopes: `meeting:write:admin`, `meeting:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The meeting ID in <code>long</code> format. The data type of this field is <code>long</code>, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a <code>long</code> data type and not as an integer, as the meeting IDs can be longer than 10 digits.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Meeting Poll Create

`<zoom-connector-mule-4:meeting-poll-create>`

Polls allow the meeting host to survey attendees. Use this API to create a
[poll](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066150) for a meeting.
This operation makes an HTTP POST request to the /meetings/{meetingId}/polls endpoint.

- Prerequisites: Host user type must be a Pro or higher plan. Polling feature must be enabled in the
  host’s account. Meeting must be a scheduled meeting. Instant meetings do not have polling features
  enabled.

- Scopes: `meeting:write:admin` `meeting:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The meeting ID in <code>long</code> format. The data type of this field is <code>long</code>, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a <code>long</code> data type and not as an integer, as the meeting IDs can be longer than 10 digits.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Meeting Poll Delete

`<zoom-connector-mule-4:meeting-poll-delete>`

Polls allow the meeting host to survey attendees. Use this API to delete a meeting
[poll](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066150). This operation
makes an HTTP DELETE request to the /meetings/{meetingId}/polls/{pollId} endpoint.

- Prerequisites: Host user type must be Pro. Polling feature should be enabled in the host’s
  account. Meeting must be a scheduled meeting. Instant meetings do not have polling features
  enabled.

- Scopes: `meeting:write:admin` `meeting:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The meeting ID in <code>long</code> format. The data type of this field is <code>long</code>, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a <code>long</code> data type and not as an integer, as the meeting IDs can be longer than 10 digits.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Poll Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The poll ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Meeting Poll Get

`<zoom-connector-mule-4:meeting-poll-get>`

Polls allow the meeting host to survey attendees. Use this API to get information about a specific
meeting [poll](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066150). This
operation makes an HTTP GET request to the /meetings/{meetingId}/polls/{pollId} endpoint.

- Scopes: `meeting:read:admin` `meeting:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The meeting ID in <code>long</code> format. The data type of this field is <code>long</code>, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a <code>long</code> data type and not as an integer, as the meeting IDs can be longer than 10 digits.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Poll Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The poll ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Meeting Poll Update

`<zoom-connector-mule-4:meeting-poll-update>`

Polls allow the meeting host to survey attendees. Use this API to update the information of a
specific meeting [poll](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066150).
This operation makes an HTTP PUT request to the /meetings/{meetingId}/polls/{pollId} endpoint.

- Scopes: `meeting:write:admin` `meeting:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The meeting ID in <code>long</code> format. The data type of this field is <code>long</code>, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a <code>long</code> data type and not as an integer, as the meeting IDs can be longer than 10 digits.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Poll Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The poll ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Meeting Polls

`<zoom-connector-mule-4:meeting-polls>`

Polls allow the meeting host to survey attendees. Use this API to list the
[polls](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066150) of a meeting.
This operation makes an HTTP GET request to the /meetings/{meetingId}/polls endpoint.

- Prerequisites: Host user type must be a Pro or higher plan. Meeting must be a scheduled meeting.
  Instant meetings do not have polling features enabled.

- Scopes: `meeting:read:admin` `meeting:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The meeting ID in <code>long</code> format. The data type of this field is <code>long</code>, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a <code>long</code> data type and not as an integer, as the meeting IDs can be longer than 10 digits.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Meeting Quality Score

`<zoom-connector-mule-4:meeting-quality-score>`

Get the quality scores of a meeting. This operation makes an HTTP GET request to the
/metrics/quality endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Meeting Recording Registrant Create

`<zoom-connector-mule-4:meeting-recording-registrant-create>`

Cloud Recordings of past Zoom Meetings can be made
[on-demand](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067514). Users should
be
[registered](https://developers.zoom.us/docs/api/meetings/#tag/cloud-recording/POST/meetings/{meetingId}/recordings/registrants)
to view these recordings. Use this API to register a user to gain access to the **On-demand Cloud
Recordings** of a past meeting. This operation makes an HTTP POST request to the
/meetings/{meetingId}/recordings/registrants endpoint.

- Scopes: `recording:write:admin`, `recording:write`.

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The meeting ID in <code>long</code> format. The data type of this field is <code>long</code>, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a <code>long</code> data type and not as an integer, as the meeting IDs can be longer than 10 digits.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Meeting Recording Registrant Status

`<zoom-connector-mule-4:meeting-recording-registrant-status>`

A registrant can either be approved or denied from viewing the
[on-demand](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067514) recording.
Use this API to update a registrant’s status. This operation makes an HTTP PUT request to the
/meetings/{meetingId}/recordings/registrants/status endpoint.

- Scopes: `recording:write:admin`, `recording:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The meeting ID in <code>long</code> format. The data type of this field is <code>long</code>, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a <code>long</code> data type and not as an integer, as the meeting IDs can be longer than 10 digits.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Meeting Recording Registrants

`<zoom-connector-mule-4:meeting-recording-registrants>`

Cloud Recordings of past Zoom Meetings can be made
[on-demand](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067514). Users should
be
[registered](https://developers.zoom.us/docs/api/meetings/#tag/cloud-recording/POST/meetings/{meetingId}/recordings/registrants)
to view these recordings. Use this API to list the registrants of **On-demand Cloud Recordings** of
a past meeting. This operation makes an HTTP GET request to the
/meetings/{meetingId}/recordings/registrants endpoint.

- Scopes: `recording:read:admin`, `recording:read`.

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The meeting ID in <code>long</code> format. The data type of this field is <code>long</code>, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a <code>long</code> data type and not as an integer, as the meeting IDs can be longer than 10 digits.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>status</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>PENDING</p></li><li><p>APPROVED</p></li><li><p>DENIED</p></li></ul></div></div></td><td><p>The registrant status: <code>pending</code> - Registrant''s status is pending. <code>approved</code> - Registrant''s status is approved. <code>denied</code> - Registrant''s status is denied.</p></td><td><p>APPROVED</p></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Meeting Registrant Create

`<zoom-connector-mule-4:meeting-registrant-create>`

Register a participant for a meeting. Note that there is a maximum limit of 4999 registrants per
meeting and users will see an error if the capacity is reached. This operation makes an HTTP POST
request to the /meetings/{meetingId}/registrants endpoint.

- Prerequisites: Host user type must be "Licensed".

- Scopes: `meeting:write:admin` `meeting:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The meeting ID in <code>long</code> format. The data type of this field is <code>long</code>, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a <code>long</code> data type and not as an integer, as the meeting IDs can be longer than 10 digits.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Occurrence ids</p></td><td><div><div><p>String</p></div></div></td><td><p>Occurrence IDs. You can find these with the meeting get API. Multiple values separated by comma.</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>String</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Meeting Registrant Question Update

`<zoom-connector-mule-4:meeting-registrant-question-update>`

Update registration questions that will be displayed to users while
[registering for a meeting](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065026).
This operation makes an HTTP PATCH request to the /meetings/{meetingId}/registrants/questions
endpoint.

- Scopes: `meeting:write`, `meeting:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The meeting ID in <code>long</code> format. The data type of this field is <code>long</code>, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a <code>long</code> data type and not as an integer, as the meeting IDs can be longer than 10 digits.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Meeting Registrant Status

`<zoom-connector-mule-4:meeting-registrant-status>`

Update a meeting registrant’s status by either approving, cancelling, or denying a registrant from
joining the meeting. This operation makes an HTTP PUT request to the
/meetings/{meetingId}/registrants/status endpoint.

- Scopes: `meeting:write:admin` `meeting:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The meeting ID in <code>long</code> format. The data type of this field is <code>long</code>, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a <code>long</code> data type and not as an integer, as the meeting IDs can be longer than 10 digits.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Occurrence ID</p></td><td><div><div><p>String</p></div></div></td><td><p>The meeting occurrence ID.</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Meeting Registrants

`<zoom-connector-mule-4:meeting-registrants>`

A host or a user with admin permission can require
[registration for a Zoom meeting](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065026).
Use this API to list users that have registered for a meeting. This operation makes an HTTP GET
request to the /meetings/{meetingId}/registrants endpoint.

- Scopes: `meeting:read:admin` `meeting:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The meeting ID in <code>long</code> format. The data type of this field is <code>long</code>, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a <code>long</code> data type and not as an integer, as the meeting IDs can be longer than 10 digits.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Occurrence ID</p></td><td><div><div><p>String</p></div></div></td><td><p>The meeting occurrence ID.</p></td><td></td><td></td></tr><tr><td><p>status</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>PENDING</p></li><li><p>APPROVED</p></li><li><p>DENIED</p></li></ul></div></div></td><td><p>The registrant status:</p><p>* <code>pending</code></p><p>Registrant’s status is pending.</p><p>* <code>approved</code></p><p>Registrant’s status is approved.</p><p>* <code>denied</code></p><p>Registrant’s status is denied.</p></td><td><p>APPROVED</p></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Meeting Registrants Questions Get

`<zoom-connector-mule-4:meeting-registrants-questions-get>`

List registration questions that will be displayed to users while
[registering for a meeting](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065026).
This operation makes an HTTP GET request to the /meetings/{meetingId}/registrants/questions
endpoint.

- Scopes: `meeting:read`, `meeting:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The meeting ID in <code>long</code> format. The data type of this field is <code>long</code>, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a <code>long</code> data type and not as an integer, as the meeting IDs can be longer than 10 digits.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Meeting Status

`<zoom-connector-mule-4:meeting-status>`

Update the status of a meeting. This operation makes an HTTP PUT request to the
/meetings/{meetingId}/status endpoint.

- Scopes: `meeting:write:admin` `meeting:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The meeting ID in <code>long</code> format. The data type of this field is <code>long</code>, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a <code>long</code> data type and not as an integer, as the meeting IDs can be longer than 10 digits.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Meeting Update

`<zoom-connector-mule-4:meeting-update>`

Update the details of a meeting. This API has a rate limit of 100 requests per day. Because of this,
a meeting can only be updated for a maximum of 100 times within a 24 hour period. This operation
makes an HTTP PATCH request to the /meetings/{meetingId} endpoint.

- Scopes: `meeting:write:admin`, `meeting:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The meeting ID in <code>long</code> format. The data type of this field is <code>long</code>, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a <code>long</code> data type and not as an integer, as the meeting IDs can be longer than 10 digits.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Occurrence ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Meeting occurrence id. Support change of agenda, start_time, duration, settings: {host_video, participant_video, join_before_host, mute_upon_entry, waiting_room, watermark, auto_recording}</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>String</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Meetingregistrantdelete

`<zoom-connector-mule-4:meetingregistrantdelete>`

Delete a meeting registrant. This operation makes an HTTP DELETE request to the
/meetings/{meetingId}/registrants/{registrantId} endpoint.

- Scopes: `meeting:write:admin` `meeting:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The meeting ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Registrant Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The meeting registrant ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Occurrence ID</p></td><td><div><div><p>String</p></div></div></td><td><p>The meeting occurence ID.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Meetings

`<zoom-connector-mule-4:meetings>`

List all the meetings that were scheduled for a user (meeting host). For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. This API only supports scheduled meetings. This API does not return information
about instant meetings. This operation makes an HTTP GET request to the /users/{userId}/meetings
endpoint.

- Scopes: `meeting:read:admin`, `meeting:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>SCHEDULED</p></li><li><p>LIVE</p></li><li><p>UPCOMING</p></li></ul></div></div></td><td><p>The meeting types: <code>scheduled</code> - This includes all valid past meetings (unexpired), live meetings and upcoming scheduled meetings. It is equivalent to the combined list of "Previous Meetings" and "Upcoming Meetings" displayed in the user’s [Meetings page](https://docs.mulesoft.com/zoom-connector/latest/%3Ca href="https://www.zoom.com/en/products/virtual-meetings/">https://www.zoom.com/en/products/virtual-meetings/</a>) on the Zoom Web Portal. <code>live</code> - All the ongoing meetings. <code>upcoming</code> - All upcoming meetings including live meetings.</p></td><td><p>LIVE</p></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Participant Feedback

`<zoom-connector-mule-4:participant-feedback>`

When a meeting ends, each attendee will be prompted to share their meeting experience by clicking
either thumbs up or thumbs down. Use this API to retrieve the feedback submitted for a specific
meeting. Note that this API only works for meetings scheduled after December 20, 2020. This
operation makes an HTTP GET request to the /metrics/meetings/{meetingId}/participants/satisfaction
endpoint.

- Prerequisites:
  [Feedback to Zoom](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0068808)
  setting must be enabled by the participant prior to the meeting. The user making the API request
  must be enrolled in a Business or a higher plan.

- Scope: `dashboard_meetings:read:admiin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The meeting ID or the meeting UUID. If a meeting ID is provided in the request instead of a UUID, the response will be for the latest meeting instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must double encode the UUID before making an API request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>PAST</p></li><li><p>PAST_ONE</p></li><li><p>LIVE</p></li></ul></div></div></td><td><p>Specify a value to get the response for the corresponding meeting type. The value of this field can be one of the following: <code>past</code> - Meeting that already occurred in the specified date range. <code>pastOne</code> - Past meetings that were attended by only one user. <code>live</code> - Live meetings. If you do not provide this field, the default value will be <code>live</code> and thus, the API will only query responses for live meetings.</p></td><td><p>LIVE</p></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Participant Webinar Feedback

`<zoom-connector-mule-4:participant-webinar-feedback>`

When a Webinar ends, each attendee will be prompted to share their Webinar experience by clicking
either thumbs up or thumbs down. Use this API to retrieve the feedback submitted for a specific
webinar. Note that this API only works for meetings scheduled after December 20, 2020. This
operation makes an HTTP GET request to the /metrics/webinars/{webinarId}/participants/satisfaction
endpoint.

- Prerequisites:
  [Feedback to Zoom](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0068808)
  setting must be enabled by the participant prior to the meeting. The user making the API request
  must be enrolled in a Business or a higher plan.

- Scope: `dashboard_webinars:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a UUID, the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must double encode the UUID before making an API request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>PAST</p></li><li><p>PAST_ONE</p></li><li><p>LIVE</p></li></ul></div></div></td><td><p>Specify a value to get the response for the corresponding meeting type. The value of this field can be one of the following: <code>past</code> - Meeting that already occurred in the specified date range. <code>pastOne</code> - Past meetings that were attended by only one user. <code>live</code> - Live meetings. If you do not provide this field, the default value will be <code>live</code> and thus, the API will only query responses for live meetings.</p></td><td><p>LIVE</p></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Past Meeting Details

`<zoom-connector-mule-4:past-meeting-details>`

Get details on a past meeting. This operation makes an HTTP GET request to the
/past\_meetings/{meetingUUID} endpoint.

- Scopes: `meeting:read:admin` `meeting:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

Note: Please double encode your UUID when using this API if the UUID begins with a '/'or contains
'//' in it.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting UUID</p></td><td><div><div><p>String</p></div></div></td><td><p>The meeting’s universally unique identifier (UUID). Each meeting instance generates a UUID. For example, after a meeting ends, a new UUID is generated for the next meeting instance. If the meeting UUID begins with a <code>/</code> character or contains a <code>//</code> character, you <strong>must</strong> double-encode the meeting UUID when using the meeting UUID for other API calls.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Past Meeting Participants

`<zoom-connector-mule-4:past-meeting-participants>`

Retrieve information on participants from a past meeting. This operation makes an HTTP GET request
to the /past\_meetings/{meetingUUID}/participants endpoint.

- Prerequisites: Paid account on a Pro or higher plan.

- Scopes: `meeting:read:admin` `meeting:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

Note: Please double encode your UUID when using this API if the UUID begins with a '/'or contains
'//' in it.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting UUID</p></td><td><div><div><p>String</p></div></div></td><td><p>The meeting’s universally unique identifier (UUID). Each meeting instance generates a UUID. For example, after a meeting ends, a new UUID is generated for the next meeting instance. If the meeting UUID begins with a <code>/</code> character or contains a <code>//</code> character, you <strong>must</strong> double-encode the meeting UUID when using the meeting UUID for other API calls.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Past Meetings

`<zoom-connector-mule-4:past-meetings>`

Get a list of ended meeting instances. This operation makes an HTTP GET request to the
/past\_meetings/{meetingId}/instances endpoint.

- Scopes: `meeting:read:admin` `meeting:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The meeting ID in <code>long</code> format. The data type of this field is <code>long</code>, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a <code>long</code> data type and not as an integer, as the meeting IDs can be longer than 10 digits.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Past Webinars

`<zoom-connector-mule-4:past-webinars>`

List past webinar instances. This operation makes an HTTP GET request to the
/past\_webinars/{webinarId}/instances endpoint.

- Scopes: `webinar:read:admin` `webinar:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The webinar ID in the <code>long</code> format, which is represented as the int64 data type in JSON.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Phone Setting

`<zoom-connector-mule-4:phone-setting>`

Use this API to return an account’s settings. This operation makes an HTTP GET request to the
/phone/settings endpoint.

- Prerequisites: A Business or Enterprise account. A Zoom Phone license.

- Scopes: `phone:read`, `phone:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Account ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Phone User

`<zoom-connector-mule-4:phone-user>`

Use this API to return a user’s
[Zoom phone](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060257) profile. For
user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. This operation makes an HTTP GET request to the /phone/users/{userId} endpoint.

- Prerequisites: A Business or Enterprise account. A Zoom Phone license.

- Scopes: `phone:read`, `phone:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Phone User Call Logs

`<zoom-connector-mule-4:phone-user-call-logs>`

Use this API to get a user’s
[Zoom phone](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060257) call logs.
For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. This operation makes an HTTP GET request to the /phone/users/{userId}/call\_logs
endpoint.

- Prerequisites: A Business or Enterprise account. A Zoom Phone license.

- Scopes: `phone:read`, `phone:read:admin`, `phone_call_log:read`, `phone_call_log:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>from</p></td><td><div><div><p>String</p></div></div></td><td><p>Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>to</p></td><td><div><div><p>String</p></div></div></td><td><p>End date.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALL</p></li><li><p>MISSED</p></li></ul></div></div></td><td><p>type</p></td><td></td><td></td></tr><tr><td><p>Phone number</p></td><td><div><div><p>String</p></div></div></td><td><p>Filter API responses to include call logs of only the phone number defined in this field.</p></td><td></td><td></td></tr><tr><td><p>Time type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>START_TIME</p></li><li><p>END_TIME</p></li></ul></div></div></td><td><p>Enables you to sort call logs by start or end time. Choose the sort time value. Values include <code>startTime</code> or <code>endTime</code>.</p></td><td><p>START_TIME</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Phone User Recordings

`<zoom-connector-mule-4:phone-user-recordings>`

Use this API to get a user’s
[Zoom Phone recordings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0069013).
For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. This operation makes an HTTP GET request to the /phone/users/{userId}/recordings
endpoint.

- Prerequisites: A Business or Enterprise account. A Zoom Phone license.

- Scopes: `phone:read`, `phone:read:admin`, `phone_recording:read`, `phone_recording:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>from</p></td><td><div><div><p>String</p></div></div></td><td><p>Start date for the query in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the response includes only one month worth of recording data. The month defined should fall within the last six months.</p></td><td></td><td></td></tr><tr><td><p>to</p></td><td><div><div><p>String</p></div></div></td><td><p>End date.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Phone User Settings

`<zoom-connector-mule-4:phone-user-settings>`

Use this API to get a user’s
[Zoom Phone profile settings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0069132).
For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. This operation makes an HTTP GET request to the /phone/users/{userId}/settings
endpoint.

- Prerequisites: A Business or Enterprise account. A Zoom Phone license.

- Scopes: `phone:read`, `phone:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Phone User Voice Mails

`<zoom-connector-mule-4:phone-user-voice-mails>`

Use this API to get a user’s Zoom Phone voicemails. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. This operation makes an HTTP GET request to the
/phone/users/{userId}/voice\_mails endpoint.

- Prerequisites: A Business or Enterprise account. A Zoom Phone license.

- Scopes: `phone:read`, `phone:read:admin`, `phone_voicemail:read`, `phone_voicemail:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>status</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALL</p></li><li><p>READ</p></li><li><p>UNREAD</p></li></ul></div></div></td><td><p>Status of the voice mail</p></td><td><p>ALL</p></td><td></td></tr><tr><td><p>from</p></td><td><div><div><p>String</p></div></div></td><td><p>Start date for the query in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the response includes only one month worth of voicemail data. The month defined should fall within the last six months.</p></td><td></td><td></td></tr><tr><td><p>to</p></td><td><div><div><p>String</p></div></div></td><td><p>End date.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Post Phone Sip Trunk

`<zoom-connector-mule-4:post-phone-siptrunk>`

A [master account](https://developers.zoom.us/docs/api/ma/) owner can use this API to assign SIP
(Session Initiation Protocol) trunks to a subaccount. This operation makes an HTTP POST request to
the /accounts/{accountId}/phone/sip\_trunk/trunks endpoint.

- Prerequisites: A Business or Enterprise account.

- Scopes: `phone:master`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the account.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## React Message

`<zoom-connector-mule-4:react-message>`

Use this API to react (add or remove) to a chat message with an emoji. For an account-level
[OAuth app](https://developers.zoom.us/docs/integrations/create/), this API can only be used on
behalf of a user who is assigned with a
[role](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit)
that has the Edit permission for Chat Messages. This operation makes an HTTP PATCH request to the
/chat/users/{userId}/messages/{messageId}/emoji\_reactions endpoint.

- Scopes: `chat_message:write`, `chat_message:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user’s unique ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Message Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The message''s unique ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Recording Delete

`<zoom-connector-mule-4:recording-delete>`

Delete all recording files of a meeting. This operation makes an HTTP DELETE request to the
/meetings/{meetingId}/recordings endpoint.

- Prerequisites: Cloud Recording should be enabled on the user’s account.

- Scopes: `recording:write:admin` `recording:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>String</p></div></div></td><td><p>To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID, the response will be for the latest meeting instance. To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>action</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>TRASH</p></li><li><p>DELETE</p></li></ul></div></div></td><td><p>The recording delete actions:</p><p>* <code>trash</code></p><p>Move recording to trash.</p><p>* <code>delete</code></p><p>Delete recording permanently.</p></td><td><p>TRASH</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Recording Delete One

`<zoom-connector-mule-4:recording-delete-one>`

Delete a specific recording file from a meeting. Note that to use this API, you must enable the "The
host can delete cloud recordings" setting. You can find this setting in the Recording tab of the
Settings interface in the [Zoom web portal](https://www.zoom.com/). This operation makes an HTTP
DELETE request to the /meetings/{meetingId}/recordings/{recordingId} endpoint.

- Scopes: `recording:write:admin`, `recording:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>String</p></div></div></td><td><p>To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID, the response will be for the latest meeting instance. To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Recording Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The recording ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>action</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>TRASH</p></li><li><p>DELETE</p></li></ul></div></div></td><td><p>The recording delete actions:</p><p>* <code>trash</code></p><p>Move recording to trash.</p><p>* <code>delete</code></p><p>Delete recording permanently.</p></td><td><p>TRASH</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Recording Get

`<zoom-connector-mule-4:recording-get>`

Get all the
[recordings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062627#h_7420acb5-1897-4061-87b4-5b76e99c03b4)
from a meeting or Webinar instance. The recording files can be downloaded via the `download_url`
property listed in the response. To access a password-protected cloud recording, add an
`access_token` parameter to the download URL and provide OAuth access token or JWT as the
`access_token` value. This operation makes an HTTP GET request to the
/meetings/{meetingId}/recordings endpoint.

- Scopes: `recording:read:admin`, `recording:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>String</p></div></div></td><td><p>To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID, the response will be for the latest meeting instance. To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Include fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Get the <code>download_access_token</code> field for downloading meeting recordings.</p></td><td></td><td></td></tr><tr><td><p>ttl</p></td><td><div><div><p>Number</p></div></div></td><td><p>Time to live (TTL) of the <code>download_access_token</code>. This is only valid if the <code>include_fields</code> query parameter contains <code>download_access_token</code>. The range is between 0-604800.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Recording Registrant Question Update

`<zoom-connector-mule-4:recording-registrant-question-update>`

For [on-demand](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067514) meeting
recordings, you can include fields with questions that will be shown to registrants when they
register to view the recording. Use this API to update registration questions that are to be
answered by users while registering to view a recording. This operation makes an HTTP PATCH request
to the /meetings/{meetingId}/recordings/registrants/questions endpoint.

- Scopes: `recording:write:admin`, `recording:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>String</p></div></div></td><td><p>To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID, the response will be for the latest meeting instance. To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Recording Registrants Questions Get

`<zoom-connector-mule-4:recording-registrants-questions-get>`

For [on-demand](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067514) meeting
recordings, you can include fields with questions that will be shown to registrants when they
register to view the recording. Use this API to retrieve a list of questions that are displayed for
users to complete when registering to view the recording of a specific meeting. This operation makes
an HTTP GET request to the /meetings/{meetingId}/recordings/registrants/questions endpoint.

- Scopes: `recording:read:admin`, `recording:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>String</p></div></div></td><td><p>To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID, the response will be for the latest meeting instance. To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Recording Setting Update

`<zoom-connector-mule-4:recording-setting-update>`

Retrieve settings applied to a meeting’s
[Cloud Recording](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062627). This
operation makes an HTTP GET request to the /meetings/{meetingId}/recordings/settings endpoint.

- Scopes: `recording:read:admin` `recording:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>String</p></div></div></td><td><p>To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID, the response will be for the latest meeting instance. To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Recording Settings Update

`<zoom-connector-mule-4:recording-settings-update>`

Update settings applied to a meeting’s
[Cloud Recording](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062627). This
operation makes an HTTP PATCH request to the /meetings/{meetingId}/recordings/settings endpoint.

- Scopes: `recording:write:admin` `recording:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>String</p></div></div></td><td><p>To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID, the response will be for the latest meeting instance. To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Recording Status Update

`<zoom-connector-mule-4:recording-status-update>`

Zoom allows users to recover recordings from trash for up to 30 days from the deletion date. Use
this API to recover all deleted
[cloud recordings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062627) of a
specific meeting. This operation makes an HTTP PUT request to the
/meetings/{meetingId}/recordings/status endpoint.

- Prerequisites: A Pro user with Cloud Recording enabled.

- Scopes: `recording:write:admin` `recording:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>String</p></div></div></td><td><p>To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID, the response will be for the latest meeting instance. To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Recording Status Update One

`<zoom-connector-mule-4:recording-status-update-one>`

Zoom allows users to recover recordings from trash for up to 30 days from the deletion date. Use
this API to recover a single recording file from the meeting. This operation makes an HTTP PUT
request to the /meetings/{meetingId}/recordings/{recordingId}/status endpoint.

- Scopes: `recording:write:admin` `recording:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>String</p></div></div></td><td><p>To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID, the response will be for the latest meeting instance. To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Recording Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The recording ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Recordings List

`<zoom-connector-mule-4:recordings-list>`

Use this API to list all
[cloud recordings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062627) of a
user. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. Note that to access a user’s password protected cloud recording, add an
access\_token parameter to the download URL and provide either the JWT or the user’s OAuth access
token as the value of the access\_token parameter. When a user records a meeting or a webinar by
choosing the **Record to the Cloud** option, the video, audio, and chat text are recorded in the
Zoom cloud. This operation makes an HTTP GET request to the /users/{userId}/recordings endpoint.

- Prerequisites: Pro or a higher plan. Cloud Recording must be enabled on the user’s account.

- Scopes: `recording:read:admin`, `recording:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>mc</p></td><td><div><div><p>String</p></div></div></td><td><p>Query Metadata of Recording if an On-Premise Meeting Connector was used for the meeting.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>trash</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Query trash.</p><p>* <code>true</code></p><p>List recordings from trash.</p><p>* <code>false</code></p><p>Do not list recordings from the trash. The default value is <code>false</code>. If you set it to <code>true</code>, you can use the <code>trash_type</code> property to indicate the type of Cloud recording that you need to retrieve.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>from</p></td><td><div><div><p>String</p></div></div></td><td><p>The start date in 'yyyy-mm-dd' UTC format for the date range for which you would like to retrieve recordings. The maximum range can be a month. If no value is provided for this field, the default will be current date. For example, if you make the API request on June 30, 2020, without providing the <code>from</code> and <code>to</code> parameters, by default the value of 'from' field will be 2020-06-30 and the value of the 'to' field will be 2020-07-01. <strong>Note</strong>: The "trash" files cannot be filtered by date range and thus, the "from" and "to" fields should not be used for trash files.</p></td><td></td><td></td></tr><tr><td><p>to</p></td><td><div><div><p>String</p></div></div></td><td><p>End date in 'yyyy-mm-dd' 'yyyy-mm-dd' UTC format.</p></td><td></td><td></td></tr><tr><td><p>Trash type</p></td><td><div><div><p>String</p></div></div></td><td><p>The type of Cloud recording that you would like to retrieve from the trash. The value can be one of the following:</p><p>* <code>meeting_recordings</code></p><p>List all meeting recordings from the trash.</p><p>* <code>recording_file</code></p><p>List all individual recording files from the trash.</p></td><td><p>meeting_recordings</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Remove A Channel Member

`<zoom-connector-mule-4:remove-achannel-member>`

A [channel](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063548) can have one
or multiple members. Use this API to remove a member from a chat channel. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. This operation makes an HTTP DELETE request to the
/chat/users/{userId}/channels/{channelId}/members/{memberId} endpoint.

- Scopes: `chat_channel:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

Note: For an account-level [OAuth app](https://developers.zoom.us/docs/integrations/create/), this
API can only be used on behalf of a user who is assigned with a
[role](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit)
that has Edit permission for Chat Channels.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Channel Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the Channel from where you would like to remove a member. This can be retrieved from the <a href="https://developers.zoom.us/docs/api/">List Channels API</a>.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Member Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Email address of the member whom you would like to be remove from the channel.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the channel owner.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Remove A User Level Channel Member

`<zoom-connector-mule-4:remove-auser-level-channel-member>`

A [channel](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063548) can have one
or multiple members. Use this API to remove a member from a chat channel. This operation makes an
HTTP DELETE request to the /chat/channels/{channelId}/members/{memberId} endpoint.

- Scopes: `chat_channel:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

Note that this API only supports user-managed
[OAuth app](https://developers.zoom.us/docs/integrations/create/).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Channel Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the Channel from where you would like to remove a member. This can be retrieved from the <a href="https://developers.zoom.us/docs/api/">List Channels API</a>.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Member Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Email address of the member whom you would like to be remove from the channel.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Report Cloud Recording

`<zoom-connector-mule-4:report-cloud-recording>`

Retrieve cloud recording usage report for a specified period. You can only get cloud recording
reports that are one day ealier than the current date and for the most recent period of 6 months.
The date gap between from and to dates should be smaller or equal to 30 days. This operation makes
an HTTP GET request to the /report/cloud\_recording endpoint.

- Prerequisites: Pro or higher plan.

- Scopes: `report:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>from</p></td><td><div><div><p>String</p></div></div></td><td><p>Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>to</p></td><td><div><div><p>String</p></div></div></td><td><p>End date.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Report Daily

`<zoom-connector-mule-4:report-daily>`

Retrieve daily report to access the account-wide usage of Zoom services for each day in a given
month. It lists the number of new users, meetings, participants, and meeting minutes. This operation
makes an HTTP GET request to the /report/daily endpoint.

- Prerequisites: Pro or higher plan.

- Scopes: `report:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>year</p></td><td><div><div><p>Number</p></div></div></td><td><p>Year for this report.</p></td><td></td><td></td></tr><tr><td><p>month</p></td><td><div><div><p>Number</p></div></div></td><td><p>Month for this report.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Report Meeting Details

`<zoom-connector-mule-4:report-meeting-details>`

Get a detailed report for a past meeting. This operation makes an HTTP GET request to the
/report/meetings/{meetingId} endpoint.

- Prerequisites: Pro or a higher plan.

- Scopes: `report:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The meeting ID or the meeting UUID. If a meeting ID is provided in the request instead of a UUID, the response will be for the latest meeting instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must double encode the UUID before making an API request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Report Meeting Participants

`<zoom-connector-mule-4:report-meeting-participants>`

Use this API to return a report of a past meeting with two or more participants, including the host.
To return a report for past meeting with only one participant, use the
[List meeting participants](https://developers.zoom.us/docs/api/) API. This operation makes an HTTP
GET request to the /report/meetings/{meetingId}/participants endpoint.

- Prerequisites: Pro or a higher plan.

- Scopes: `report:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The meeting ID or the meeting UUID. If a meeting ID is provided in the request instead of a UUID, the response will be for the latest meeting instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must double encode the UUID before making an API request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Include fields</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>REGISTRANT_ID</p></li></ul></div></div></td><td><p>Provide <code>registrant_id</code> as the value for this field if you would like to see the registrant ID attribute in the response of this API call. A registrant ID is a unique identifier of a <a href="https://developers.zoom.us/docs/api/meetings/">meeting registrant</a>.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Report Meeting Polls

`<zoom-connector-mule-4:report-meeting-polls>`

Retrieve a report of
[poll](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066150) results for a past
meeting. This operation makes an HTTP GET request to the /report/meetings/{meetingId}/polls
endpoint.

- Prerequisites: Pro or a higher plan.

- Scopes: `report:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The meeting ID or the meeting UUID. If a meeting ID is provided in the request instead of a UUID, the response will be for the latest meeting instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must double encode the UUID before making an API request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Report Meetings

`<zoom-connector-mule-4:report-meetings>`

Retrieve [a report](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065639) on
past meetings and webinars for a specified time period. The time range for the report is limited to
a month and the month must fall within the past six months. Meetings and webinars are returned only
if they have two or more unique participants. This operation makes an HTTP GET request to the
/report/users/{userId}/meetings endpoint.

- Prerequisites: Pro or higher plan.

- Scopes: `report:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>from</p></td><td><div><div><p>String</p></div></div></td><td><p>Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>to</p></td><td><div><div><p>String</p></div></div></td><td><p>End date.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>PAST</p></li><li><p>PAST_ONE</p></li></ul></div></div></td><td><p>The meeting types:</p><p>* <code>past</code></p><p>Past meetings.</p><p>* <code>pastOne</code></p><p>Past one user meetings.</p></td><td><p>PAST</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Report Operation Logs

`<zoom-connector-mule-4:report-operation-logs>`

The [Operations Logs](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067251)
report allows you to audit admin and user activity, such as adding a new user, changing account
settings, and deleting recordings. Use this API to retrieve operation logs report for a specified
period of time. This operation makes an HTTP GET request to the /report/operationlogs endpoint.

- Prerequisites: Pro or higher plan.

- Scopes: `report:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>from</p></td><td><div><div><p>String</p></div></div></td><td><p>Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>to</p></td><td><div><div><p>String</p></div></div></td><td><p>End date.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Category type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALL</p></li><li><p>USER</p></li><li><p>USER_SETTINGS</p></li><li><p>ACCOUNT</p></li><li><p>BILLING</p></li><li><p>IM</p></li><li><p>RECORDING</p></li><li><p>PHONE_CONTACTS</p></li><li><p>WEBINAR</p></li><li><p>SUB_ACCOUNT</p></li><li><p>ROLE</p></li><li><p>ZOOM_ROOMS</p></li></ul></div></div></td><td><p>Filter your response by a category type to see reports for a specific category. The value for this field can be one of the following: <code>all</code>, <code>user</code>, <code>user_settings</code>, <code>account</code>, <code>billing</code>, <code>im</code>, <code>recording</code>, <code>phone_contacts</code>, <code>webinar</code>, <code>sub_account</code>, <code>role</code>, or <code>zoom_rooms</code>.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Report Sign In Sign Out Activities

`<zoom-connector-mule-4:report-sign-in-sign-out-activities>`

Retrieve a list of sign in and sign out activity logs
[report](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060623) of users under a
Zoom account. This operation makes an HTTP GET request to the /report/activities endpoint.

- Prerequisites: Pro or higher plan.

- Scopes: `report:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>from</p></td><td><div><div><p>String</p></div></div></td><td><p>Start date for which you would like to view the activity logs report. Using the <code>from</code> and <code>to</code> parameters, specify a monthly date range for the report as the API only provides one month worth of data in one request. The specified date range should fall within the last six months.</p></td><td></td><td></td></tr><tr><td><p>to</p></td><td><div><div><p>String</p></div></div></td><td><p>End date up to which you would like to view the activity logs report.</p></td><td></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>The number of records to be returned within a single API call</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Report Telephone

`<zoom-connector-mule-4:report-telephone>`

The [telephone report](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066623)
allows you to view who dialed into meetings via phone (Audio Conferencing or SIP Connected Audio)
and which number they dialed into and other details. Use this API to get a telephone report for a
specified period of time. This operation makes an HTTP GET request to the /report/telephone
endpoint.

- Prerequisites: Pro or higher plan.

- Scopes: `report:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>j_1</p></li><li><p>j_3</p></li></ul></div></div></td><td><p>Audio types:</p><p>* <code>1</code></p><p>Toll-free Call-in &amp; Call-out.</p><p>* <code>2</code></p><p>Toll.</p><p>* <code>3</code></p><p>SIP Connected Audio.</p></td><td><p>j_1</p></td><td></td></tr><tr><td><p>Query date type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>START_TIME</p></li><li><p>END_TIME</p></li></ul></div></div></td><td><p>Date types: <code>start_time</code> - Query by call start time. <code>end_time</code> - Query by call end time.</p></td><td><p>START_TIME</p></td><td></td></tr><tr><td><p>from</p></td><td><div><div><p>String</p></div></div></td><td><p>Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>to</p></td><td><div><div><p>String</p></div></div></td><td><p>End date.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Report Users

`<zoom-connector-mule-4:report-users>`

A user is considered to be an active host during the month specified in the "from" and "to" range,
if the user has hosted at least one meeting during this period. If the user didn’t host any meetings
during this period, the user is considered to be inactive. The Active Hosts report displays a list
of meetings, participants, and meeting minutes for a specific time range, up to one month. The month
should fall within the last six months. The Inactive Hosts report pulls a list of users who were not
active during a specific period of time. Use this API to retrieve an active or inactive host report
for a specified period of time. The time range for the report is limited to a month and the month
should fall under the past six months. You can specify the type of report and date range using the
query parameters. This operation makes an HTTP GET request to the /report/users endpoint.

- Prerequisites: Pro or higher plan.

- Scopes: `report:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ACTIVE</p></li><li><p>INACTIVE</p></li></ul></div></div></td><td><p>Active or inactive hosts.</p><p>* <code>active</code></p><p>Active hosts.</p><p>* <code>inactive</code></p><p>Inactive hosts.</p></td><td></td><td></td></tr><tr><td><p>from</p></td><td><div><div><p>String</p></div></div></td><td><p>Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>to</p></td><td><div><div><p>String</p></div></div></td><td><p>End date.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Report Webinar Details

`<zoom-connector-mule-4:report-webinar-details>`

Retrieve a [report](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066245)
containing past webinar details. This operation makes an HTTP GET request to the
/report/webinars/{webinarId} endpoint.

- Prerequisites: Pro or higher plan with Webinar add-on.

- Scopes: `report:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a UUID, the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must double encode the UUID before making an API request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Report Webinar Participants

`<zoom-connector-mule-4:report-webinar-participants>`

Get a detailed report on each attendee of a webinar. This operation makes an HTTP GET request to the
/report/webinars/{webinarId}/participants endpoint.

- Prerequisites: Pro or a higher plan with Webinar add-on enabled.

- Scopes: `report:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a UUID, the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must double encode the UUID before making an API request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Include fields</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>REGISTRANT_ID</p></li></ul></div></div></td><td><p>Enter 'registrant_id' as the value for this field if you would like to see the registrant ID attribute included in the response of this API call. A registrant ID is a unique identifier of a <a href="https://developers.zoom.us/docs/api/">webinar registrant</a>.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Report Webinar Polls

`<zoom-connector-mule-4:report-webinar-polls>`

Retrieve a report on past
[webinar polls](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066668). This
operation makes an HTTP GET request to the /report/webinars/{webinarId}/polls endpoint.

- Prerequisites: Pro or a higher plan with Webinar add-on enabled.

- Scopes: `report:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a UUID, the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must double encode the UUID before making an API request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Report Webinar Qa

`<zoom-connector-mule-4:report-webinar-qa>`

The Question & Answer (Q&A) feature for webinars allows attendees to ask questions during the
webinar and for the panelists, co-hosts, and host to answer their questions. Use this API to
retrieve a report on question and answers from past webinars. This operation makes an HTTP GET
request to the /report/webinars/{webinarId}/qa endpoint.

- Prerequisites: Pro or a higher plan with Webinar add-on enabled.

- Scopes: `report:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a UUID, the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must double encode the UUID before making an API request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Role Member Delete

`<zoom-connector-mule-4:role-member-delete>`

User [roles](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983) can have a
set of permissions that allows access only to the pages a user needs to view or edit. Use this API
to unassign a user’s role. This operation makes an HTTP DELETE request to the
/roles/{roleId}/members/{memberId} endpoint.

- Prerequisites: A Pro or a higher plan.

- Scope: `role:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Role Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The role ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Member Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Member’s ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Role Members

`<zoom-connector-mule-4:role-members>`

User [roles](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983) can have a
set of permissions that enables access only to the pages a user needs to view or edit. Use this API
to list all the members that are assigned a specific role. This operation makes an HTTP GET request
to the /roles/{roleId}/members endpoint.

- Prerequisites: A Pro or a higher plan.

- Scope: `role:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Role Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The role ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page count</p></td><td><div><div><p>String</p></div></div></td><td><p>Number of pages returned for this request.</p></td><td></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Roles

`<zoom-connector-mule-4:roles>`

List [roles](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983) on your
account. This operation makes an HTTP GET request to the /roles endpoint.

- Prerequisites: Pro or higher plan. For setting the initial role, you must be the Account Owner.
  For subsequent role management, you must be the Account Owner or user with role management
  permissions.

- Scopes: `role:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Search Company Contacts

`<zoom-connector-mule-4:search-company-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` to include
the presence status of a contact. This operation makes an HTTP GET request to the /contacts
endpoint.

- Scopes: `contact:read:admin`, `contact:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Search key</p></td><td><div><div><p>String</p></div></div></td><td><p>Provide the keyword - either first name, last name or email of the contact whom you have to search for.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Query presence status</p></td><td><div><div><p>String</p></div></div></td><td><p>Set <code>query_presence_status</code> to <code>true</code> to include the presence status of a contact in the response.</p></td><td></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>The number of records to be returned with a single API call.</p></td><td><p>1</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Senda Chat Message

`<zoom-connector-mule-4:senda-chat-message>`

Send chat messages on Zoom to either an individual user who is in your contact list or to a
[channel](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063548) of which you
are a member. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. To send a message to a contact, provide the contact’s email address in the
`to_contact` field. To send a message to a channel, provide the channel’s ID in `to_channel`
parameter. This operation makes an HTTP POST request to the /chat/users/{userId}/messages endpoint.

- Scopes: `chat_message:write`, `chat_message:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

Note: For an account-level [OAuth app](https://developers.zoom.us/docs/integrations/create/), this
API can only be used on behalf of a user who is assigned with a
[role](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit)
that has the Edit permission for Chat Messages.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>User ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Sendimmessages

`<zoom-connector-mule-4:sendimmessages>`

Send chat message to a user. Note that this API only supports OAuth 2.0. This operation makes an
HTTP POST request to the /im/users/me/chat/messages endpoint.

- Scope: `imchat:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Chat user</p></td><td><div><div><p>String</p></div></div></td><td><p>The email address (registered with Zoom) or the userId of the chat user.</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Set Up Account

`<zoom-connector-mule-4:set-up-account>`

After assigning a Zoom phone license to an account, an admin or account owner can proceed with the
[initial Zoom phone set up](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060257)
using this API. This operation makes an HTTP POST request to the /accounts/{accountId}/phone/setup
endpoint.

- Prerequisites: A Paid account. A Pro or a higher account plan. Master account option enabled.

- Scopes: `phone:write:admin`, `phone:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the account.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Switch User Account

`<zoom-connector-mule-4:switch-user-account>`

Disassociate a user from one account and move the user to another account under the same master
account. With this API, a user under a master account or a sub account can be moved to another sub
account within the same master account. To move a user from a master account to a sub account, use
`me` as the value for `accountId`. In this scenario, "me" refers to the Account ID of the master
account. To move a user from one sub account to another sub account, provide the sub account’s
Account ID as the value for `accountId`. This operation makes an HTTP PUT request to the
/accounts/{accountId}/users/{userId}/account endpoint.

- Prerequisites: The account should have Pro or a higher plan with master account option enabled.
  The user whose account needs to be switched should not be an admin or an owner of that account.
  The user should not have the same
  [managed domain](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066259) as the
  account owner.

- Scope: `user:master`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>User ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Account ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Testget Record Archived Files

`<zoom-connector-mule-4:testget-record-archived-files>`

List the archived recording files of the specific meeting instance. For more information, read our
[Managing archiving of meeting and webinar data](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067188)
documentation. This operation makes an HTTP GET request to the
/past\_meetings/{meetingUUID}/archive\_files endpoint.

- Prerequisites: Enable cloud recording. Follow the
  [enablement process](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067188#h_01ENPBD3WR68D7FAKTBY92SG45)
  to access the archiving feature.

- Scopes: `recording:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Meeting UUID</p></td><td><div><div><p>String</p></div></div></td><td><p>The meeting’s universally unique identifier (UUID). Each meeting instance generates a UUID. For example, after a meeting ends, a new UUID is generated for the next meeting instance. If the meeting UUID begins with a <code>/</code> character or contains a <code>//</code> character, you <strong>must</strong> double-encode the meeting UUID when using the meeting UUID for other API calls.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Trackingfield Create

`<zoom-connector-mule-4:trackingfield-create>`

[Tracking fields](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067020) enable
you to analyze usage by various fields within an organization. Use this API to create a new tracking
field. This operation makes an HTTP POST request to the /tracking\_fields endpoint.

- Prerequisites: Business, Education, API, or higher plan

- Scope: `trackingfield:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Trackingfield Delete

`<zoom-connector-mule-4:trackingfield-delete>`

[Tracking fields](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067020) enable
you to analyze usage by various fields within an organization. Use this API to delete a tracking
field. This operation makes an HTTP DELETE request to the /tracking\_fields/{fieldId} endpoint.

- Prerequisites: Business, Education, API, or higher plan.

- Scope: `trackingfield:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Field Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The Tracking Field ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Trackingfield Get

`<zoom-connector-mule-4:trackingfield-get>`

[Tracking fields](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067020) enable
you to analyze usage by various fields within an organization. When scheduling a meeting, the
tracking field is included in the meeting options. Use this API to get information on a tracking
field. This operation makes an HTTP GET request to the /tracking\_fields/{fieldId} endpoint.

- Prerequisites: Business, Education, API, or higher plan

- Scopes: `trackingfield:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Field Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The Tracking Field ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Trackingfield List

`<zoom-connector-mule-4:trackingfield-list>`

[Tracking fields](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067020) enable
you to analyze usage by various fields within an organization. Use this API to list all the tracking
fields on your Zoom account. This operation makes an HTTP GET request to the /tracking\_fields
endpoint.

- Prerequisites: Business, Education, API, or higher plan

- Scopes: `trackingfield:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Trackingfield Update

`<zoom-connector-mule-4:trackingfield-update>`

[Tracking fields](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067020) enable
you to analyze usage by various fields within an organization. Use this API to update a tracking
field. This operation makes an HTTP PATCH request to the /tracking\_fields/{fieldId} endpoint.

- Prerequisites: Business, Education, API, or higher plan

- Scope: `trackingfield:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Field Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The Tracking Field ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Tsp

`<zoom-connector-mule-4:tsp>`

Get information on the Telephony Service Provider on an account level. This operation makes an HTTP
GET request to the /tsp endpoint.

- Prerequisites: A Pro or a higher plan.

- Scopes: `tsp:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Tsp Update

`<zoom-connector-mule-4:tsp-update>`

Update information of the Telephony Service Provider set up on an account. This operation makes an
HTTP PATCH request to the /tsp endpoint.

- Prerequisites: TSP account option should be enabled.

- Scopes: `tsp:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Tsp Url Update

`<zoom-connector-mule-4:tsp-url-update>`

A global dial-in page can provide a list of global access numbers to use for audio conferencing. By
calling this API, you can set the URL for the global dial-in page of a user whose Zoom account has
TSP and special TSP with third-party audio conferencing options enabled. This operation makes an
HTTP PATCH request to the /users/{userId}/tsp/settings endpoint.

- Scopes: `tsp:write:admin` `tsp:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The userId or email address of the user.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Un Assign Phone Num Call Queue

`<zoom-connector-mule-4:un-assign-phone-num-call-queue>`

After assigning a phone number, you can unbind it if you don’t want it to be assigned to a
[call queue](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064844). Use this
API to unbind a phone number from a Call Queue. After successful unbinding, the number will appear
in the [Unassigned tab](https://www.zoom.com/signin#/numbers/unassigned). This operation makes an
HTTP DELETE request to the /phone/call\_queues/{callQueueId}/phone\_numbers/{phoneNumberId}
endpoint.

- Prerequisites: Pro or higher account plan. Account owner or admin permissions. Zoom Phone license.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Call Queue Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the call queue. This can be retrieved from the List Call Queues API.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Phone Number Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the Phone Number.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Unassign All Members

`<zoom-connector-mule-4:unassign-all-members>`

Use this API to remove all members from a Call Queue who were previously assigned to that Call
Queue. The members could be phone users or
[common area phones](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066552).
This operation makes an HTTP DELETE request to the /phone/call\_queues/{callQueueId}/members
endpoint.

- Prerequisites: Pro or higher account plan. Zoom Phone license.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Call Queue Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Call Queue ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Unassign All Phone Nums Auto Receptionist

`<zoom-connector-mule-4:unassign-all-phone-nums-auto-receptionist>`

Unassign all phone numbers that were previously assigned to an
[auto receptionist](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061421). This
operation makes an HTTP DELETE request to the
/phone/auto\_receptionists/{autoReceptionistId}/phone\_numbers endpoint.

- Prerequisites: Pro or higher account plan with Zoom Phone License. Account owner or admin
  permissions.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Auto Receptionist Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Auto Receptionist ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Unassign A Phone Num Auto Receptionist

`<zoom-connector-mule-4:unassign-aphone-num-auto-receptionist>`

Unassign a specific phone number that was previously assigned to an
[auto receptionist](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061421). This
operation makes an HTTP DELETE request to the
/phone/auto\_receptionists/{autoReceptionistId}/phone\_numbers/{phoneNumberId} endpoint.

- Prerequisites: Pro or higher account plan with Zoom Phone License. Account owner or admin
  permissions.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Auto Receptionist Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the auto receptionist. This can be retrieved from the List Phone Sites API.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Phone Number Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the phone number or provide the actual phone number in e164 format (example: +19995550123).</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Unassign A Phone Num Call Queue

`<zoom-connector-mule-4:unassign-aphone-num-call-queue>`

Use this API to unbind all phone numbers that are assigned to a
[call queue](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064844). After
successful unbinding, the numbers will appear in the
[Unassigned tab](https://www.zoom.com/signin#/numbers/unassigned). If you only need to unassign a
specific phone number, use the Unassign a Phone Number API instead. This operation makes an HTTP
DELETE request to the /phone/call\_queues/{callQueueId}/phone\_numbers endpoint.

- Prerequisites: Pro or higher account plan. Account owner or admin permissions. Zoom Phone license.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Call Queue Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the call queue. This can be retrieved from List Call Queues API.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Unassign Calling Plan

`<zoom-connector-mule-4:unassign-calling-plan>`

Use this API to unassign a
[Zoom Phone](https://support.zoom.com/hc/en/category?id=kb_category&kb_category=5b8432168720391089a37408dabb35b0)
user’s
[calling plan](https://developers.zoom.us/docs/api/references/billing-plans/#zoom-phone-calling-plans).
For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. This operation makes an HTTP DELETE request to the
/phone/users/{userId}/calling\_plans/{type} endpoint.

- Prerequisites: A Business or Enterprise account. A Zoom Phone license.

- Scopes: `phone:write`, `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>User ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>type</p></td><td><div><div><p>String</p></div></div></td><td><p>The <a href="https://developers.zoom.us/docs/api/references/billing-plans/#zoom-phone-calling-plans">type</a> of the calling plan that was assigned to user. (e.g: The value of type would be "200" for the Unlimited US/Canada calling plan.)</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Unassign Calling Plans From Common Area Phone

`<zoom-connector-mule-4:unassign-calling-plans-from-common-area-phone>`

Use this API to unassign a calling plan from a common area phone. This operation makes an HTTP
DELETE request to the /phone/common\_area\_phones/{commonAreaPhoneId}/calling\_plans/{type}
endpoint.

- Prerequisites: A Pro or higher account with a Zoom Phone license. An account owner or admin
  permissions.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Common Area Phone Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The common area phone''s unique ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>type</p></td><td><div><div><p>String</p></div></div></td><td><p>The <a href="https://developers.zoom.us/docs/api/references/billing-plans/#zoom-phone-calling-plans">calling plan</a> to remove.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Unassign Member From Call Queue

`<zoom-connector-mule-4:unassign-member-from-call-queue>`

Use this API to remove a member from a Call Queue who was previously added to that Call Queue. The
member could be a phone user or a
[common area phone](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066552). A
member who is a Call Queue Manager cannot be unassigned from the Call Queue using this API. This
operation makes an HTTP DELETE request to the /phone/call\_queues/{callQueueId}/members/{memberId}
endpoint.

- Prerequisites: Pro or higher account plan. Zoom Phone license.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Call Queue Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the Call Queue from which the member needs to be unassigned.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Member Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the member who needs to be unassigned.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Unassign Phone Number

`<zoom-connector-mule-4:unassign-phone-number>`

Use this API to unassign a Zoom Phone user’s
[phone number](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060212#h_38ba8b01-26e3-4b1b-a9b5-0717c00a7ca6).
For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. After assigning a phone number, you can remove it if you do not want it to be
assigned to anyone. This operation makes an HTTP DELETE request to the
/phone/users/{userId}/phone\_numbers/{phoneNumberId} endpoint.

- Prerequisites: A Business or Enterprise account. A Zoom Phone license. The user must have been
  previously assigned a Zoom Phone number.

- Scopes: `phone:write`, `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Provide either userId or email address of the user.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Phone Number Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Provide either phone number or phoneNumberId of the user.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Unassign Phone Numbers From Common Area Phone

`<zoom-connector-mule-4:unassign-phone-numbers-from-common-area-phone>`

Use this API to unassign a phone number from a common Area phone. This operation makes an HTTP
DELETE request to the /phone/common\_area\_phones/{commonAreaPhoneId}/phone\_numbers/{phoneNumberId}
endpoint.

- Prerequisites: A Pro or a higher account with a Zoom Phone license. An account owner or admin
  permissions.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Common Area Phone Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The common area phone''s unique ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Phone Number Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The phone number or the phone number''s unique ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Update Account Lock Settings

`<zoom-connector-mule-4:update-account-lock-settings>`

[Account Locked Settings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065579)
enable turning settings on or off for all users in your account. No user except the account admin or
account owner can change these settings. With lock settings, you force the settings on for all
users. Use this API to update an account’s locked settings. Note that this API can be used by Zoom
Accounts that are on a Pro or a higher plan as well accounts that have master and sub accounts
options enabled. This operation makes an HTTP PATCH request to the
/accounts/{accountId}/lock\_settings endpoint.

- Prerequisites: Pro or a higher paid account.

- Scope: `account:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the account. To retrieve locked settings of the master account or a regular account, provide "me" as the value of this field. To retrieve locked settings of a sub account, provide the Account ID of the sub account in this field.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Update Account Owner

`<zoom-connector-mule-4:update-account-owner>`

Use this API to change an account’s owner. An account’s current owner can
[change the account’s owner](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064127)
to another user on the same account. This operation makes an HTTP PUT request to the
/accounts/{accountId}/owner endpoint.

- Prerequisites: An account owner or admin permissions of an account. The account making this API
  request must be on a Pro or a higher account plan with
  [master account](https://developers.zoom.us/docs/api/ma/) privileges.

- Scopes: `account:write:admin` or `account:master`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The account''s account ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Update A Device

`<zoom-connector-mule-4:update-adevice>`

Update information of a
[desk phone device](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061431). This
operation makes an HTTP PATCH request to the /phone/devices/{deviceId} endpoint.

- Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin
  permissions.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Device Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the device.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Update A Group Member

`<zoom-connector-mule-4:update-agroup-member>`

If a user is a member in multiple groups, you can
[set a primary group](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062584#h_d07c7dcd-4fd8-485a-b5fe-a322e8d21c09)
for the user. The group member will use the primary group’s settings by default. However, if
settings are locked in other groups, those settings continue to be locked for that user. By default,
the primary group is the first group that user is added to. Use this API to perform either of the
following tasks: Simultaneously remove a member from one group and move the member to a different
group, or set a primary group for the user. This operation makes an HTTP PATCH request to the
/groups/{groupId}/members/{memberId} endpoint.

- Prerequisites: Pro or higher account

- Scopes: `group:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Group Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the group. Can be retrieved by calling <a href="https://developers.zoom.us/docs/api/">GET /groups</a> API. To change a member''s primary group, provide the groupId of the member''s current primary group as the value of this field. To remove a member from one group and move the member to another group, provide the groupId of the group from which the member is to be moved.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Member Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the group member. Can be retrieved by calling the [List Group Members](https://docs.mulesoft.com/zoom-connector/latest/%3Ca href="https://developers.zoom.us/docs/api/">https://developers.zoom.us/docs/api/</a>) API.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Update A Shared Line Group

`<zoom-connector-mule-4:update-ashared-line-group>`

A [shared line group](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066509)
allows Zoom Phone admins to share a phone number and extension with a group of phone users or common
area phones. This gives members of the shared line group access to the group’s direct phone number
and voicemail. Use this API to update the information of a Shared Line Group. This operation makes
an HTTP PATCH request to the /phone/shared\_line\_groups/{sharedLineGroupId} endpoint.

- Prerequisites: \* Pro or higher account with Zoom Phone license. Account owner or admin
  privileges.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Shared Line Group Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the shared line group that is to be updated.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Update Auto Receptionist

`<zoom-connector-mule-4:update-auto-receptionist>`

An auto receptionist answers calls with a personalized recording and routes calls to a phone user,
call queue, common area phone, or voicemail. An auto receptionist can also be set up so that it
routes calls to an interactive voice response (IVR) system to allow callers to select the routing
options. Use this API to
[change the information](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061421#h_1d5ffc56-6ba3-4ce5-9d86-4a1a1ee743f3)
, such as display name and extension number, assigned to the main auto receptionist. This operation
makes an HTTP PATCH request to the /phone/auto\_receptionists/{autoReceptionistId} endpoint.

- Prerequisites: Pro or higher account with Zoom Phone license.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Auto Receptionist Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the Auto Receptionist. It can be retrieved from the [List Sites API](https://docs.mulesoft.com/zoom-connector/latest/%3Ca href="https://developers.zoom.us/docs/api/phone/#tag/sites/GET/phone/sites">https://developers.zoom.us/docs/api/phone/#tag/sites/GET/phone/sites</a>).</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Update Blocked List

`<zoom-connector-mule-4:update-blocked-list>`

A Zoom account owner or a user with admin privilege can block phone numbers for phone users in an
account. Blocked numbers can be inbound (numbers will be blocked from calling in) and outbound
(phone users in your account won’t be able to dial those numbers). Blocked callers will hear a
generic message stating that the person they are calling is not available. Use this API to update
information on the blocked list. This operation makes an HTTP PATCH request to the
/phone/blocked\_list/{blockedListId} endpoint.

- Prerequisites: Pro or higher account plan with Zoom phone license

- Scope: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Blocked List Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the blocked list.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Update Call Queue

`<zoom-connector-mule-4:update-call-queue>`

Call queues allow you to route incoming calls to a group of users. For instance, you can use call
queues to route calls to various departments in your organization such as sales, engineering,
billing, or customer service. Use this API to update information of a specific Call Queue. This
operation makes an HTTP PATCH request to the /phone/call\_queues/{callQueueId} endpoint.

- Prerequisites: Pro, Business, or Education account. Account owner or admin permissions. Zoom Phone
  license.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Call Queue Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the call queue.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Update Channel

`<zoom-connector-mule-4:update-channel>`

Use this API to update the name of a specific channel created by a user. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. Zoom chat channels allow users to communicate via chat in private or public
channels. This operation makes an HTTP PATCH request to the
/chat/users/{userId}/channels/{channelId} endpoint.

- Scopes: `chat_channel:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

Note: For an account-level [OAuth app](https://developers.zoom.us/docs/integrations/create/), this
API can only be used on behalf of a user who is assigned with a
[role](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit)
that has the Edit permission for Chat Channel.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Channel Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Channel ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the Zoom user who is the owner of the channel.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Update Common Area Phone

`<zoom-connector-mule-4:update-common-area-phone>`

Use this API to update details on a specific
[common area phone](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066552) in an
account. A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that
anyone in an organization can use it, for example, if your office has shared desks that don’t belong
to a specific employee, you could add a common area phone so that any person can use it. This
operation makes an HTTP PATCH request to the /phone/common\_area\_phones/{commonAreaPhoneId}
endpoint.

- Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin
  permissions. A
  [supported device](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060242).

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Common Area Phone Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Common Area Phone ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Update External Contact

`<zoom-connector-mule-4:update-external-contact>`

Use this API to update an external contact’s information. This operation makes an HTTP PATCH request
to the /phone/external\_contacts/{externalContactId} endpoint.

- Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin
  permissions.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>External Contact Id</p></td><td><div><div><p>String</p></div></div></td><td><p>External contact ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Update Group Settings

`<zoom-connector-mule-4:update-group-settings>`

Update settings for a
[group](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062584). Note: The
`force_pmi_jbh_password` field under meeting settings is planned to be deprecated on September
22, 2019. This field will be replaced by another field that will provide the same functionality.
This operation makes an HTTP PATCH request to the /groups/{groupId}/settings endpoint.

- Prerequisites: Pro, Business, or Education account

- Scopes: `group:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Group Id</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the group.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Custom query fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Provide the name of the field by which you would like to filter the response. For example, if you provide "host_video" as the value of this field, you will get a response similar to the following: { "schedule_meeting": { "host_video": false } } You can provide multiple values by separating them with commas(example: "host_video,participant_video).</p></td><td></td><td></td></tr><tr><td><p>option</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>MEETING_AUTHENTICATION</p></li><li><p>RECORDING_AUTHENTICATION</p></li><li><p>MEETING_SECURITY</p></li></ul></div></div></td><td><p>option</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Update Location

`<zoom-connector-mule-4:update-location>`

Use this API to update an emergency location’s information. This operation makes an HTTP PATCH
request to the /phone/locations/{locationId} endpoint.

- Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin
  permissions.

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Location Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The emergency service location’s ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Update Phone Number Details

`<zoom-connector-mule-4:update-phone-number-details>`

Use this API to update a Zoom Phone number’s information. This operation makes an HTTP PATCH request
to the /phone/numbers/{numberId} endpoint.

- Prerequisites: A Paid account

- Scopes: `phone:write`, `phone:write:admin`, `phone:master`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Number Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Phone number ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Update Phone Settings

`<zoom-connector-mule-4:update-phone-settings>`

[Master account owners](https://developers.zoom.us/docs/api/ma/) can use this API to enable the BYOC
(Bring Your Own Carrier) option for a subaccount. This operation makes an HTTP PATCH request to the
/phone/settings endpoint.

- Prerequisites: A Business or Enterprise account

- Scopes: `phone:master`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the sub account.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Update Phone Sip Trunk

`<zoom-connector-mule-4:update-phone-siptrunk>`

Use this API to update a subaccount’s assigned SIP (Session Initiation Protocol) trunk information.
This operation makes an HTTP PATCH request to the
/accounts/{accountId}/phone/sip\_trunk/trunks/{sipTrunkId} endpoint.

- Prerequisites: A Business or Enterprise account

- Scopes: `phone:master`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Sip Trunk Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the SIP trunk.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the sub account.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Update Presence Status

`<zoom-connector-mule-4:update-presence-status>`

Use this API to update a user’s presence status. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. A user’s status cannot be updated more than once per minute, for example, you
can only submit a maximum of one update request per minute for a single user. Users in the Zoom
desktop client and mobile apps are assigned with a
[presence status](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065488). The
presence status informs users of their contact’s availability. Users can also change their own
presence status to one of the following: **Away**, **Do not disturb**, **Available**, **In a
calendar event**, **Presenting**, **In a Zoom meeting**, or **On a call**. Note that a user’s
presence status cannot be updated via this API if the user is not logged in to the Zoom client. This
operation makes an HTTP PUT request to the /users/{userId}/presence\_status endpoint.

- Scopes: `user:write`, `user:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>User ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Update Role

`<zoom-connector-mule-4:update-role>`

Each Zoom user automatically has a
[role](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983) which can either
be owner, administrator, or a member. Account Owners and users with edit privileges for Role
management can add customized roles with a list. Use this API to change the privileges, name, and
description of a specific role. This operation makes an HTTP PATCH request to the /roles/{roleId}
endpoint.

- Prerequisites: A Pro or higher plan. For role management and updates, you must be the Account
  Owner or user with role management permissions.

- Scopes: `role:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Role Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Role ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Update Room Profile

`<zoom-connector-mule-4:update-room-profile>`

Update basic information on a specific Zoom Room in a Zoom account. This operation makes an HTTP
PATCH request to the /rooms/{roomId} endpoint.

- Prerequisites: Pro or a higher plan with Zoom Room license.

- Scopes: `room:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Room Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of a Zoom Room.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Update Setting Template

`<zoom-connector-mule-4:update-setting-template>`

Use this API to update or modify a phone template’s settings. This operation makes an HTTP PATCH
request to the /phone/setting\_templates/{templateId} endpoint.

- Prerequisites: A Business or Enterprise account. A Zoom Phone license.

- Scopes: `phone:write:admin` or `phone:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Template Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The Template ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Update Sip Phone

`<zoom-connector-mule-4:update-sipphone>`

Zoom’s Phone System Integration (PSI), also referred as SIP phones, enables an organization to
leverage the Zoom client to complete a softphone registration to supported premise based PBX system.
End users will have the ability to have softphone functionality within a single client while
maintaining a comparable interface to Zoom Phone. Use this API to update information of a specific
SIP Phone on a Zoom account. This operation makes an HTTP PATCH request to the
/sip\_phones/{phoneId} endpoint.

- Prerequisites: Currently only supported on Cisco and Avaya PBX systems. The account owner or
  account admin must first enable SIP Phone Integration by contacting the Zoom Sales team.

- Scope: `sip_phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Phone Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the SIP Phone. This can be retrieved from the List SIP Phones API.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Update Site Details

`<zoom-connector-mule-4:update-site-details>`

Sites allow you to organize Zoom Phone users in your organization. Use this API to update
information about a specific
[site](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0069716). This operation
makes an HTTP PATCH request to the /phone/sites/{siteId} endpoint.

- Prerequisites: Account must have a Pro or a higher plan with Zoom Phone license.

- Scope: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the site.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Update User Level Channel

`<zoom-connector-mule-4:update-user-level-channel>`

Zoom chat channels allow users to communicate via chat in private or public channels. Use this API
to update the name of a specific channel that you created. This operation makes an HTTP PATCH
request to the /chat/channels/{channelId} endpoint.

- Scope: `chat_channel:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

Note that this API only supports user-managed
[OAuth app](https://developers.zoom.us/docs/integrations/create/).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Channel Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Channel ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Update User Profile

`<zoom-connector-mule-4:update-user-profile>`

Use this API to update a user’s
[Zoom Phone](https://support.zoom.com/hc/en/category?id=kb_category&kb_category=5b8432168720391089a37408dabb35b0)
profile. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. This operation makes an HTTP PATCH request to the /phone/users/{userId}
endpoint.

- Prerequisites: A Business or Enterprise account. A Zoom Phone license.

- Scopes: `phone:write`, `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>User ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Update User Setting

`<zoom-connector-mule-4:update-user-setting>`

Use this API to update the voicemail access permissions of a user. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. Phone users can access
[shared voicemail inboxes](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0069406)
in the Zoom desktop client, web portal, or provisioned desk phone. To view these settings in the
Zoom web portal, navigate to the Admin Phone System Management and Users Rooms interface. Click the
**Users** tab and select **User Settings**. Scroll down to **Voicemail Call Recordings**. This
operation makes an HTTP PATCH request to the /phone/users/{userId}/settings/{settingType} endpoint.

- Prerequisites: A Business or Enterprise account

- Scopes: `phone:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Setting Type</p></td><td><div><div><p>String</p></div></div></td><td><p>Corresponds to the setting item you wish to modify. Allowed values: <code>voice_mail</code>.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the user.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Update Zoom Room Acc Settings

`<zoom-connector-mule-4:update-zoom-room-acc-settings>`

Update account settings applied for Zoom Rooms in a Zoom account. With this API, you can update
either the Account Meeting Settings or the Alert Settings (Client Alert Settings and Notfication
Settings) of the Zoom Rooms account by specifying the required setting type in the `setting_type`
parameter. To update only Alert Settings, specify `alert` as the value of the `setting_type` query
parameter and to update only Account Meeting Settings, specify `meeting` as the value of the
`setting_type` query parameter. This operation makes an HTTP PATCH request to the
/rooms/account\_settings endpoint.

- Prerequisites: Zoom Room licenses. Owner or Admin privileges on the Zoom Account.

- Scopes: `room:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Setting type</p></td><td><div><div><p>String</p></div></div></td><td><p>The type of setting that you would like to update.</p><p>* <code>alert</code></p><p>Alert Settings applied on the Zoom Rooms Account.</p><p>* <code>meeting</code></p><p>Meeting settings of the Zoom Rooms Account.</p><p>* <code>signage</code></p><p>View digital signage settings of the Zoom Rooms Account.</p></td><td><p>meeting</p></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Update Zoom Rooms Location Structure

`<zoom-connector-mule-4:update-zoom-rooms-location-structure>`

Update the
[location hierarchial structure(s)](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063345)
applied on the Zoom Rooms in an account. This operation makes an HTTP PATCH request to the
/rooms/locations/structure endpoint.

- Prerequisites: Zoom Rooms version 4.0 or higher. Account owner or admin permissions.

- Scopes: `room:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Update Zr Acc Profile

`<zoom-connector-mule-4:update-zracc-profile>`

Update information on the account profile of a Zoom Room. This information can only by accessed
either by the Zoom Room Account Owner or a user with Zoom Rooms admin permission. To update
information on an individual Room Profile, use
[Update Zoom Room Profile API](https://developers.zoom.us/docs/api/) instead. This operation makes
an HTTP PATCH request to the /rooms/account\_profile endpoint.

- Prerequisites: Zoom account owner or Zoom Rooms admin permissions

- Scopes: `room:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Update Zr Location Profile

`<zoom-connector-mule-4:update-zrlocation-profile>`

Each location type of the
[Zoom Rooms Location Hierarchy](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063345)
has a profile page that includes information such as name of the location, address, support email,
etc. Use this API to update information about a specific Zoom Rooms location type such as
information about the city where the Zoom Rooms are located. This operation makes an HTTP PATCH
request to the /rooms/locations/{locationId} endpoint.

- Prerequisites: Account owner or admin permission. Zoom Rooms version 4.0 or higher.

- Scopes: `room:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Location Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the location. This can be retrieved from the [List Zoom Room Locations](https://docs.mulesoft.com/zoom-connector/latest/%3Ca href="https://developers.zoom.us/docs/api/">https://developers.zoom.us/docs/api/</a>) API.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Update Zr Location Settings

`<zoom-connector-mule-4:update-zrlocation-settings>`

Update information on either meeting or alert settings applied to Zoom Rooms located in a specific
location. To update Alert Settings, specify `alert` as the value of the `setting_type` query
parameter. Similarly, to update **Meeting Settings**, specify `meeting` as the value of the
`setting_type` query parameter. This operation makes an HTTP PATCH request to the
/rooms/locations/{locationId}/settings endpoint.

- Prerequisites: Zoom Room licenses. Owner or Admin privileges on the Zoom Account.

- Scopes: `room:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Location Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the location type. This can be retrieved using the [List Zoom Room Location API](https://docs.mulesoft.com/zoom-connector/latest/%3Ca href="https://developers.zoom.us/docs/api/">https://developers.zoom.us/docs/api/</a>) (Id property in the response).</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Setting type</p></td><td><div><div><p>String</p></div></div></td><td><p>The type of setting that you would like to update.</p><p>* <code>alert</code></p><p>Alert Settings applied on the Zoom Rooms Account.</p><p>* <code>meeting</code></p><p>Meeting settings of the Zoom Rooms Account.</p><p>* <code>signage</code></p><p>Digital signage settings.</p></td><td><p>meeting</p></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Update Zr Settings

`<zoom-connector-mule-4:update-zrsettings>`

Update either meeting or alert settings applied to a specific Zoom Room. To update Alert Settings,
specify `alert` as the value of the `setting_type` query parameter. To update **Meeting Settings**,
specify `meeting` as the value of the `setting_type` query parameter. This operation makes an HTTP
PATCH request to the /rooms/{roomId}/settings endpoint.

- Prerequisites: Zoom Room licenses. Owner or Admin privileges on the Zoom Account.

- Scopes: `room:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Room Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the Zoom Room.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Setting type</p></td><td><div><div><p>String</p></div></div></td><td><p>The type of setting that you would like to update. <code>alert</code>: Alert Settings applied on the Zoom Room. <code>meeting</code>: Meeting settings of the Zoom Room. <code>signage</code>: Digital signage settings applied on the Zoom Room.</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Upload Group Vb

`<zoom-connector-mule-4:upload-group-vb>`

Use this API to
[upload virtual background files](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060387)
for all users in a group to use. This operation makes an HTTP POST request to the
/groups/{groupId}/settings/virtual\_backgrounds endpoint.

- Prerequisites: Virtual background feature must be
  [enabled](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060387) on the
  account.

- Scope: `group:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Group Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the group. Retrieve the value for this field by calling the <a href="https://developers.zoom.us/docs/api/">List groups</a> API.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>File ids</p></td><td><div><div><p>String</p></div></div></td><td><p>Provide the ID of the file that is to be deleted. To delete multiple files, provide comma-separated values for this field.</p></td><td></td><td></td></tr><tr><td><p>File - Body</p></td><td><div><div><p>String</p></div></div></td><td><p>The content of the 'file' part.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Upload Vb

`<zoom-connector-mule-4:upload-vb>`

Use this API to
[upload virtual background files](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060387)
for all users on the account to use. This operation makes an HTTP POST request to the
/accounts/{accountId}/settings/virtual\_backgrounds endpoint.

- Prerequisites: Virtual background feature must be
  [enabled](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060387) on the
  account.

- Scope: `account:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Account Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the account.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>File - Body</p></td><td><div><div><p>String</p></div></div></td><td><p>The content of the 'file' part.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Upload V Buser

`<zoom-connector-mule-4:upload-vbuser>`

Use this API to
[upload virtual background files](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060387)
to a user’s profile. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. Note: A user profile cannot exceed more than 10 files. This operation makes an
HTTP POST request to the /users/{userId}/settings/virtual\_backgrounds endpoint.

- Prerequisites: Virtual background feature must be
  [enabled](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060387) on the
  account.

- Scopes: `user:write:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the user. Retrieve the value for this field by calling the <a href="https://developers.zoom.us/docs/api/">List users</a> API.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>File - Body</p></td><td><div><div><p>String</p></div></div></td><td><p>The content of the 'file' part.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## User

`<zoom-connector-mule-4:user>`

View a specific user’s information on a Zoom account. A Zoom account can have one or more users. For
user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. Note: Users who have not activated their account have a status of pending, and
the created\_at time displays the time at which the API call was made. This operation makes an HTTP
GET request to the /users/{userId} endpoint.

- Scopes: `user:read:admin`, `user:read`, `user_info:read`. Note: The `user_info:read` scope is only
  available when you pass the `me` value for the `$userId` value.

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Login type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>j_0</p></li><li><p>j_1</p></li><li><p>j_11</p></li><li><p>j_21</p></li><li><p>j_23</p></li><li><p>j_24</p></li><li><p>j_27</p></li><li><p>j_97</p></li><li><p>j_98</p></li><li><p>j_99</p></li><li><p>j_100</p></li><li><p>j_101</p></li></ul></div></div></td><td><p>The user’s login method:</p><p>* <code>0</code> - Facebook OAuth</p><p>* <code>1</code> - Google OAuth</p><p>* <code>24</code> - Apple OAuth</p><p>* <code>27</code> - Microsoft OAuth</p><p>* <code>97</code> - Mobile device</p><p>* <code>98</code> - RingCentral OAuth</p><p>* <code>99</code>- API user</p><p>* <code>100</code> - Zoom Work email</p><p>* <code>101</code> - Single Sign-On (SSO)</p><p>The following login methods are available only in China:</p><p>* <code>11</code> - Phone number</p><p>* <code>21</code> - WeChat</p><p>* <code>23</code> - Alipay</p></td><td></td><td></td></tr><tr><td><p>Encrypted email</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether the email address passed for the <code>userId</code> value is an encrypted email address:</p><p>* <code>true</code></p><p>The email address is encrypted.</p><p>* <code>false</code></p><p>The email address is not encrypted. If you do not query this parameter, this value defaults to null (<code>false</code>).</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## User Assistant Create

`<zoom-connector-mule-4:user-assistant-create>`

Use this API to assign assistants to a user. In the request body, provide either the user’s ID or
the user’s email address. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. Assistants are the users to whom the current user has assigned
[the scheduling privilege](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061749).
These assistants can schedule meeting on behalf of the current user as well as manage and act as an
alternative host for all meetings if the admin has enabled
[Co-host option](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066640) on the
account. This operation makes an HTTP POST request to the /users/{userId}/assistants endpoint.

- Prerequisites: The user as well as the assistant must have Licensed or an On-prem license.
  Assistants must be under the current user’s account.

- Scopes: `user:write:admin`, `user:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## User Assistant Delete

`<zoom-connector-mule-4:user-assistant-delete>`

Delete a specific assistant of a user. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. Assistants are the users to whom the current user has assigned
[the scheduling privilege](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061749).
These assistants can schedule meeting on behalf of the current user as well as manage and act as an
alternative host for all meetings if the admin has enabled
[Co-host option](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066640) on the
account. This operation makes an HTTP DELETE request to the /users/{userId}/assistants/{assistantId}
endpoint.

- Prerequisites: The user as well as the assistant must have Licensed or an On-prem license.
  Assistants must be under the current user’s account.

- Scopes: `user:write:admin`, `user:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Assistant Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Assistant ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## User Assistants

`<zoom-connector-mule-4:user-assistants>`

List a user’s assistants. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. Assistants are the users to whom the current user has assigned
[the scheduling privilege](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061749).
These assistants can schedule meeting on behalf of the current user as well as manage and act as an
alternative host for all meetings if the admin has enabled
[Co-host option](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066640) on the
account. This operation makes an HTTP GET request to the /users/{userId}/assistants endpoint.

- Prerequisites: Current user as well as the assistant must have Licensed or an On-prem license.
  Assistants must be under the current user’s account.

- Scopes: `user:read:admin`, `user:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## User Assistants Delete

`<zoom-connector-mule-4:user-assistants-delete>`

Delete all assistants of the current user. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. Assistants are the users to whom the current user has assigned
[the scheduling privilege](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061749).
These assistants can schedule meeting on behalf of the current user as well as manage and act as an
alternative host for all meetings if the admin has enabled
[Co-host option](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066640) on the
account. This operation makes an HTTP DELETE request to the /users/{userId}/assistants endpoint.

- Prerequisites: The user as well as the assistant must have Licensed or an On-prem license.
  Assistants must be under the current user’s account.

- Scopes: `user:write:admin`, `user:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## User Create

`<zoom-connector-mule-4:user-create>`

A Zoom account can have one or more users. Use this API to add a new user to your account. This
operation makes an HTTP POST request to the /users endpoint.

- Prerequisites: Pro or higher plan

- Scopes: `user:write:admin` `user:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## User Delete

`<zoom-connector-mule-4:user-delete>`

Use this API to disassociate (unlink) a user or permanently delete a user. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. Deleting a user permanently removes the user and their data from Zoom. Users can
create a new Zoom account using the same email address. An account owner or an account admin can
transfer meetings, webinars, and cloud recordings to another Zoom user account before deleting.
Disassociating a user unlinks the user from the associated Zoom account and provides the user their
own basic free Zoom account. The disassociated user can then purchase their own Zoom licenses. An
account owner or account admin can transfer the user’s meetings, webinars, and cloud recordings to
another user before disassociation. This operation makes an HTTP DELETE request to the
/users/{userId} endpoint.

- Scopes: `user:write:admin`, `user:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>action</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>DISASSOCIATE</p></li><li><p>DELETE</p></li></ul></div></div></td><td><p>Delete action options:</p><p>* <code>disassociate</code></p><p>Disassociate a user.</p><p>* <code>delete</code></p><p>Permanently delete a user. Note: To delete pending user in the account, use <code>disassociate</code>.</p></td><td><p>DISASSOCIATE</p></td><td></td></tr><tr><td><p>Transfer email</p></td><td><div><div><p>String</p></div></div></td><td><p>Transfer email.</p></td><td></td><td></td></tr><tr><td><p>Transfer meeting</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Transfer meeting.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Transfer webinar</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Transfer webinar.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Transfer recording</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Transfer recording.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## User Email

`<zoom-connector-mule-4:user-email>`

Verify if a user’s email is registered with Zoom. Note: You can successfully check if a user is a
registered Zoom user only if the user signed up for Zoom via email and is within your account. If
you provide an email address of a user who is not in your account, the value of "existed\_email"
parameter will be "false" irrespective of whether or not the user is registered with Zoom. The
response of this API call will not include users who joined Zoom using options such as "Sign in with
SSO", "Sign in with Google", or "Sign in with Facebook" even if they are in the same account as
yours. This operation makes an HTTP GET request to the /users/email endpoint.

- Scopes: `user:read:admin` `user:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>email</p></td><td><div><div><p>String</p></div></div></td><td><p>The email address to be verified.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## User Email Update

`<zoom-connector-mule-4:user-email-update>`

Change a user’s
[email address](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063624) on a Zoom
account that has managed domain set up. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. If the Zoom account in which the user belongs has multiple
[managed domains](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066259), then
the email to be updated must match one of the managed domains. A user’s email address can only be
changed for a maximum of 3 times in a day (24 hours). This operation makes an HTTP PUT request to
the /users/{userId}/email endpoint.

- Prerequisites: Managed domain must be enabled in the account. The new email address should not
  already exist in Zoom.

- Scopes: `user:write:admin`, `user:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## User Pa Cs

`<zoom-connector-mule-4:user-pacs>`

Use this API to list a user’s
[Personal Audio Conference](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060449)
accounts. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. PAC allows Pro or higher account holders to host meetings through PSTN (phone
dial-in) only. This operation makes an HTTP GET request to the /users/{userId}/pac endpoint.

- Prerequisites: A Pro or higher plan with
  [Premium Audio Conferencing](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060449)
  add-on. Personal Audio Conference must be enabled in the user’s profile.

- Scopes: `pac:read:admin`, `pac:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## User Password

`<zoom-connector-mule-4:user-password>`

Update a user’s
[password](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066204) for logging
into Zoom. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. After this request is processed successfully, an email notification is sent to
the user stating that the password was changed. This operation makes an HTTP PUT request to the
/users/{userId}/password endpoint.

- Prerequisites: Owner or admin of the Zoom account.

- Scopes: `user:write:admin` `user:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## User Permission

`<zoom-connector-mule-4:user-permission>`

Use this API to get permissions that have been granted to the user. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. Users can be assigned a set of permissions that allows them to access only the
pages/information that a user needs to view or edit. This operation makes an HTTP GET request to the
/users/{userId}/permissions endpoint.

- Scopes: `user:read:admin`, `user:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## User Picture

`<zoom-connector-mule-4:user-picture>`

Upload a user’s profile picture. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. Provide `multipart/form-data` as the value of the `content-type` header for this
request. This API supports `.jpeg` and `.png` file formats. This operation makes an HTTP POST
request to the /users/{userId}/picture endpoint.

- Scopes: `user:write:admin`, `user:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Pic _ file - Body</p></td><td><div><div><p>String</p></div></div></td><td><p>The content of the 'Pic file' part.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## User Scheduler Delete

`<zoom-connector-mule-4:user-scheduler-delete>`

Delete a scheduler. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. Schedulers are users on whose behalf the current user (assistant) can schedule
meetings for. By calling this API, the current user will no longer be a scheduling assistant of this
scheduler. This operation makes an HTTP DELETE request to the
/users/{userId}/schedulers/{schedulerId} endpoint.

- Prerequisites: Current user must be under the same account as the scheduler.

- Scopes: `user:write:admin`, `user:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Scheduler Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Scheduler’s ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## User Schedulers

`<zoom-connector-mule-4:user-schedulers>`

List all the schedulers of a user. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. Schedulers in this context are the users for whom the current user can schedule
meetings for. For example, if the current user (the user whose `userId` was passed in the `path`
parameter) is "user A", the response of this API will contain a list of user(s), for whom user A can
schedule and manage meetings. User A is the assistant of these users and thus has scheduling
privilege for these user(s). This operation makes an HTTP GET request to the
/users/{userId}/schedulers endpoint.

- Prerequisites: Current user must be under the same account as the scheduler.

- Scopes: `user:read:admin`, `user:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## User Schedulers Delete

`<zoom-connector-mule-4:user-schedulers-delete>`

Delete all of a user’s schedulers. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. Schedulers are users on whose behalf the current user (assistant) can schedule
meetings for. By calling this API, the current user will no longer be a scheduling assistant of any
user. This operation makes an HTTP DELETE request to the /users/{userId}/schedulers endpoint.

- Prerequisites: Current user (assistant) must be under the same account as the scheduler.

- Scopes: `user:write:admin`, `user:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## User Settings

`<zoom-connector-mule-4:user-settings>`

Retrieve a user’s settings. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. This operation makes an HTTP GET request to the /users/{userId}/settings
endpoint.

- Scopes: `user:read:admin`, `user:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Login type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>j_0</p></li><li><p>j_1</p></li><li><p>j_11</p></li><li><p>j_21</p></li><li><p>j_23</p></li><li><p>j_24</p></li><li><p>j_27</p></li><li><p>j_97</p></li><li><p>j_98</p></li><li><p>j_99</p></li><li><p>j_100</p></li><li><p>j_101</p></li></ul></div></div></td><td><p>The user’s login method:</p><p>* <code>0</code> - Facebook OAuth</p><p>* <code>1</code> - Google OAuth</p><p>* <code>24</code> - Apple OAuth</p><p>* <code>27</code> - Microsoft OAuth</p><p>* <code>97</code> - Mobile device</p><p>* <code>98</code> - RingCentral OAuth</p><p>* <code>99</code>- API user</p><p>* <code>100</code> - Zoom Work email</p><p>* <code>101</code> - Single Sign-On (SSO)</p><p>The following login methods are available only in China:</p><p>* <code>11</code> - Phone number</p><p>* <code>21</code> - WeChat</p><p>* <code>23</code> - Alipay</p></td><td></td><td></td></tr><tr><td><p>option</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>MEETING_AUTHENTICATION</p></li><li><p>RECORDING_AUTHENTICATION</p></li></ul></div></div></td><td><p>* <code>meeting_authentication</code></p><p>Use this query parameter to view <a href="https://support.zoom.com/hc/en/article?id=zm_kb&amp;sysparm_article=KB0061263">meeting authentication configuration</a> applied on the user’s account.</p><p>* <code>recording_authentication</code></p><p>Use this query parameter to view <a href="https://support.zoom.com/hc/en/article?id=zm_kb&amp;sysparm_article=KB0067223">recording authentication configuration</a> applied on the user’s account.</p><p>* <code>meeting_security</code></p><p>Use this query parameter to view meeting security settings applied on the user’s account.</p></td><td></td><td></td></tr><tr><td><p>Custom query fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Provide the name of the field by which you would like to filter the response. For example, if you provide "host_video" as the value of this field, you will get a response similar to the following: { "schedule_meeting": { "host_video": false } }. You can provide multiple values by separating them with commas (example: "host_video,participant_video).</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## User Settings Update

`<zoom-connector-mule-4:user-settings-update>`

Update a user’s settings. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. This operation makes an HTTP PATCH request to the /users/{userId}/settings
endpoint.

- Scopes: `user:write:admin`, `user:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>option</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>MEETING_AUTHENTICATION</p></li><li><p>RECORDING_AUTHENTICATION</p></li><li><p>MEETING_SECUIRTY</p></li></ul></div></div></td><td><p>option</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## User Sso Token Delete

`<zoom-connector-mule-4:user-ssotoken-delete>`

Revoke a user’s SSO token. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. After calling this API, the SSO user will be logged out of their current Zoom
session. This operation makes an HTTP DELETE request to the /users/{userId}/token endpoint.

- Scopes: `user:write:admin`, `user:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## User Status

`<zoom-connector-mule-4:user-status>`

Use this API to
[deactivate](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066997) an active
user or to [reactivate](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066997) a
deactivated user. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. An account owner or admins can deactivate as well as activate a user in a Zoom
account. Deactivating a user will remove all licenses associated with a user. It will prevent the
deactivated user from logging into their Zoom account. A deactivated user can be reactivated.
Reactivating a user grants the user access to login to their Zoom account. This operation makes an
HTTP PUT request to the /users/{userId}/status endpoint.

- Scopes: `user:write:admin`, `user:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## User Token

`<zoom-connector-mule-4:user-token>`

Retrieve a user’s token. For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. This token is used for starting meetings with the Client SDK. If a user signed
into Zoom using Google or Facebook, a null value will be returned for the token. To get the token
with this API, ask the user to sign into Zoom using their email and password instead. This operation
makes an HTTP GET request to the /users/{userId}/token endpoint.

- Scopes: `user:read:admin`, `user:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>TOKEN</p></li><li><p>ZAK</p></li></ul></div></div></td><td><p>User token types:</p><p>* <code>token</code></p><p>Used for starting meetings with the client SDK. This token expires in 14 days and a new token will be returned after the expiry.</p><p>* <code>zak</code></p><p>Used for generating the start meeting URL. The token expiration time is two hours. For API users, the expiration time is 90 days.</p></td><td></td><td></td></tr><tr><td><p>ttl</p></td><td><div><div><p>Number</p></div></div></td><td><p>Use this field in conjunction with the <code>type</code> field where the value of <code>type</code> field is <code>zak</code>. The value of this field denotes the expiry time of the <code>zak</code> token in seconds. For example, if you would like the zak token to be expired after one hour of the token generation, the value of this field should be <code>3600</code>.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## User Tsp

`<zoom-connector-mule-4:user-tsp>`

Each user can have a maximum of two TSP accounts. Use this API to retrieve details of a specific TSP
account enabled for a specific user. This operation makes an HTTP GET request to the
/users/{userId}/tsp/{tspId} endpoint.

- Scopes: `tsp:read:admin` `tsp:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Tsp Id</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>j_1</p></li><li><p>j_2</p></li></ul></div></div></td><td><p>TSP account ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## User Tsp Create

`<zoom-connector-mule-4:user-tspcreate>`

Add a user’s TSP account. This operation makes an HTTP POST request to the /users/{userId}/tsp
endpoint.

- Scopes: `tsp:write:admin` `tsp:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## User Tsp Delete

`<zoom-connector-mule-4:user-tspdelete>`

Delete a user’s TSP account. This operation makes an HTTP DELETE request to the
/users/{userId}/tsp/{tspId} endpoint.

- Scopes: `tsp:write:admin` `tsp:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Tsp Id</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>j_1</p></li><li><p>j_2</p></li></ul></div></div></td><td><p>TSP account ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## User Ts Ps

`<zoom-connector-mule-4:user-tsps>`

A user can have a maximum of two TSP accounts. Use this API to list all TSP accounts of a user. This
operation makes an HTTP GET request to the /users/{userId}/tsp endpoint.

- Scopes: `tsp:read:admin` `tsp:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## User Tsp Update

`<zoom-connector-mule-4:user-tspupdate>`

Update a user’s TSP account. This operation makes an HTTP PATCH request to the
/users/{userId}/tsp/{tspId} endpoint.

- Scopes: `tsp:write:admin` `tsp:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Tsp Id</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>j_1</p></li><li><p>j_2</p></li></ul></div></div></td><td><p>TSP account ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## User Update

`<zoom-connector-mule-4:user-update>`

Update information on a user’s
[Zoom profile](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060639). For
user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. This operation makes an HTTP PATCH request to the /users/{userId} endpoint.

- Scopes: `user:write:admin` `user:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Login type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>j_0</p></li><li><p>j_1</p></li><li><p>j_11</p></li><li><p>j_21</p></li><li><p>j_23</p></li><li><p>j_24</p></li><li><p>j_27</p></li><li><p>j_97</p></li><li><p>j_98</p></li><li><p>j_99</p></li><li><p>j_100</p></li><li><p>j_101</p></li></ul></div></div></td><td><p>The user’s login method:</p><p>* <code>0</code> - Facebook OAuth</p><p>* <code>1</code> - Google OAuth</p><p>* <code>24</code> - Apple OAuth</p><p>* <code>27</code> - Microsoft OAuth</p><p>* <code>97</code> - Mobile device</p><p>* <code>98</code> - RingCentral OAuth</p><p>* <code>99</code>- API user</p><p>* <code>100</code> - Zoom Work email</p><p>* <code>101</code> - Single Sign-On (SSO)</p><p>The following login methods are available only in China:</p><p>* <code>11</code> - Phone number</p><p>* <code>21</code> - WeChat</p><p>* <code>23</code> - Alipay</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## User Vanity Name

`<zoom-connector-mule-4:user-vanity-name>`

A personal meeting room is a virtual meeting room that can be permanently assigned to a user. Use
this API to check if a personal meeting room with the given name exists or not. This operation makes
an HTTP GET request to the /users/vanity\_name endpoint.

- Scopes: `user:read:admin` `user:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Vanity name</p></td><td><div><div><p>String</p></div></div></td><td><p>Personal meeting room name.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## User Zak

`<zoom-connector-mule-4:user-zak>`

Get a user’s Zoom Access Token (ZAK). You can use a ZAK to enable a non-login user to join a meeting
on your app. Non-login users do not need to enter their username and password to join meetings. This
operation makes an HTTP GET request to the /users/me/zak endpoint.

- Scope: `user_zak:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Users

`<zoom-connector-mule-4:users>`

A Zoom account can have one or more users. Use this API to list users on your account. This
operation makes an HTTP GET request to the /users endpoint.

- Scopes: `user:read:admin`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>status</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ACTIVE</p></li><li><p>INACTIVE</p></li><li><p>PENDING</p></li></ul></div></div></td><td><p>User statuses:</p><p>* <code>active</code></p><p>Users with an active status.</p><p>* <code>inactive</code></p><p>Users who are deactivated.</p><p>* <code>pending</code></p><p>Users with a pending status.</p></td><td><p>ACTIVE</p></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Role ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the role. Provide this parameter if you would like to filter the response by a specific role. You can retrieve Role IDs from <a href="https://developers.zoom.us/docs/api/">List Roles</a> API.</p></td><td></td><td></td></tr><tr><td><p>Include fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Provide a value for this field if you would like to see the following attribute in the response of this API call:</p><p>* <code>custom_attributes</code></p><p>Returns custom attributes that are associated with the user. `</p><p>* host_key`</p><p>Returns <a href="https://support.zoom.com/hc/en/article?id=zm_kb&amp;sysparm_article=KB0067063">host key</a> of the user.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Webinar

`<zoom-connector-mule-4:webinar>`

Zoom users with a Webinar Plan have access to creating and managing Webinars. Webinar allows a host
to broadcast a Zoom meeting to up to 10,000 attendees. Use this API to get details of a scheduled
webinar. This operation makes an HTTP GET request to the /webinars/{webinarId} endpoint.

- Prerequisites: Pro or higher plan with a Webinar Add-on.

- Scopes: `webinar:read:admin` `webinar:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The webinar ID in the <code>long</code> format, which is represented as the int64 data type in JSON.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Occurrence ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique Identifier that identifies an occurrence of a recurring webinar. <a href="https://support.zoom.com/hc/en/article?id=zm_kb&amp;sysparm_article=KB0062461">Recurring webinars</a> can have a maximum of 50 occurrences. When you create a recurring Webinar using <a href="https://developers.zoom.us/docs/api/">Create a Webinar API</a>, you can retrieve the Occurrence ID from the response of the API call.</p></td><td></td><td></td></tr><tr><td><p>Show previous occurrences</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Set the value of this field to <code>true</code> if you would like to view Webinar details of all previous occurrences of a recurring Webinar.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Webinar Absentees

`<zoom-connector-mule-4:webinar-absentees>`

List absentees of a webinar. This operation makes an HTTP GET request to the
/past\_webinars/{WebinarUUID}/absentees endpoint.

- Scopes: `webinar:read:admin` `webinar:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Heavy`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar UUID</p></td><td><div><div><p>String</p></div></div></td><td><p>The Webinar UUID. Each Webinar instance will generate its own Webinar UUID (i.e., after a Webinar ends, a new UUID will be generated for the next instance of the Webinar). Please double encode your UUID when using it for API calls if the UUID begins with a ''/'' or contains ''//'' in it.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Occurrence ID</p></td><td><div><div><p>String</p></div></div></td><td><p>The meeting occurrence ID.</p></td><td></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Webinar Create

`<zoom-connector-mule-4:webinar-create>`

Use this API to schedule a webinar for a user (host). For user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. Zoom users with a Webinar Plan have access to creating and managing webinars.
Webinars allow a host to broadcast a Zoom meeting to up to 10,000 attendees. This operation makes an
HTTP POST request to the /users/{userId}/webinars endpoint.

- Prerequisites: Pro or higher plan with a Webinar add-on.

- Scopes: `webinar:write:admin`, `webinar:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Webinar Delete

`<zoom-connector-mule-4:webinar-delete>`

Delete a webinar. This operation makes an HTTP DELETE request to the /webinars/{webinarId} endpoint.

- Prerequisites: Pro or higher plan with a Webinar Add-on.

- Scopes: `webinar:write:admin` `webinar:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The webinar ID in the <code>long</code> format, which is represented as the int64 data type in JSON.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Occurrence ID</p></td><td><div><div><p>String</p></div></div></td><td><p>The meeting occurrence ID.</p></td><td></td><td></td></tr><tr><td><p>Cancel webinar reminder</p></td><td><div><div><p>String</p></div></div></td><td><p><code>true</code>: Notify panelists and registrants about the webinar cancellation via email. <code>false</code>: Do not send any email notification to webinar registrants and panelists. The default value of this field is <code>false</code>.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Webinar Invite Links Create

`<zoom-connector-mule-4:webinar-invite-links-create>`

Use this API to create a batch of invitation links for a webinar. This operation makes an HTTP POST
request to the /webinars/{webinarId}/invite\_links endpoint.

- Prerequisites: Business, Education, or API Plan with Webinar add-on.

- Scopes: `webinar:write:admin`, `webinar:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The webinar ID in the <code>long</code> format, which is represented as the int64 data type in JSON.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Webinar Live Stream Status Update

`<zoom-connector-mule-4:webinar-live-stream-status-update>`

Zoom allows users to
[live stream a webinar](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064210)
to a custom platform. Use this API to update the status of a webinar’s live stream. This operation
makes an HTTP PATCH request to the /webinars/{webinarId}/livestream/status endpoint.

- Prerequisites: Pro or higher plan with a Webinar Add-on. Live streaming details must have been
  [configured](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064210#h_01589a6f-a40a-4e18-a448-cb746e52ebc5)
  for the webinar.

- Scopes: `webinar:write:admin` `webinar:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The webinar ID in the <code>long</code> format, which is represented as the int64 data type in JSON.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Webinar Live Stream Update

`<zoom-connector-mule-4:webinar-live-stream-update>`

Zoom allows users to
[live stream a webinar](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064210)
to a custom platform. Use this API to update a webinar’s live stream information. This operation
makes an HTTP PATCH request to the /webinars/{webinarId}/livestream endpoint.

- Prerequisites: Pro or higher plan with a Webinar Add-on. Live streaming details must have been
  [configured](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064210#h_01589a6f-a40a-4e18-a448-cb746e52ebc5)
  for the webinar.

- Scopes: `webinar:write:admin` `webinar:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The webinar ID in the <code>long</code> format, which is represented as the int64 data type in JSON.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Webinar Panelist Create

`<zoom-connector-mule-4:webinar-panelist-create>`

Panelists in a webinar can view and send video, screen share, annotate, etc., and do much more
compared to attendees in a webinar. Use this API to
[add panelists](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066116) to a
scheduled webinar. This operation makes an HTTP POST request to the /webinars/{webinarId}/panelists
endpoint.

- Prerequisites: Pro or a higher plan with Webinar Add-on.

- Scopes: `webinar:write:admin` `webinar:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The webinar ID in the <code>long</code> format, which is represented as the int64 data type in JSON.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Webinar Panelist Delete

`<zoom-connector-mule-4:webinar-panelist-delete>`

[Remove](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066116) a single
panelist from a webinar. You can retrieve the `panelistId` by calling **List Panelists API**. This
operation makes an HTTP DELETE request to the /webinars/{webinarId}/panelists/{panelistId} endpoint.

- Prerequisites: Pro or a higher plan with Webinar Add-on.

- Scopes: `webinar:write:admin` `webinar:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The webinar ID in the <code>long</code> format, which is represented as the int64 data type in JSON.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Panelist Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The panelist ID or panelist email.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Webinar Panelists

`<zoom-connector-mule-4:webinar-panelists>`

Panelists in a webinar can view and send video, screen share, annotate, etc., and do much more
compared to attendees in a webinar. Use this API to list all the panelists of a webinar. This
operation makes an HTTP GET request to the /webinars/{webinarId}/panelists endpoint.

- Prerequisites: Pro or a higher plan with Webinar Add-on.

- Scopes: `webinar:read:admin` `webinar:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The webinar ID in the <code>long</code> format, which is represented as the int64 data type in JSON.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Webinar Panelists Delete

`<zoom-connector-mule-4:webinar-panelists-delete>`

Remove all the panelists from a Webinar. This operation makes an HTTP DELETE request to the
/webinars/{webinarId}/panelists endpoint.

- Prerequisites: Pro or a higher plan with Webinar Add-on.

- Scopes: `webinar:write:admin` `webinar:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The webinar ID in the <code>long</code> format, which is represented as the int64 data type in JSON.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Webinar Poll Create

`<zoom-connector-mule-4:webinar-poll-create>`

Create a [poll](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066668) for a
webinar. This operation makes an HTTP POST request to the /webinars/{webinarId}/polls endpoint.

- Scopes: `webinar:write:admin` `webinar:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The webinar ID in the <code>long</code> format, which is represented as the int64 data type in JSON.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Webinar Poll Delete

`<zoom-connector-mule-4:webinar-poll-delete>`

Delete a webinar’s
[poll](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066668). This operation
makes an HTTP DELETE request to the /webinars/{webinarId}/polls/{pollId} endpoint.

- Scopes: `webinar:write:admin` `webinar:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The webinar ID in the <code>long</code> format, which is represented as the int64 data type in JSON.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Poll Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The poll ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Webinar Poll Get

`<zoom-connector-mule-4:webinar-poll-get>`

Get a webinar’s [poll](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066668)
details. This operation makes an HTTP GET request to the /webinars/{webinarId}/polls/{pollId}
endpoint.

- Scopes: `webinar:read:admin` `webinar:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The webinar ID in the <code>long</code> format, which is represented as the int64 data type in JSON.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Poll Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The poll ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Webinar Poll Update

`<zoom-connector-mule-4:webinar-poll-update>`

Update a webinar’s
[poll](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066668). This operation
makes an HTTP PUT request to the /webinars/{webinarId}/polls/{pollId} endpoint.

- Scopes: `webinar:write:admin` `webinar:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The webinar ID in the <code>long</code> format, which is represented as the int64 data type in JSON.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Poll Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The poll ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Webinar Polls

`<zoom-connector-mule-4:webinar-polls>`

List all the [polls](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066668) of a
webinar. This operation makes an HTTP GET request to the /webinars/{webinarId}/polls endpoint.

- Scopes: `webinar:read:admin` `webinar:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The webinar ID in the <code>long</code> format, which is represented as the int64 data type in JSON.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Webinar Registrant Create

`<zoom-connector-mule-4:webinar-registrant-create>`

Zoom users with a Webinar Plan have access to creating and managing webinars. Webinar allows a host
to broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a
[Webinar with registration](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061631)
requires your registrants to complete a brief form before receiving the link to join the Webinar.
Use this API to create and submit the registration of a user for a webinar. This operation makes an
HTTP POST request to the /webinars/{webinarId}/registrants endpoint.

- Prerequisites: Pro or higher plan with a Webinar Add-on.

- Scopes: `webinar:write:admin` `webinar:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The webinar ID in the <code>long</code> format, which is represented as the int64 data type in JSON.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Occurrence ids</p></td><td><div><div><p>String</p></div></div></td><td><p>Occurrence ID. Get this value from the webinar get API. Multiple values separated by a comma.</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Webinar Registrant Get

`<zoom-connector-mule-4:webinar-registrant-get>`

Zoom users with a Webinar Plan have access to creating and managing Webinars. Webinar allows a host
to broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a
[Webinar with registration](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061631)
requires your registrants to complete a brief form before receiving the link to join the Webinar.
Use this API to get details on a specific user who has registered for the Webinar. This operation
makes an HTTP GET request to the /webinars/{webinarId}/registrants/{registrantId} endpoint.

- Prerequisites: The account must have a Webinar plan.

- Scopes: `webinar:read:admin` `webinar:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The webinar ID in the <code>long</code> format, which is represented as the int64 data type in JSON.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Registrant Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The registrant ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Occurrence ID</p></td><td><div><div><p>String</p></div></div></td><td><p>The meeting occurrence ID.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Webinar Registrant Question Update

`<zoom-connector-mule-4:webinar-registrant-question-update>`

Scheduling a
[Webinar with registration](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061631)
requires your registrants to complete a brief form with fields and questions before they can receive
the link to join the webinar. Use this API to update registration questions and fields of a
scheduled webinar that are to be answered by users while registering for a webinar. This operation
makes an HTTP PATCH request to the /webinars/{webinarId}/registrants/questions endpoint.

- Prerequisites: Pro or higher plan with a Webinar Add-on. Registration option for the webinar
  should be set as required to use this API.

- Scopes: `webinar:write:admin` `webinar:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The webinar ID in the <code>long</code> format, which is represented as the int64 data type in JSON.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Webinar Registrant Status

`<zoom-connector-mule-4:webinar-registrant-status>`

Update a webinar registrant’s status. Using this API, you can specify whether you want to approve a
registration, deny a registration or cancel a previously approved registration. This operation makes
an HTTP PUT request to the /webinars/{webinarId}/registrants/status endpoint.

- Scopes: `webinar:write:admin` `webinar:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The webinar ID in the <code>long</code> format, which is represented as the int64 data type in JSON.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Occurrence ID</p></td><td><div><div><p>String</p></div></div></td><td><p>The meeting occurrence ID.</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Webinar Registrants

`<zoom-connector-mule-4:webinar-registrants>`

Zoom users with a Webinar Plan have access to creating and managing webinars. Webinar allows a host
to broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a
[Webinar with registration](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061631)
requires your registrants to complete a brief form before receiving the link to join the Webinar.
Use this API to list all the users that have registered for a webinar. This operation makes an HTTP
GET request to the /webinars/{webinarId}/registrants endpoint.

- Prerequisites: Pro or higher plan with a Webinar Add-on.

- Scopes: `webinar:read:admin` `webinar:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The webinar ID in the <code>long</code> format, which is represented as the int64 data type in JSON.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Occurrence ID</p></td><td><div><div><p>String</p></div></div></td><td><p>The meeting occurrence ID.</p></td><td></td><td></td></tr><tr><td><p>status</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>PENDING</p></li><li><p>APPROVED</p></li><li><p>DENIED</p></li></ul></div></div></td><td><p>The registrant status: <code>pending</code> - Registrant’s status is pending. <code>approved</code> - Registrant’s status is approved. <code>denied</code> - Registrant’s status is denied.</p></td><td><p>APPROVED</p></td><td></td></tr><tr><td><p>Tracking source ID</p></td><td><div><div><p>String</p></div></div></td><td><p>The tracking source ID for the registrants. Useful if you share the webinar registration page in multiple locations. See <a href="https://support.zoom.com/hc/en/article?id=zm_kb&amp;sysparm_article=KB0065543">Creating source tracking links for webinar registration</a> for details.</p></td><td></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Webinar Registrants Questions Get

`<zoom-connector-mule-4:webinar-registrants-questions-get>`

Scheduling a
[Webinar with registration](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061631)
requires your registrants to complete a brief form with fields and questions before they can receive
the link to join the Webinar. Use this API to list registration questions and fields that are to be
answered by users while registering for a webinar. This operation makes an HTTP GET request to the
/webinars/{webinarId}/registrants/questions endpoint.

- Prerequisites: Pro or higher plan with a Webinar Add-on.

- Scopes: `webinar:read:admin` `webinar:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The webinar ID in the <code>long</code> format, which is represented as the int64 data type in JSON.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Webinar Status

`<zoom-connector-mule-4:webinar-status>`

Update a webinar’s status. Use this API to end an ongoing webinar. This operation makes an HTTP PUT
request to the /webinars/{webinarId}/status endpoint.

- Prerequisites: The account must hold a valid Webinar Plan.

- Scopes: `webinar:write:admin` `webinar:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The webinar ID in the <code>long</code> format, which is represented as the int64 data type in JSON.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Webinar Update

`<zoom-connector-mule-4:webinar-update>`

Zoom users with a Webinar Plan have access to creating and managing Webinars. Webinar allows a host
to broadcast a Zoom meeting to up to 10,000 attendees. Use this API to make updates to a scheduled
webinar. This operation makes an HTTP PATCH request to the /webinars/{webinarId} endpoint.

- Prerequisites: Pro or higher plan with a Webinar Add-on.

- Scopes: `webinar:write:admin` `webinar:write`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Light`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>Number</p></div></div></td><td><p>The webinar ID in the <code>long</code> format, which is represented as the int64 data type in JSON.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Occurrence ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Webinar occurrence ID. Support change of agenda, start_time, duration, settings: {host_video, panelist_video, hd_video, watermark, auto_recording}.</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:RETRY\_EXHAUSTED

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Webinars

`<zoom-connector-mule-4:webinars>`

Use this API to list all the webinars that are scheduled by or on behalf a user (webinar host). For
user-level apps, pass
[the `me` value](https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword) instead of the
`userId` parameter. Zoom users with a Webinar Plan have access to creating and managing webinars.
Webinars allow a host to broadcast a Zoom meeting to up to 10,000 attendees. This operation makes an
HTTP GET request to the /users/{userId}/webinars endpoint.

- Prerequisites: Pro or higher plan with a Webinar Add-on.

- Scopes: `webinar:read:admin`, `webinar:read`

- [Rate Limit Label](https://developers.zoom.us/docs/api/rate-limits/): `Medium`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <code>me</code> as the value for userId.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of records returned within a single API call.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

### Throws

- ZOOM-CONNECTOR-MULE-4:BAD\_REQUEST

- ZOOM-CONNECTOR-MULE-4:CLIENT\_ERROR

- ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

- ZOOM-CONNECTOR-MULE-4:INTERNAL\_SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:NOT\_ACCEPTABLE

- ZOOM-CONNECTOR-MULE-4:NOT\_FOUND

- ZOOM-CONNECTOR-MULE-4:SERVER\_ERROR

- ZOOM-CONNECTOR-MULE-4:SERVICE\_UNAVAILABLE

- ZOOM-CONNECTOR-MULE-4:TIMEOUT

- ZOOM-CONNECTOR-MULE-4:TOO\_MANY\_REQUESTS

- ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED

- ZOOM-CONNECTOR-MULE-4:UNSUPPORTED\_MEDIA\_TYPE

## Sources

## On New Meeting Trigger

`<zoom-connector-mule-4:on-new-meeting-trigger>`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The user ID or email address of the user. For user-level apps, pass <strong>me</strong> as the value for this field.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Primary Node Only</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether this source should only be executed on the primary node when running in a cluster.</p></td><td></td><td></td></tr><tr><td><p>Scheduling Strategy</p></td><td><div><div><p>scheduling-strategy</p></div></div></td><td><p>Configures the scheduler that triggers the polling.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Redelivery Policy</p></td><td><div><div><p><a href="#RedeliveryPolicy">Redelivery Policy</a></p></div></div></td><td><p>Defines a policy for processing the redelivery of the same message.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

## On New Registrant Trigger

`<zoom-connector-mule-4:on-new-registrant-trigger>`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Webinar Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The webinar ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Status</p></td><td><div><div><p>String</p></div></div></td><td><p>The registrant status - pending, approved, or denied.</p></td><td><p>approved</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Primary Node Only</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether this source should only be executed on the primary node when running in a cluster.</p></td><td></td><td></td></tr><tr><td><p>Scheduling Strategy</p></td><td><div><div><p>scheduling-strategy</p></div></div></td><td><p>Configures the scheduler that triggers the polling.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Redelivery Policy</p></td><td><div><div><p><a href="#RedeliveryPolicy">Redelivery Policy</a></p></div></div></td><td><p>Defines a policy for processing the redelivery of the same message.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Zoom Connector Configuration](#ZoomConfig)

## Types

### Default Header

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Key for this type.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Value for this type.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Default Query Param

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Key for this type.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Value for this type.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Proxy

Configures the settings used to connect through a proxy.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Hostname or IP address of the proxy server.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Port of the proxy server.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Username to authenticate against the proxy server.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password to authenticate against the proxy server.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Non Proxy Hosts</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### TLS

Configures TLS to provide secure communications for the Mule app.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Enabled Protocols</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Comma-separated list of protocols enabled for this context.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enabled Cipher Suites</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Comma-separated list of cipher suites enabled for this context.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Trust Store</strong></p></td><td><div><div><p><a href="#TrustStore">Truststore</a></p></div></div></td><td><div><div><p>Configures the TLS truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Store</strong></p></td><td><div><div><p><a href="#KeyStore">Keystore</a></p></div></div></td><td><div><div><p>Configures the TLS keystore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Revocation Check</strong></p></td><td><div><div><ul><li><p><a href="#StandardRevocationCheck">Standard Revocation Check</a></p></li><li><p><a href="#CustomOcspResponder">Custom OCSP Responder</a></p></li><li><p><a href="#CrlFile">CRL File</a></p></li></ul></div></div></td><td><div><div><p>Configures a revocation checking mechanism.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Truststore

Configures the truststore for TLS.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the truststore. Mule resolves the path relative to the current classpath and file system, if possible.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to protect the truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Encryption algorithm that the truststore uses.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Insecure</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>true</code>, Mule stops performing certificate validations. Setting this to <code>true</code> can make connections vulnerable to attacks.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Keystore

Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a
public certificate.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the keystore. Mule resolves the path relative to the current classpath and file system, if possible.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of store used.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to protect the private key.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to protect the keystore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Encryption algorithm that the keystore uses.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Standard Revocation Check

Configures standard revocation checks for TLS certificates.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Only End Entities</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Which elements to verify in the certificate chain:</p></div><div><ul><li><p><code>true</code></p></li></ul></div><div><p>Verify only the last element in the certificate chain.</p></div><div><ul><li><p><code>false</code></p></li></ul></div><div><p>Verify all elements in the certificate chain.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Prefer Crls</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>How to check certificate validity:</p></div><div><ul><li><p><code>true</code></p></li></ul></div><div><p>Check the Certification Revocation List (CRL) for certificate validity.</p></div><div><ul><li><p><code>false</code></p></li></ul></div><div><p>Use the Online Certificate Status Protocol (OCSP) to check certificate validity.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>No Fallback</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether to use the secondary method to check certificate validity:</p></div><div><ul><li><p><code>true</code></p></li></ul></div><div><p>Use the method that wasn’t specified in the <strong>Prefer Crls</strong> field (the secondary method) to check certificate validity.</p></div><div><ul><li><p><code>false</code></p></li></ul></div><div><p>Do not use the secondary method to check certificate validity.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Soft Fail</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>What to do if the revocation server can’t be reached or is busy:</p></div><div><ul><li><p><code>true</code></p></li></ul></div><div><p>Avoid verification failure.</p></div><div><ul><li><p><code>false</code></p></li></ul></div><div><p>Allow the verification to fail.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Custom OCSP Responder

Configures a custom OCSP responder for certification revocation checks.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL of the OCSP responder.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Cert Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### CRL File

Specifies the location of the certification revocation list (CRL) file.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the CRL file.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnection

Configures a reconnection strategy for an operation.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Fails Deployment</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:</p></div><div><ul><li><p><code>true</code></p></li></ul></div><div><p>Allow the deployment to fail.</p></div><div><ul><li><p><code>false</code></p></li></ul></div><div><p>Ignore the results of the connectivity test.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Reconnection strategy to use.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect

Configures a standard reconnection strategy, which specifies how often to reconnect and how many
reconnection attempts the connector source or operation can make.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to attempt to reconnect, in milliseconds.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>false</code>, the reconnection strategy will run in a separate, non-blocking thread.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How many reconnection attempts the Mule app can make.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect Forever

Configures a forever reconnection strategy by which the connector source or operation attempts to
reconnect at a specified frequency for as long as the Mule app runs.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to attempt to reconnect, in milliseconds.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>false</code>, the reconnection strategy will run in a separate, non-blocking thread.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Expiration Policy

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Idle Time</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Max Idle Time</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### HTTP Response Attributes

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Status Code</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Headers</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Reason Phrase</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Repeatable In Memory Stream

Configures the in-memory streaming strategy by which the request fails if the data exceeds the MAX
buffer size. Always run performance tests to find the optimal buffer size for your specific use
case.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Initial Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by <strong>Buffer Size Increment</strong>, with an upper limit of <strong>Max In Memory Size value</strong>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Size Increment</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Amount by which the buffer size expands if it exceeds its initial size. Setting a value of <code>0</code> or lower specifies that the buffer can’t expand.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a <code>STREAM_MAXIMUM_SIZE_EXCEEDED</code> error. A value of less than or equal to <code>0</code> means no limit.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>Unit for the <strong>Initial Buffer Size</strong>, <strong>Buffer Size Increment</strong>, and <strong>Buffer Unit</strong> fields.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable File Store Stream

Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream
content in memory. If the stream content is larger than the configured buffer size, Mule backs up
the buffer’s content to disk and then clears the memory.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>In Memory Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:</p></div><div><ul><li><p>Configure a larger buffer size to avoid the number of times Mule needs to write the buffer on disk. This increases performance, but it also limits the number of concurrent requests your application can process, because it requires additional memory.</p></li><li><p>Configure a smaller buffer size to decrease memory load at the expense of response time.</p></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>Unit for the <strong>In Memory Size</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Redelivery Policy

Configures the redelivery policy for executing requests that generate errors. You can add a
redelivery policy to any source in a flow.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Redelivery Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum number of times that a redelivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Message Digest Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Secure hashing algorithm to use if the <strong>Use Secure Hash</strong> field is <code>true</code>. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s <code>hashCode()</code> returned.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Message Identifier</strong></p></td><td><div><div><p><a href="#RedeliveryPolicyMessageIdentifier">Redelivery Policy Message Identifier</a></p></div></div></td><td><div><div><p>Defines which strategy is used to identify the messages.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Object Store</strong></p></td><td><div><div><p>ObjectStore</p></div></div></td><td><div><div><p>Configures the object store that stores the redelivery counter for each message.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Redelivery Policy Message Identifier

Configures how to identify a redelivered message and how to find out when the message was
redelivered.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Use Secure Hash</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>true</code>, Mule uses a secure hash algorithm to identify a redelivered message.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Id Expression</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>One or more expressions that determine when a message was redelivered. You can set this property only if the <strong>Use Secure Hash</strong> field is <code>false</code>.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable In Memory Iterable

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Initial Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The number of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.</p></div></div></td><td><div><div><p>100</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Size Increment</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.</p></div></div></td><td><div><div><p>100</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable File Store Iterable

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>In Memory Objects</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>Unit for the <strong>In Memory Objects</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Help](https://help.salesforce.com)