salesforce
+
+
All Connectors

Zoom Connector 1.0 Reference - Mule 4

Configurations

Client Credentials Config

Parameters

Name Type Description Default Value Required

Name

String

Name for this configuration. Connectors reference the configuration with this name.

x

Connection

Client Credentials Connection Provider

Connection types for this configuration.

x

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

60

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

SECONDS

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

AUTO

Name

String

ID used to reference this configuration.

x

Expiration Policy

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Connection Types

Client Credentials Connection Provider
Parameters
Name Type Description Default Value Required

Default Headers

Array of Default Header.

Query Parameters

Array of Default Query Param.

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service.

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Use Persistent Connections

Boolean

Indicates whether to use persistent connections:

* true

Mule uses persistent connections.

* false

Mule closes the connection after the first request completes.

true

Max Connections

Number

Maximum number of outbound connections to keep open at the same time.

-1

Connection Idle Timeout

Number

When persistent connections are enabled, how long a connection can remain idle before Mule closes it.

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Idle Timeout field.

SECONDS

Proxy Config

Proxy

Configures a proxy for outbound connections.

Stream Response

Boolean

If this value is true, Mule streams received responses.

false

Response Buffer Size

Number

Size of the buffer that stores the HTTP response, in bytes.

-1

Base Uri

String

Parameter base URI. Each instance or tenant gets its own.

https://api.zoom.us/v2

Protocol

Enumeration, one of:

  • HTTP

  • HTTPS

Protocol to use for communication.

HTTP

TLS Configuration

TLS

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

Client Id

String

OAuth client ID registered with the service provider.

x

Client Secret

String

OAuth client secret registered with the service provider.

x

Token Url

String

Service provider’s token endpoint URL.

https://api.zoom.us/oauth/token

Scopes

String

OAuth scopes requested during the dance. If not provided, it defaults to those in the annotation.

Object Store

String

A reference to the object store used to store each resource owner ID’s data. If not specified, Mule automatically provisions the default one.

Supported Operations

Zoom Connector Configuration

Parameters

Name Type Description Default Value Required

Name

String

Name for this configuration. Connectors reference the configuration with this name.

x

Connection

Connection types for this configuration.

x

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

60

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

SECONDS

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content. * ALWAYS <p>Connector always streams the request content. <li>`NEVER` <p> Connector does not stream the request content."

AUTO

Name

String

ID used to reference this configuration.

x

Expiration Policy

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Connection Types

Bearer Connection Provider
Parameters
Name Type Description Default Value Required

Default Headers

Array of Default Header.

Query Parameters

Array of Default Query Param.

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service.

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Use Persistent Connections

Boolean

Indicates whether to use persistent connections:

* true

Mule uses persistent connections.

* false

Mule closes the connection after the first request completes.

true

Max Connections

Number

Maximum number of outbound connections to keep open at the same time.

-1

Connection Idle Timeout

Number

When persistent connections are enabled, how long a connection can remain idle before Mule closes it.

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Idle Timeout field.

SECONDS

Proxy Config

Proxy

Configures a proxy for outbound connections.

Stream Response

Boolean

If this value is true, Mule streams received responses.

false

Response Buffer Size

Number

Size of the buffer that stores the HTTP response, in bytes.

-1

Base Uri

String

Parameter base URI. Each instance or tenant gets its own.

https://api.zoom.us/v2

Authorization

String

Authorization.

Protocol

Enumeration, one of:

  • HTTP

  • HTTPS

Protocol to use for communication.

HTTP

TLS Configuration

TLS

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.
Oauth Connection Provider
Parameters
Name Type Description Default Value Required

Default Headers

Array of Default Header.

Query Parameters

Array of Default Query Param.

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service.

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Use Persistent Connections

Boolean

Indicates whether to use persistent connections:

* true

Mule uses persistent connections.

* false

Mule closes the connection after the first request completes.

true

Max Connections

Number

Maximum number of outbound connections to keep open at the same time.

-1

Connection Idle Timeout

Number

When persistent connections are enabled, how long a connection can remain idle before Mule closes it.

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Idle Timeout field.

SECONDS

Proxy Config

Proxy

Configures a proxy for outbound connections.

Stream Response

Boolean

If this value is true, Mule streams received responses.

false

Response Buffer Size

Number

Size of the buffer that stores the HTTP response, in bytes.

-1

Base Uri

String

Parameter base URI. Each instance or tenant gets its own.

https://api.zoom.us/v2

Protocol

Enumeration, one of:

  • HTTP

  • HTTPS

Protocol to use for communication.

HTTP

TLS Configuration

TLS

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

Consumer Key

String

OAuth consumerKey registered with the service provider.

x

Consumer Secret

String

OAuth consumerSecret registered with the service provider.

x

Authorization Url

String

Service provider’s authorization endpoint URL.

https://zoom.us/oauth/authorize

Access Token Url

String

Service provider’s accessToken endpoint URL.

https://zoom.us/oauth/token

Scopes

String

OAuth scopes requested during the dance. If not provided, it defaults to those in the annotation.

Resource Owner Id

String

The resourceOwnerId which each component should use if it doesn’t reference otherwise.

Before

String

Name of the flow to execute immediately before starting the OAuth dance.

After

String

Name of the flow to execute right after receiving an accessToken.

Listener Config

String

A reference to an <http:listener-config /> used to create the listener that catches the access token callback endpoint.

x

Callback Path

String

Path of the access token callback endpoint.

x

Authorize Path

String

Path of the local HTTP endpoint that triggers the OAuth dance.

x

External Callback Url

String

URL that the OAuth provider uses to access the callback endpoint if the endpoint is behind a proxy or accessed through an indirect URL.

Object Store

String

A reference to the object store used to store each resource owner ID’s data. If not specified, Mule automatically provisions the default one.

Supported Operations

Associated Sources

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 guide. This operation makes an HTTP DELETE request to the /im/chat/messages/{message_id} endpoint.

  • Scope: imchat:bot

  • Rate Limit Label: Medium

  • Authorization Flow: Client Credentials Flow

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Message ID

String

Message ID.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 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 guide. This operation makes an HTTP PUT request to the /im/chat/messages/{message_id} endpoint.

  • Scope: imchat:bot

  • Rate Limit Label: Medium

  • Authorization Flow: Client Credentials Flow

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Message ID

String

Unique identifier of the message that needs to be updated. This is retrieved from the response of the Send Chatbot Message API.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 guide. This operation makes an HTTP POST request to the /im/chat/messages endpoint.

  • Scope: imchat:bot

  • Rate Limit Label: Medium

  • Authorization Flow: Client Credentials Flow

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Resource Owner Id

String

ID of the resource owner whose access should be invalidated.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

For Configurations

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 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: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Account Id

String

The account ID.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 of a sub account. Only master accounts can use this API. Zoom allows only approved partners 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: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Account Id

String

The account ID.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 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: Heavy

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Account Id

String

The account ID.

x

from

String

Start date for the invoice query in yyyy-mm-dd format. The date range between from and to must not exceed one year. The range defined must fall within the past three years.

to

String

End date for the invoice query in yyyy-mm-dd format.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 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 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: Heavy

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Account Id

String

The account ID.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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. This operation makes an HTTP GET request to the /phone/call_logs endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Page size

Number

Number of records returned within a single API call.

30

from

String

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 from and to fields) for which the call logs are returned must not exceed a month.

to

String

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.

type

String

The type of the call logs. The value can be either all or missed.

path

String

Filter the API response by path of the call. The value of this field can be one of the following: voiceMail, message, forward, extension, callQueue, ivrMenu, companyDirectory, autoReceptionist, contactCenter, disconnected, commonAreaPhone, pstn, transfer, sharedLines, sharedLineGroup, tollFreeBilling, meetingService, parkPickup, parkTimeout, monitor, takeover, or sipGroup.

Time type

Enumeration, one of:

  • START_TIME

  • END_TIME

Enables you to sort call logs by start or end time. Choose the sort time value. Values include startTime or endTime.

START_TIME

Site ID

String

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 call logs of a specific phone site.

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Any

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4: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 to use master APIs and manage sub accounts. Email the partner programs team at 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: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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.

  • Scope: account:write:admin

  • Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Account Id

String

The account ID.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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. 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: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Account Id

String

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.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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.

  • Scope: account:write:admin

  • Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Account Id

String

The account ID.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 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 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: Heavy

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Account Id

String

Account ID.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 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: Heavy

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Account Id

String

The account ID.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 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: Heavy

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Account Id

String

The account ID.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 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 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: Heavy

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Account Id

String

Account ID.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 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: Heavy

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Account Id

String

The account ID.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Account Id

String

The account ID.

x

Body

String

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 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.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Account Id

String

The account ID.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Account Id

String

The account ID.

x

option

Enumeration, one of:

  • MEETING_AUTHENTICATION

  • RECORDING_AUTHENTICATION

Use the following options to filter the results of the account’s information:

* meeting_authentication

View the account’s meeting authentication settings.

* recording_authentication

View the account’s recording authentication settings.

* security

View the account’s security settings, for example, password requirements for user login or two-factor authentication.

* meeting_security ”

View the account’s meeting security settings.

Custom query fields

String

Name of the field by which to filter the response, for example, if you provide the host_video value for this field, you will get a response similar to the following: { "schedule_meeting": { "host_video": false } }. To use multiple values, comma-separate each value, for example, host_video,participant_video.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Account Id

String

The account ID.

x

option

Enumeration, one of:

  • MEETING_AUTHENTICATION

  • RECORDING_AUTHENTICATION

  • SECURITY

  • MEETING_SECURITY

Use the following options to filter the results of the account’s information:

* meeting_authentication

View the account’s meeting authentication settings.

* recording_authentication

View the account’s recording authentication settings.

* security

View the account’s security settings, for example, password requirements for user login or two-factor authentication.

* meeting_security ”

View the account’s meeting security settings.

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Account Id

String

The account ID.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 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: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Page size

Number

Number of records returned within a single API call.

30

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Any

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4: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: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 to a Zoom account. This operation makes an HTTP POST request to the /rooms endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 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: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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) 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: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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. 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: Heavy

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

String

Unique identifier of the meeting (Meeting Number).

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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. 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: Heavy

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Webinar Id

String

Unique identifier of the webinar.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 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 with SIP Connected Audio Plan.

  • Scope: sip_trunk:master

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Account Id

String

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 accountId path parameter. To add Call-out enabled countries to a master account, provide me as the value of the accountId path parameter.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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. 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.

  • Scopes: phone:write:admin

  • Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 with SIP Connected Audio Plan.

  • Scope: sip_trunk:master

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Account Id

String

Unique identifier of the 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.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 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: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Call Queue Id

String

Unique identifier of the call queue.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 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 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: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Shared Line Group Id

String

Unique identifier of the shared line group.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 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.

  • Scopes: phone:write:admin

  • Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 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 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: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Role Id

String

The role ID.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 instead of the userId parameter. Phone users can access shared voicemail inboxes 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: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

Unique identifier of the user.

x

Setting Type

String

Corresponds to the setting item you wish to modify. Allowed values: voice_mail.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 to a Zoom phone user. For user-level apps, pass the me value 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: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

User ID.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 to a user who has already enabled Zoom Phone. For user-level apps, pass the me value 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: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

User ID.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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. 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: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Auto Receptionist Id

String

Unique identifier of the Auto Receptionist. It can be retrieved from the [List Sites API](https://marketplace.zoom.us/docs/api-reference/zoom-api/phone-site/listphonesites).

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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. 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: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Shared Line Group Id

String

Unique identifier of the shared line group.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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, you can assign them, allowing callers to directly dial a number to reach a call queue. 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: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Call Queue Id

String

Unique identifier of the call queue.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Account Id

String

Unique identifier of the sub account.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 (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: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Account Id

String

Account ID.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 and SIP Connected Audio Plan.

  • Scope: sip_trunk:master

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Account Id

String

Unique identifier of the sub account.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 to set another phone user as the call queue manager. 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: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Call Queue Id

String

Unique identifier of the call queue.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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. External users can use the main company number 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: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 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: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Location Id

String

Location Id

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 or downgrade 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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Room Id

String

Unique identifier of the Zoom Room.

x

Device Id

String

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://marketplace.zoom.us/docs/api-reference/zoom-api/rooms/listzrdevices).

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 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: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Room Id

String

Unique identifier of the Zoom Room.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 guide. This operation makes an HTTP PATCH request to the /rooms/{id}/events endpoint.

  • Prerequisites: Zoom Rooms 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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

ID

String

Room ID

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 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: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 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: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

String

Meeting Id

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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. 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: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 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: Medium

Note that this API supports both user-managed apps and account-level apps. However, in an account-level OAuth app, to create a channel on behalf of another user in the same Zoom account, the user calling this API must have a role that has the Edit permission for the Chat channels feature.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

Unique identifier of the user.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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. This operation makes an HTTP POST request to the /phone/sites endpoint.

  • Prerequisites: Multiple Sites must be enabled. Pro or a higher account with Zoom Phone enabled.

  • Scope: phone:write:admin

  • Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 Sales team.

  • Scope: sip_phone:write:admin

  • Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 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. 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: Resource-intensive

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

from

String

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.

x

to

String

End date.

x

Page size

Number

Number of records returned within a single API call.

30

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Any

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4: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. 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.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

from

String

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.

x

to

String

End date.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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. 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.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Feedback Id

String

Feedback Detail ID.

x

from

String

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.

to

String

End date.

Page size

Number

Page size.

30

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Any

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4: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: Heavy

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

from

String

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.

x

to

String

End date.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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 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. 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: Resource-intensive

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

from

String

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.

x

to

String

End date.

x

Page size

Number

Number of records returned within a single API call.

30

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Any

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4: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: Heavy

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Zoomroom Id

String

The Zoom room ID.

x

from

String

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.

x

to

String

End date.

x

Page size

Number

Number of records returned within a single API call.

30

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Any

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4: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: Heavy

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

from

String

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.

x

to

String

End date.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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: Heavy

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

String

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.

x

type

Enumeration, one of:

  • PAST

  • PAST_ONE

  • LIVE

The meeting types: past - Past meetings. pastOne - Past one user meetings. live - Live meetings.

LIVE

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

String

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.

x

Participant Id

String

Participant ID.

x

type

Enumeration, one of:

  • PAST

  • PAST_ONE

  • LIVE

The meeting types: past - Past meetings. live - Live Meetings.

LIVE

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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: Heavy

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

String

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.

x

type

Enumeration, one of:

  • PAST

  • PAST_ONE

  • LIVE

The meeting types: past - Past meetings. live - Live Meetings.

LIVE

Page size

Number

Number of records returned within a single API call.

30

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Any

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4: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: Heavy

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

String

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.

x

type

Enumeration, one of:

  • PAST

  • PAST_ONE

  • LIVE

The meeting types: past - Past meetings. pastOne - Past one user meetings. live - Live meetings.

LIVE

Page size

Number

Number of records returned within a single API call.

30

Include fields

Enumeration, one of:

  • REGISTRANT_ID

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 meeting registrant. This is not supported for live meeting types.

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Any

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4: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: Heavy

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

String

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.

x

type

Enumeration, one of:

  • PAST

  • PAST_ONE

  • LIVE

The meeting types: past - Past meetings. live - Live Meetings.

LIVE

Page size

Number

The number of items returned per page.

1

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Any

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4: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: Resource-intensive

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

type

Enumeration, one of:

  • PAST

  • PAST_ONE

  • LIVE

Specify a value to get the response for the corresponding meeting type. The value of this field can be one of the following: past - Meeting that already occurred in the specified date range. pastOne - Past meetings that were attended by only one user. live - Live meetings. If you do not provide this field, the default value will be live and thus, the API will only query responses for live meetings.

LIVE

from

String

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.

x

to

String

End date.

x

Page size

Number

Number of records returned within a single API call.

30

Include fields

Enumeration, one of:

  • TRACKING_FIELDS

Set the value of this field to "tracking_fields" if you would like to include tracking fields of each meeting in the response.

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Any

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4: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: Heavy

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Webinar Id

String

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.

x

type

Enumeration, one of:

  • PAST

  • LIVE

The webinar type.

LIVE

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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: Heavy

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Webinar Id

String

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.

x

Participant Id

String

Participant ID.

x

type

Enumeration, one of:

  • PAST

  • LIVE

The webinar type.

LIVE

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4:CONNECTIVITY

  • ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE

  • ZOOM-CONNECTOR-MULE-4:NOT_FOUND

  • ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • ZOOM-CONNECTOR-MULE-4:SERVER_ERROR

  • ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • 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: Heavy

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Webinar Id

String

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.

x

type

Enumeration, one of:

  • PAST

  • LIVE

The webinar type.

LIVE

Page size

Number

Number of records returned within a single API call.

30

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Any

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4: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: Heavy

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Webinar Id

String

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.

x

type

Enumeration, one of:

  • PAST

  • LIVE

The webinar type.

LIVE

Page size

Number

Number of records returned within a single API call.

30

Include fields

Enumeration, one of:

  • REGISTRANT_ID

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 webinar registrant.

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Any

For Configurations

Throws

  • ZOOM-CONNECTOR-MULE-4:BAD_REQUEST

  • ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR

  • ZOOM-CONNECTOR-MULE-4: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: Heavy

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Webinar Id

String

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.

x

type

Enumeration, one of:

  • PAST

  • LIVE

The webinar type.

LIVE

Page size

Number

The number of items returned per page.

1

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Query Parameters

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.