Zoom Connector 1.0 Reference - Mule 4 | MuleSoft Documentation

Configurations

Client Credentials Config

Parameters

Name Type Description Default Value Required

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.

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

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

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.

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

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.

Zoom Connector Configuration

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Name	String	Name for this configuration. Connectors reference the configuration with this name.		x
Connection	Bearer Connection Provider Oauth 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` <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.

Name

String

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

x

Connection

Bearer Connection Provider
Oauth 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 <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

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

Name	Type	Description	Default Value
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.

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

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

Oauth Connection Provider

Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to Configuring OAuth 2.0 for Connectors or Configuring OAuth 2.0 for Connectors on CloudHub.

Parameters

Name Type Description Default Value Required

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.

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

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

Account
Account Billing
Account Billing Invoices
Account Billing Update
Account Call Logs
Account Create
Account Disassociate
Account Managed Domain
Account Options Update
Account Plan Addon Cancel
Account Plan Addon Create
Account Plan Addon Update
Account Plan Base Delete
Account Plan Base Update
Account Plan Create
Account Plans
Account Settings
Account Settings Update
Account Trusted Domain
Accounts
Add Anumber To Blocked List
Add A Room
Add Auto Receptionist
Add Azr Location
Add Batch Registrants
Add Batch Webinar Registrants
Add Byoc Number
Add Callout Countries
Add Common Area Phone
Add External Contact
Add Internal Numbers
Add Location
Add Members To Call Queue
Add Members To Shared Line Group
Add Phone Device
Add Role Members
Add Setting Template
Add User Setting
Assign Calling Plan
Assign Calling Plans To Common Area Phone
Assign Phone Number
Assign Phone Numbers Auto Receptionist
Assign Phone Numbers Slg
Assign Phone Numbers To Common Area Phone
Assign Phone To Call Queue
Assign Sip Trunk Numbers
Assign Sip Config
Assign Sip Trunks
Batch Add Locations
Change Call Queue Manager
Change Main Company Number
Change Parent Location
Change Zoom Rooms App Version
Change Zr Location
Check In Rooms
Create A Shared Line Group
Create Batch Polls
Create Call Queue
Create Channel
Create Phone Site
Create Role
Create Sip Phone
Dashboard Chat
Dashboard Client Feedback
Dashboard Client Feedback Detail
Dashboard Crc
Dashboard Im
Dashboard Issue Detail Zoom Room
Dashboard Issue Zoom Room
Dashboard Meeting Detail
Dashboard Meeting Participant Qos
Dashboard Meeting Participant Share
Dashboard Meeting Participants
Dashboard Meeting Participants Qos
Dashboard Meetings
Dashboard Webinar Detail
Dashboard Webinar Participant Qos
Dashboard Webinar Participant Share
Dashboard Webinar Participants
Dashboard Webinar Participants Qos
Dashboard Webinars
Dashboard Zoom Room
Dashboard Zoom Room Issue
Dashboard Zoom Rooms
Del Group Vb
Del User Vb
Del Vb
Delete A Blocked List
Delete A Call Queue
Delete A Device
Delete A External Contact
Delete All Sip Numbers
Delete A Member Slg
Delete A Phone Number Slg
Delete A Shared Line Group
Delete A Zoom Room
Delete Call Log
Delete Channel
Delete Chat Message
Delete Common Area Phone
Delete Internal Call Out Country
Delete Internal Number
Delete Location
Delete Members Of Slg
Delete Phone Numbers Slg
Delete Phone Site
Delete Role
Delete Sip Phone
Delete Sip Trunk
Delete User Level Channel
Delete User Setting
Delete Voicemail
Delete Webinar Registrant
Device Create
Device Delete
Device List
Device Update
Download Invoice Pdf
Edit Message
Get A Blocked List
Get A Call Queue
Get Account Billing Invoice
Get Account Cloud Recording
Get Account Lock Settings
Get A Common Area Phone
Get A Device
Get A External Contact
Get A Shared Line Group
Get A Site
Get Billing Invoices Reports
Get Billing Report
Get Call Log Details
Get Call Log Metrics Details
Get Call Qo S
Get Call Queue Recordings
Get Channel
Get Channels
Get Chat Message
Get Chat Messages
Get Group Lock Settings
Get Group Settings
Get Live Stream Details For Meeting
Get Live Stream Details For Webinar
Get Location
Get Phone Number Details
Get Phone Recordings
Get Plan Usage
Get Ps Operation Logs
Get Role Information
Get Setting Template
Get Tracking Sources
Get User Contact
Get User Contacts
Get User Level Channel
Get Zr Account Profile
Get Zr Account Settings
Get Zr Location Profile
Get Zr Location Settings
Get Zr Location Structure
Get Zr Profile
Get Zr Settings
Group
Group Create
Group Delete
Group Locked Settings
Group Members
Group Members Create
Group Members Delete
Group Update
Groups
Im Chat Messages
Im Chat Sessions
Im Group
Im Group Create
Im Group Delete
Im Group Members
Im Group Members Create
Im Group Members Delete
Im Group Update
Im Groups
In Meeting Recording Control
Invite Channel Members
Join Channel
Leave Channel
List Account Phone Numbers
List Archived Files
List Blocked List
List Byocsip Trunk
List Call Logs Metrics
List Call Queues
List Calling Plans
List Channel Members
List Common Area Phones
List Digital Signage Content
List External Contacts
List Internal Callout Countries
List Internal Numbers
List Locations
List Meeting Satisfaction
List Meeting Templates
List Past Meeting Files
List Past Meeting Polls
List Past Webinar Files
List Past Webinar Poll Results
List Past Webinar Qa
List Phone Devices
List Phone Sites
List Phone Users
List Setting Templates
List Shared Line Groups
List Sip Groups
List Sip Phones
List Sip Trunk Numbers
List Sip Trunks
List Webinar Participants
List Webinar Templates
List Zoom Rooms
List Zr Devices
List Zr Locations
Listimmessages
Manage E911signage
Mark Message
Meeting
Meeting Create
Meeting Delete
Meeting Invitation
Meeting Invite Links Create
Meeting Live Stream Status Update
Meeting Live Stream Update
Meeting Poll Create
Meeting Poll Delete
Meeting Poll Get
Meeting Poll Update
Meeting Polls
Meeting Quality Score
Meeting Recording Registrant Create
Meeting Recording Registrant Status
Meeting Recording Registrants
Meeting Registrant Create
Meeting Registrant Question Update
Meeting Registrant Status
Meeting Registrants
Meeting Registrants Questions Get
Meeting Status
Meeting Update
Meetingregistrantdelete
Meetings
Participant Feedback
Participant Webinar Feedback
Past Meeting Details
Past Meeting Participants
Past Meetings
Past Webinars
Phone Setting
Phone User
Phone User Call Logs
Phone User Recordings
Phone User Settings
Phone User Voice Mails
Post Phone Sip Trunk
React Message
Recording Delete
Recording Delete One
Recording Get
Recording Registrant Question Update
Recording Registrants Questions Get
Recording Setting Update
Recording Settings Update
Recording Status Update
Recording Status Update One
Recordings List
Remove A Channel Member
Remove A User Level Channel Member
Report Cloud Recording
Report Daily
Report Meeting Details
Report Meeting Participants
Report Meeting Polls
Report Meetings
Report Operation Logs
Report Sign In Sign Out Activities
Report Telephone
Report Users
Report Webinar Details
Report Webinar Participants
Report Webinar Polls
Report Webinar Qa
Role Member Delete
Role Members
Roles
Search Company Contacts
Senda Chat Message
Sendimmessages
Set Up Account
Switch User Account
Testget Record Archived Files
Trackingfield Create
Trackingfield Delete
Trackingfield Get
Trackingfield List
Trackingfield Update
Tsp
Tsp Update
Tsp Url Update
Un Assign Phone Num Call Queue
Unassign All Members
Unassign All Phone Nums Auto Receptionist
Unassign A Phone Num Auto Receptionist
Unassign A Phone Num Call Queue
Unassign Calling Plan
Unassign Calling Plans From Common Area Phone
Unassign Member From Call Queue
Unassign Phone Number
Unassign Phone Numbers From Common Area Phone
Unauthorize
Update Account Lock Settings
Update Account Owner
Update A Device
Update A Group Member
Update A Shared Line Group
Update Auto Receptionist
Update Blocked List
Update Call Queue
Update Channel
Update Common Area Phone
Update External Contact
Update Group Settings
Update Location
Update Phone Number Details
Update Phone Settings
Update Phone Sip Trunk
Update Presence Status
Update Role
Update Room Profile
Update Setting Template
Update Sip Phone
Update Site Details
Update User Level Channel
Update User Profile
Update User Setting
Update Zoom Room Acc Settings
Update Zoom Rooms Location Structure
Update Zr Acc Profile
Update Zr Location Profile
Update Zr Location Settings
Update Zr Settings
Upload Group Vb
Upload Vb
Upload V Buser
User
User Assistant Create
User Assistant Delete
User Assistants
User Assistants Delete
User Create
User Delete
User Email
User Email Update
User Pa Cs
User Password
User Permission
User Picture
User Scheduler Delete
User Schedulers
User Schedulers Delete
User Settings
User Settings Update
User Sso Token Delete
User Status
User Token
User Tsp
User Tsp Create
User Tsp Delete
User Ts Ps
User Tsp Update
User Update
User Vanity Name
User Zak
Users
Webinar
Webinar Absentees
Webinar Create
Webinar Delete
Webinar Invite Links Create
Webinar Live Stream Status Update
Webinar Live Stream Update
Webinar Panelist Create
Webinar Panelist Delete
Webinar Panelists
Webinar Panelists Delete
Webinar Poll Create
Webinar Poll Delete
Webinar Poll Get
Webinar Poll Update
Webinar Polls
Webinar Registrant Create
Webinar Registrant Get
Webinar Registrant Question Update
Webinar Registrant Status
Webinar Registrants
Webinar Registrants Questions Get
Webinar Status
Webinar Update
Webinars

Associated Sources

On New Meeting Trigger
On New Registrant Trigger

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

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	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Client Credentials Config

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

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	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Client Credentials Config

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

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	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Client Credentials Config

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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	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.

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

Client Credentials Config
Zoom Connector Configuration

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

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	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

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	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

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	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

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	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

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	Repeatable In Memory Iterable Repeatable File Store Iterable non-repeatable-iterable	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	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4: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

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	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

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	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

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	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

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	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

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	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

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	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

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	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

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	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

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	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

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	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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.

Scopes: billing:master
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

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	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

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	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

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	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

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	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4: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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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.

Prerequisites: Pro or a higher plan with Zoom Room license.
Scopes: room:write:admin
Rate Limit Label: Medium

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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Array of Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Array of Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Change Call Queue Manager

<zoom-connector-mule-4:change-call-queue-manager>

A call queue manager has the privileges to manage the call queue’s voicemail inbox and recordings, and change all call queue settings and call queue policy settings. Use this API to set another phone user as the call queue manager. 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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

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

Prerequisites: Business or higher account. Feedback to Zoom enabled.
Scope: account: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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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.

Prerequisites: Business or higher account. Feedback to Zoom enabled.
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

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4: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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4: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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4: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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Dashboard Meeting Participant Qos

<zoom-connector-mule-4:dashboard-meeting-participant-qos>

Use this API to retrieve the quality of service (QoS) for participants from live or past meetings. The data returned indicates the connection quality for sending or receiving video, audio, and shared content. The API returns this data for either the API request or when the API request was last received. This API will not return data if there is no data being sent or received at the time of request. Note that when the sender sends its data, a timestamp is attached to the sender’s data packet. The receiver then returns this timestamp to the sender. This helps determine the upstream and downstream latency, which includes the application processing time. The latency data returned is the five second average and five second maximum. This operation makes an HTTP GET request to the /metrics/meetings/{meetingId}/participants/{participantId}/qos endpoint.

Scopes: dashboard_meetings:read:admin
Rate Limit Label: 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

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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4: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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4: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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4: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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4: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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4: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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4: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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Dashboard Webinars

<zoom-connector-mule-4:dashboard-webinars>

List all the live or past webinars from a specified period of time. This operation makes an HTTP GET request to the /metrics/webinars endpoint.

Prerequisites: Business, Education, or API Plan with Webinar add-on.
Scopes: dashboard_webinars:read:admin
Rate Limit Label: Resource-intensive

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

type

Enumeration, one of:

PAST
LIVE

The webinar type.

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

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Dashboard Zoom Room

<zoom-connector-mule-4:dashboard-zoom-room>

The Zoom Rooms dashboard metrics lets you know the type of configuration a Zoom room has and details on the meetings held in that room. Use this API to retrieve information on a specific room. This operation makes an HTTP GET request to the /metrics/zoomrooms/{zoomroomId} endpoint.

Prerequisites: Business, Education, or API Plan with Zoom Rooms set up.
Scopes: dashboard_zr:read:admin
Rate Limit Label: 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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Dashboard Zoom Room Issue

<zoom-connector-mule-4:dashboard-zoom-room-issue>

Get the top 25 issues of Zoom Rooms. This operation makes an HTTP GET request to the /metrics/zoomrooms/issues endpoint.

Prerequisites: Business, Education, or API Plan with Zoom Rooms set up.
Scopes: dashboard_zr:read:admin
Rate Limit Label: 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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Dashboard Zoom Rooms

<zoom-connector-mule-4:dashboard-zoom-rooms>

List information on all Zoom Rooms in an account. This operation makes an HTTP GET request to the /metrics/zoomrooms endpoint.

Prerequisites: Business, Education, or API Plan with Zoom Rooms set up.
Scopes: dashboard_zr:read:admin
Rate Limit Label: Resource-intensive

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Del Group Vb

<zoom-connector-mule-4:del-group-vb>

Delete existing virtual background file(s) from an account. This operation makes an HTTP DELETE request to the /groups/{groupId}/settings/virtual_backgrounds endpoint.

Prerequisites: Virtual background feature must be enabled on the account.
Scope: group:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Group Id

String

Unique identifier of the group. Retrieve the value for this field by calling the [List groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups) API.

x

File ids

String

Provide the ID of the file that is to be deleted. To delete multiple files, provide comma-separated values for this field.

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Del User Vb

<zoom-connector-mule-4:del-user-vb>

Delete existing virtual background file(s) of a user. For user-level apps, pass the me value instead of the userId parameter. This operation makes an HTTP DELETE request to the /users/{userId}/settings/virtual_backgrounds endpoint.

Prerequisites: Virtual background feature must be enabled on the account.
Scopes: user: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. Retrieve the value of this field by calling the List users API.

x

File ids

String

Provide the ID of the file that is to be deleted. To delete multiple files, provide comma-separated values for this field.

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Del Vb

<zoom-connector-mule-4:del-vb>

Delete existing virtual background file(s) from an account. This operation makes an HTTP DELETE request to the /accounts/{accountId}/settings/virtual_backgrounds endpoint.

Prerequisites: Virtual background feature must be enabled on the 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

Account ID.

x

File ids

String

Provide the ID of the file that is to be deleted. To delete multiple files, provide comma-separated values for this field.

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Delete A Blocked List

<zoom-connector-mule-4:delete-ablocked-list>

A Zoom account owner or a user with admin privilege can block phone numbers for phone users in an account. Blocked numbers can be inbound (numbers will be blocked from calling in) and outbound (phone users in your account won’t be able to dial those numbers). Use this API to delete a blocked list and therefore removing the associated number from the blocked list. The number will be unblocked after the deletion. This operation makes an HTTP DELETE request to the /phone/blocked_list/{blockedListId} endpoint.

Prerequisites: Pro or higher account plan with Zoom phone license.
Scope: phone:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Blocked List Id

String

Unique identifier of the blocked list. This can be retrieved from the List Blocked List API.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Delete A Call Queue

<zoom-connector-mule-4:delete-acall-queue>

Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service, etc. Use this API to delete a Call Queue. This operation makes an HTTP DELETE request to the /phone/call_queues/{callQueueId} endpoint.

Prerequisites: Pro, Business, or Education account. Account owner or admin permissions. Zoom Phone license.
Scopes: phone:write:admin
Rate Limit Label: 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

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Delete A Device

<zoom-connector-mule-4:delete-adevice>

Remove a desk phone device from the Zoom Phone System Management. This operation makes an HTTP DELETE request to the /phone/devices/{deviceId} endpoint.

Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin permissions. Device must not have been assigned to a user.
Scopes: phone:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Device Id

String

Unique identifier of the device.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Delete A External Contact

<zoom-connector-mule-4:delete-aexternal-contact>

Use this API to remove an external contact. This operation makes an HTTP DELETE request to the /phone/external_contacts/{externalContactId} endpoint.

Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin permissions.
Scopes: phone:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

External Contact Id

String

The external contact''s ID.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Delete All Sip Numbers

<zoom-connector-mule-4:delete-all-sip-numbers>

With SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed to make and deliver phone calls) over a direct and private connection between the customer’s network and the Zoom cloud. Meeting participants that dial into a meeting or have the meeting call them, and are On-Net from the perspective of the customers' IP telephony network, will be connected over this trunk rather than over the PSTN. Use this API to delete all internal numbers assigned to a sub account. This operation makes an HTTP DELETE request to the /accounts/{accountId}/sip_trunk/numbers endpoint.

Prerequisites: Pro or a higher account with SIP Connected Audio plan enabled. The account must be a master account.
Scopes: sip_trunk:master
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Account Id

String

Account ID of the sub account from which the numbers are to be deleted. This can be retrieved from [List sub accounts](https://marketplace.zoom.us/docs/api-reference/zoom-api/accounts/account) API.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Delete A Member Slg

<zoom-connector-mule-4:delete-amember-slg>

Members of the shared line group have access to the group’s phone number and voicemail. Use this API to unassign a specific member from a Shared Line Group. This operation makes an HTTP DELETE request to the /phone/shared_line_groups/{sharedLineGroupId}/members/{memberId} endpoint.

Prerequisites: Pro or higher account with Zoom Phone license. A valid Shared Line Group. Account owner or admin privileges.
Scopes: phone:write:admin
Rate Limit Label: 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 from which you would like to remove a member.

x

Member Id

String

Unique identifier of the member who is to be removed.

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Delete A Phone Number Slg

<zoom-connector-mule-4:delete-aphone-number-slg>

Use this API to unassign a specific phone number that was assigned to the shared line group. This operation makes an HTTP DELETE request to the /phone/shared_line_groups/{sharedLineGroupId}/phone_numbers/{phoneNumberId} endpoint.

Prerequisites: Pro or higher account with Zoom Phone license. A valid Shared Line Group. Account owner or admin privileges.
Scopes: phone:write:admin
Rate Limit Label: 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 from which you would like to unassign a phone number.

x

Phone Number Id

String

Unique identifier of the phone number which is to be unassigned. This can be retrieved from the Get a Shared Line Group API.

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Delete A Shared Line Group

<zoom-connector-mule-4:delete-ashared-line-group>

A shared line group allows Zoom Phone admins to share a phone number and extension with a group of phone users or common area phones. Use this API to delete a Shared Line Group. This operation makes an HTTP DELETE request to the /phone/shared_line_groups/{sharedLineGroupId} endpoint.

Prerequisites: Pro or higher account with Zoom Phone license. Account owner or admin privileges.
Scopes: phone:write:admin
Rate Limit Label: 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 that you would like to delete.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Delete A Zoom Room

<zoom-connector-mule-4:delete-azoom-room>

Remove a specific Zoom Room profile from a Zoom account. This operation makes an HTTP DELETE request to the /rooms/{roomId} endpoint.

Prerequisites: Pro or a higher plan with Zoom Room license.
Scopes: room:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Room Id

String

Unique identifier of a Zoom Room.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Delete Call Log

<zoom-connector-mule-4:delete-call-log>

Use this API to delete a user’s call logs. For user-level apps, pass the me value instead of the userId parameter. This operation makes an HTTP DELETE request to the /phone/users/{userId}/call_logs/{callLogId} endpoint.

Prerequisites: User must belong to a Business or Enterprise account. User must have a Zoom Phone license.
Scopes: phone:write, phone:write:admin, phone_call_log:write, phone_call_log:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

User ID or email address of the user.

x

Call Log Id

String

Unique identifier of the call log. The value for this field can be retrieved from account’s call logs or user’s call logs.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Delete Channel

<zoom-connector-mule-4:delete-channel>

Use this API to delete a specific channel. For user-level apps, pass the me value instead of the userId parameter. Zoom chat channels allow users to communicate via chat in private or public groups. This operation makes an HTTP DELETE request to the /chat/users/{userId}/channels/{channelId} endpoint.

Scopes: chat_channel:write:admin
Rate Limit Label: Medium

Note that this API only supports a user-managed OAuth app.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

User ID.

x

Channel Id

String

Unique identifier of a channel.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Delete Chat Message

<zoom-connector-mule-4:delete-chat-message>

Delete a chat message that you previously sent to a contact or a channel. For user-level apps, pass the me value instead of the userId parameter. In the query parameter, you must provide either of the following: * to_contact: The email address of the contact to whom you sent the message. Use this parameter to delete a message sent to an individual contact in Zoom. * to_channel: The channel ID of the channel where you sent the message. Use this parameter to delete a message sent to a channel in Zoom. This operation makes an HTTP DELETE request to the /chat/users/{userId}/messages/{messageId} endpoint.

Scopes: chat_message:write, chat_message:write:admin
Rate Limit Label: Medium

Note: For an account-level OAuth app, this API can only be used on behalf of a user who is assigned with a role that has the Edit permission for Chat Messages.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

User ID.

x

Message ID

String

Message ID.

x

To contact

String

The userId or email address of a chat contact to whom you previously sent the message. Note: You must provide either to_contact or to_channel as a query parameter to delete a message that was previously sent to either an individual or a chat channel respectively.

To channel

String

The channel Id of the channel where you would like to send the message. You must provide either to_contact or to_channel as a query parameter to delete a message that was previously sent to either an individual or a chat channel

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Delete Common Area Phone

<zoom-connector-mule-4:delete-common-area-phone>

A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it, for example, if your office has shared desks that don’t belong to a specific employees, you could add a common area phone so that any person can use it. Use this API to remove the common area phone from Zoom Phone System in an account. This operation makes an HTTP DELETE request to the /phone/common_area_phones/{commonAreaPhoneId} endpoint.

Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin permissions. A supported device.
Scopes: phone:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Common Area Phone Id

String

Unique identifier of the common area phone.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Delete Internal Call Out Country

<zoom-connector-mule-4:delete-internal-call-out-country>

Delete a previously assigned call-out country from a master account or a sub account. To remove call-out country from a sub account, provide the account ID of the sub account in the accountId path parameter. To remove call-out country from a master account, provide me as the value of the accountId path parameter. This operation makes an HTTP DELETE request to the /accounts/{accountId}/sip_trunk/callout_countries/{countryId} endpoint.

Prerequisites: The account making this API request must be a master account 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 remove Call-out country from a sub account, provide the account ID of the sub account in the accountId path parameter. To remove Call-out country from a master account, provide me as the value of the accountId path parameter.

x

Country Id

String

Two lettered ID of the country.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Delete Internal Number

<zoom-connector-mule-4:delete-internal-number>

This API allows a master account with SIP Connected Audio plan to delete a previously assigned internal phone number from a master account or a sub account. To delete an internal number from a sub account, provide the account ID of the sub account in the accountId path parameter. To delete an internal number from a master account, provide me as the value of the accountId path parameter. This operation makes an HTTP DELETE request to the /accounts/{accountId}/sip_trunk/internal_numbers/{numberId} endpoint.

Prerequisites: The account making this API request must be a master account 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 delete an internal number from a sub account, provide the account ID of the sub account in the accountId path parameter. To delete an internal number from a master account, provide me as the value of the accountId path parameter.

x

Number Id

String

Unique identifier of the phone number. This value can be retrieved by calling the List Internal Numbers API.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Delete Location

<zoom-connector-mule-4:delete-location>

Use this API to remove an emergency location. This operation makes an HTTP DELETE request to the /phone/locations/{locationId} endpoint.

Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin permissions.
Scopes: phone:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Location Id

String

The emergency service location’s ID.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Delete Members Of Slg

<zoom-connector-mule-4:delete-members-of-slg>

Members of the shared line group have access to the group’s phone number and voicemail. Use this API to unassign all the existing members from a Shared Line Group. This operation makes an HTTP DELETE request to the /phone/shared_line_groups/{sharedLineGroupId}/members endpoint.

Prerequisites: Pro or higher account with Zoom Phone license. A valid Shared Line Group. Account owner or admin privileges.
Scopes: phone:write:admin
Rate Limit Label: 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 that you would like to delete.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Delete Phone Numbers Slg

<zoom-connector-mule-4:delete-phone-numbers-slg>

Use this API to unassign all the phone numbers that have been assigned to the shared line group. This operation makes an HTTP DELETE request to the /phone/shared_line_groups/{sharedLineGroupId}/phone_numbers endpoint.

Prerequisites: Pro or higher account with Zoom Phone license. A valid Shared Line Group. Account owner or admin privileges.
Scopes: phone:write:admin
Rate Limit Label: 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

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Delete Phone Site

<zoom-connector-mule-4:delete-phone-site>

Sites enable you to organize Zoom Phone users in your organization. Use this API to delete a specific site in a Zoom account. To delete a site, in the query parameter, you must provide the Site ID of another site where the assets of current site (users, numbers and phones) can be transferred to. You cannot use this API to delete the main site. This operation makes an HTTP DELETE request to the /phone/sites/{siteId} endpoint.

Prerequisites: Account must have a Pro or a higher plan with Zoom Phone license. Multiple sites must be 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

Site Id

String

Unique identifier of the site.

x

Transfer site ID

String

Site ID of another site where the assets of the current site (users, numbers and phones) can be transferred to.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Delete Role

<zoom-connector-mule-4:delete-role>

Each Zoom user automatically has a role which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list. Use this API to delete a role. This operation makes an HTTP DELETE request to the /roles/{roleId} endpoint.

Prerequisites: A Pro or higher plan. For role management and updates, you must be the Account Owner or user with role management permissions.
Scopes: role:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Role Id

String

Role ID.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Delete Sip Phone

<zoom-connector-mule-4:delete-sipphone>

Zoom’s Phone System Integration (PSI), also referred as SIP phones, enables an organization to leverage the Zoom client to complete a softphone registration to supported premise based PBX system. End users will have the ability to have softphone functionality within a single client while maintaining a comparable interface to Zoom Phone. Use this API to delete a specific SIP phone on a Zoom account. This operation makes an HTTP DELETE request to the /sip_phones/{phoneId} endpoint.

Prerequisites: Currently only supported on Cisco and Avaya PBX systems. User must enable SIP Phone Integration by contacting the Sales team.
Scope: sip_phone:read:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Phone Id

String

Unique identifier of the SIP Phone. It can be retrieved from the List SIP Phones API.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Delete Sip Trunk

<zoom-connector-mule-4:delete-siptrunk>

Use this API to remove existing SIP trunk of a sub account. This operation makes an HTTP DELETE request to the /accounts/{accountId}/sip_trunk/trunks/{trunkId} endpoint.

Prerequisites: The account making this API request must be a master account with API Partner Plan 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

Trunk Id

String

Unique identifier of the SIP Trunk that was previously assigned to a sub account. To retrieve the value of this field, use the List SIP Trunks API.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Delete User Level Channel

<zoom-connector-mule-4:delete-user-level-channel>

Zoom chat channels allow users to communicate via chat in private or public groups. Use this API to delete a specific channel. This operation makes an HTTP DELETE request to the /chat/channels/{channelId} endpoint.

Scope: chat_channel:write
Rate Limit Label: Medium

Note that this API only supports user-managed OAuth app.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Channel Id

String

Unique identifier of a channel.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Delete User Setting

<zoom-connector-mule-4:delete-user-setting>

Use this API to remove a user’s shared voicemail access settings. For user-level apps, pass the me value instead of the userId parameter. To view these settings in your Zoom web portal, navigate to the Admin Phone System Management and Users Rooms interface. Click the Users tab and select *User Settings. Scroll down to Voicemail Call Recordings. This operation makes an HTTP DELETE request to the /phone/users/{userId}/settings/{settingType} endpoint.

Prerequisites: A Business or Enterprise account.
Scopes: phone:write:admin
Rate Limit Label: 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 remove. Allowed values: voice_mail

x

Shared ID

String

Required only for voicemail setting type.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Delete Voicemail

<zoom-connector-mule-4:delete-voicemail>

Use this API to delete an account’s voicemail message. This operation makes an HTTP DELETE request to the /phone/voice_mails/{voicemailId} endpoint.

Prerequisites: A Zoom Phone license.
Scopes: phone:write:admin, phone:write, phone_voicemail:write, phone_voicemail:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Voicemail Id

String

Unique identifier of the voicemail. Retrieve the value for this field by calling the [Get voicemails](https://marketplace.zoom.us/docs/api-reference/zoom-api/phone/phoneuservoicemails) API.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Delete Webinar Registrant

<zoom-connector-mule-4:delete-webinar-registrant>

Delete a webinar registrant. This operation makes an HTTP DELETE request to the /webinars/{webinarId}/registrants/{registrantId} endpoint.

Scopes: webinar:write:admin webinar:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Webinar Id

Number

The webinar ID.

x

Registrant Id

String

The registrant ID.

x

Occurrence ID

String

The webinar occurence ID.

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Device Create

<zoom-connector-mule-4:device-create>

An H.323 or SIP device can make a video call to a Room Connector to join a Zoom cloud meeting. A Room Connector can also call out to an H.323 or SIP device to join a Zoom cloud meeting. Use this API to add an H.323/SIP device to your Zoom account. This operation makes an HTTP POST request to the /h323/devices endpoint.

Scopes: h323:write:admin
Rate Limit Label: 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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Device Delete

<zoom-connector-mule-4:device-delete>

An H.323 or SIP device can make a video call to a Room Connector to join a Zoom cloud meeting. A Room Connector can also call out to an H.323 or SIP device to join a Zoom cloud meeting. Use this API to delete an H.323/SIP device from your Zoom account. This operation makes an HTTP DELETE request to the /h323/devices/{deviceId} endpoint.

Scopes: h323:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Device Id

String

The device 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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Device List

<zoom-connector-mule-4:device-list>

An H.323 or SIP device can make a video call to a Room Connector to join a Zoom cloud meeting. A Room Connector can also call out to an H.323 or SIP device to join a Zoom cloud meeting. Use this API to list all H.323/SIP Devices on a Zoom account. This operation makes an HTTP GET request to the /h323/devices endpoint.

Scopes: h323:read:admin
Rate Limit Label: 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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Device Update

<zoom-connector-mule-4:device-update>

An H.323 or SIP device can make a video call to a Room Connector to join a Zoom cloud meeting. A Room Connector can also call out to an H.323 or SIP device to join a Zoom cloud meeting. Use this API to edit H.323/SIP device information from your Zoom account. This operation makes an HTTP PATCH request to the /h323/devices/{deviceId} endpoint.

Scopes: h323:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Device Id

String

The device ID.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Download Invoice Pdf

<zoom-connector-mule-4:download-invoice-pdf>

Use this API to download a Zoom account’s billed invoice file, in PDF format. To get an account’s invoice ID, use the List billing invoices API. This operation makes an HTTP GET request to the /api/download/billing/invoices/{invoiceId} endpoint.

Scopes: billing:master
Rate Limits: You can make one request to this API every 30 minutes until the daily limit is reached. This API has a daily limit of 100 requests per account.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Invoice Id

String

Invoice ID.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Edit Message

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

Use this API to edit a chat message that you previously sent to either a contact or a channel in Zoom by providing the ID of the message as the value of the messageId parameter. You can get the ID from the List User’s Chat Messages API. Additionally, as a query parameter, you must provide either the contact’s email address of the contact or the Channel ID of the channel where the message was sent. For user-level apps, pass the me value instead of the userId parameter. Note: For an account-level OAuth app, this API can only be used on behalf of a user who is assigned with a role that has the Edit permission for Chat Messages. This operation makes an HTTP PUT request to the /chat/users/{userId}/messages/{messageId} endpoint.

Scope: chat_message:write,chat_message:write:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

User ID.

x

Message Id

String

Unique identifier of the message.

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get A Blocked List

<zoom-connector-mule-4:get-ablocked-list>

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

Prerequisites: Pro or higher account plan with Zoom phone license.
Scope: phone:read:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Blocked List Id

String

Unique identifier of the blocked list.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get A Call Queue

<zoom-connector-mule-4:get-acall-queue>

Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service etc. Use this API to get information on a specific Call Queue. This operation makes an HTTP GET request to the /phone/call_queues/{callQueueId} endpoint.

Prerequisites: Pro, Business, or Education account. Account owner or admin permissions. Zoom Phone license.
Scopes: phone:read:admin
Rate Limit Label: 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. This can be retrieved from [List Call Queues API](https://marketplace.zoom.us/docs/api-reference/zoom-api/phone-call-queues/listcallqueues).

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get Account Billing Invoice

<zoom-connector-mule-4:get-account-billing-invoice>

Get detailed information about a specific invoice. To retrieve a regular Zoom account’s invoice details or a master account’s invoice details, provide me as the value of accountId path parameter. To list a sub account’s invoice details, provide the account ID of the sub account in the accountId path parameter. This operation makes an HTTP GET request to the /accounts/{accountId}/billing/invoices/{invoiceId} endpoint.

Prerequisites: Account must be enrolled in Pro or a higher plan. You can make one API request every thirty minutes until the daily limit is reached. This API has a daily limit of 100 requests per account.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Account Id

String

The account ID.

x

Invoice Id

String

The invoice ID.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get Account Cloud Recording

<zoom-connector-mule-4:get-account-cloud-recording>

List cloud recordings available on an Account. To access a password protected cloud recording, add an "access_token" parameter to the download URL and provide JWT as the value of the "access_token". This operation makes an HTTP GET request to the /accounts/{accountId}/recordings endpoint.

Prerequisites: A Pro or a higher paid plan with Cloud Recording option enabled.
Scopes: recording:read:admin or account:read:admin. If the scope recording:read:admin is used, the Account ID of the Account must be provided in the accountId path parameter to list recordings that belong to the Account. This scope only works for sub accounts. To list recordings of a master account, the scope must be account:read:admin and the value of accountId should be me.
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Account Id

String

Unique identifier of the account.

x

Page size

Number

Number of records returned within a single API call.

30

from

String

The start date in UTC for the monthly range for which you would like to retrieve recordings. The maximum range can be a month. If no value is provided for this field, the default will be the current date. For example, if you make the API request on June 30, 2020, without providing the from and to parameters, the default value of the from field will be 2020-06-30 and the value of the to field will be 2020-07-01.

to

String

The end date for the monthly range for which you would like to retrieve recordings. The maximum range can be a month.

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get Account Lock Settings

<zoom-connector-mule-4:get-account-lock-settings>

Account Locked Settings allow you turn settings on or off for all users in your account. No user except the account admin or account owner can change these settings. With lock settings, you force the settings on for all users. Use this API to retrieve an account’s locked settings. Note that this API can be used by Zoom Accounts that are on a Pro or a higher plan as well accounts that have master and sub accounts options enabled. This operation makes an HTTP GET request to the /accounts/{accountId}/lock_settings endpoint.

Prerequisites: Pro or a higher paid account.
Scope: account:read:admin.
Rate Limit Label: Medium

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

option

String

meeting_security: Use this query parameter to view meeting security settings applied on the account.

Custom query fields

String

Provide the name of the field by which you would like to filter the response. For example, if you provide "host_video" as the value of this field, you will get a response similar to the following: { "schedule_meeting": { "host_video": false } } You can provide multiple values by separating them with commas(example: "host_video,participant_video).

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get A Common Area Phone

<zoom-connector-mule-4:get-acommon-area-phone>

Use this API to get details on a specific common area phone in an account. A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don’t belong to a specific employees, you could add a common area phone so that any person can use it. This operation makes an HTTP GET request to the /phone/common_area_phones/{commonAreaPhoneId} endpoint.

Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin permissions. A supported device.
Scopes: phone:read:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Common Area Phone Id

String

Unique identifier of the common area phone. Use the unique identifier or the Mac address of the common area phone. The Mac address can be in hyphenated (00-04-f2-5e-ec-3c) or not hyphenated (0004f25eec3c) format. You can get this value from the List Common Area Phones API.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get A Device

<zoom-connector-mule-4:get-adevice>

Get detailed information about a specific desk phone device. This operation makes an HTTP GET request to the /phone/devices/{deviceId} endpoint.

Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin permissions.
Scopes: phone:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Device Id

String

Unique identifier of the device.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get A External Contact

<zoom-connector-mule-4:get-aexternal-contact>

Use this API to get an external contact’s information. This operation makes an HTTP GET request to the /phone/external_contacts/{externalContactId} endpoint.

Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin permissions.
Scopes: phone:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

External Contact Id

String

The external contact’s ID.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get A Shared Line Group

<zoom-connector-mule-4:get-ashared-line-group>

A shared line group allows Zoom Phone admins to share a phone number and extension with a group of phone users or common area phones. This gives members of the shared line group access to the group’s direct phone number and voicemail. Use this API to list all the Shared Line Groups. This operation makes an HTTP GET request to the /phone/shared_line_groups/{sharedLineGroupId} endpoint.

Prerequisites: Pro or higher account with Zoom Phone license. Account owner or admin privileges.
Scopes: phone:read:admin or phone:write:admin
Rate Limit Label: 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

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get A Site

<zoom-connector-mule-4:get-asite>

Sites allow you to organize Zoom Phone users in your organization. Use this API to get information about a specific site. This operation makes an HTTP GET request to the /phone/sites/{siteId} endpoint.

Prerequisites: Account must have a Pro or a higher plan with Zoom Phone license. Multiple Sites must be enabled.
Scope: phone:read:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Site Id

String

Unique identifier of the site.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get Billing Invoices Reports

<zoom-connector-mule-4:get-billing-invoices-reports>

Get department billing invoices reports for a specific billing period. Provide the billing_id of the billing period for which you would like to retrieve the invoices for. This ID can be retrieved from Get Billing Reports API. This operation makes an HTTP GET request to the /report/billing/invoices endpoint.

Prerequisites: Pro or a higher account with Department Billing option enabled. Contact the Zoom Support team to enable this feature.
Scopes: report:read:admin, report:master
Rate Limit Label: Heavy

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Billing ID

String

Unique identifier of the Billing Report. Retrieve this ID from the response of Get Billing Reports API request.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get Billing Report

<zoom-connector-mule-4:get-billing-report>

Get department billing reports of a Zoom account. This operation makes an HTTP GET request to the /report/billing endpoint.

Prerequisites: Pro or a higher account with Department Billing option enabled. Contact Zoom Support team for details.
Scopes: report:read:admin, report:master
Rate Limit Label: Heavy

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get Call Log Details

<zoom-connector-mule-4:get-call-log-details>

Use this API to return information about call logs. This operation makes an HTTP GET request to the /phone/call_logs/{callLogId} endpoint.

Prerequisites: A Business or Enterprise account. A Zoom Phone license.
Scopes: phone:read, phone:read:admin, phone_call_log:read, phone_call_log:read:admin
Rate Limit Label: Heavy

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Call Log Id

String

Unique identifier of the call log. Both callLogId and callId can be used as path parameters. The value for this field can be retrieved from account’s call logs or the user’s call logs.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get Call Log Metrics Details

<zoom-connector-mule-4:get-call-log-metrics-details>

Call logs provide a record of all incoming and outgoing calls over Zoom Phone in an account. Use this API to list call log details of a specific call. This operation makes an HTTP GET request to the /phone/metrics/call_logs/{call_id} endpoint.

Prerequisites: Business, or Education account. Zoom Phone license.
Scopes: phone:read:admin, phone:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Call ID

String

Unique identifier of the phone call. The value of this field can be retrieved from [List Call Logs]() API.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get Call Qo S

<zoom-connector-mule-4:get-call-qo-s>

Get call quality of service (QoS) data for a call made or received by a Zoom phone user in the account. This operation makes an HTTP GET request to the /phone/metrics/call_logs/{callId}/qos endpoint.

Prerequisites: Business, or Education account. Zoom Phone license.
Scopes: phone:read:admin, phone:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Call Id

String

Unique identifier of the call.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get Call Queue Recordings

<zoom-connector-mule-4:get-call-queue-recordings>

Use this API to view call recordings from the call queue. This operation makes an HTTP GET request to the /phone/call_queues/{callQueueId}/recordings endpoint.

Prerequisites: Pro or higher account with Zoom Phone license. Automatic call recordings must be enabled in the Policy Settings for call queues.
Scope: phone:read:admin
Rate Limit Label: Medium

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

Page size

Number

Number of records returned within a single API call.

30

from

String

Start date (within a 6 month range).

to

String

End date (within a 6 month range).

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get Channel

<zoom-connector-mule-4:get-channel>

Use this API to get information about a specific channel. For user-level apps, pass the me value instead of the userId parameter. Zoom chat channels allow users to communicate via chat in private or public groups. This operation makes an HTTP GET request to the /chat/users/{userId}/channels/{channelId} endpoint.

Scopes: chat_channel:read:admin
Rate Limit Label: Medium

Note: For an account-level OAuth app, this API can only be used on behalf of a user who is assigned with a role that has the View or Edit permission for Chat Channels.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Channel Id

String

Unique identifier of a channel.

x

User Id

String

Unique identifier of the user who is the owner of the channel.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get Channels

<zoom-connector-mule-4:get-channels>

Use this API to list a user’s chat channels. For user-level apps, pass the me value instead of the userId parameter. Zoom chat channels allow users to communicate via chat in private or public groups. This operation makes an HTTP GET request to the /chat/users/{userId}/channels endpoint.

Scopes: chat_channel:read or chat_channel:read:admin
Rate Limit Label: Medium

Note that this API supports both user-managed apps and account-level apps. However, in an account-level OAuth app, to list channels of another user in the same Zoom account, the user calling this API must have a role that has the View or 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

Page size

Number

The number of records returned from a single API call.

10

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get Chat Message

<zoom-connector-mule-4:get-chat-message>

Get a chat message previously sent to a contact or a channel. For user-level apps, pass the me value instead of the userId parameter. You must provide one of the following query parameters: * to_contact - The email address of the Zoom contact to whom you sent the message. * to_channel - The ID of the Zoom channel where you sent the message. This operation makes an HTTP GET request to the /chat/users/{userId}/messages/{messageId} endpoint.

Scopes: chat_message:read, chat_message:read:admin
Rate Limit Label: Medium

Note: For an account-level OAuth app, you can only use this API for a user assigned the Edit permission for the Chat message role setting.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

User ID.

x

Message ID

String

Message ID.

x

To contact

String

The userId or email address of a Zoom Chat contact to whom you sent the message. Note: You must use this query parameter to delete a message sent to a Zoom Chat contact.

To channel

String

The channelId of the Zoom Chat channel where the message is sent. Note: You must use this query parameter to delete a message sent to Zoom Chat channel.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get Chat Messages

<zoom-connector-mule-4:get-chat-messages>

Use this API to list the current user’s chat messages between the user and an individual contact or a chat channel. For user-level apps, pass the me value instead of the userId parameter. In the query parameter, you must provide one of the following: * to_contact: The email address of the contact with whom the user conversed by sending or receiving messages. * to_channel: The channel ID of the channel to or from which the user has sent and/or received messages. Note: For an account-level OAuth app, this API can only be used on behalf of a user who is assigned with a role that has the View or Edit permission for Chat Messages. This operation makes an HTTP GET request to the /chat/users/{userId}/messages endpoint.

Scopes: chat_message:read, chat_message:read:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

User ID.

x

To contact

String

The email address of a chat contact with whom the current user chatted. Messages that were sent and/or received between the user and the contact are displayed. Note: You must provide either contact or channel as a query parameter to retrieve messages either from an individual or a chat channel.

To channel

String

The channel Id of a channel inside which the current user had chat conversations. Messages that were sent and/or received between the user and the channel are displayed. Note: You must provide either contact or channel as a query parameter to retrieve messages either from an individual or a chat channel.

date

String

The query date for which you would like to get the chat messages. This value defaults to the current date.

Page size

Number

The number of records returned with a single API call.

10

Include deleted and edited message

String

Optional Set the value of this field to true to include edited and deleted messages 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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get Group Lock Settings

<zoom-connector-mule-4:get-group-lock-settings>

Retrieve a group’s locked settings. If you lock a setting, the group members will not be able to modify it individually. Note: The force_pmi_jbh_password field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality. This operation makes an HTTP GET request to the /groups/{groupId}/lock_settings endpoint.

Prerequisites: Pro, Business, or Education account.
Scopes: group:read:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Group Id

String

ID of the group.

x

Custom query fields

String

Provide the name of the field by which you would like to filter the response. For example, if you provide "host_video" as the value of this field, you will get a response similar to the following: { "schedule_meeting": { "host_video": false } } You can provide multiple values by separating them with commas(example: "host_video,participant_video).

option

String

Specify meeting_security as the value of this field if you would like to view security settings applied on a meeting hosted by the users in this group.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get Group Settings

<zoom-connector-mule-4:get-group-settings>

Get settings for a group. This operation makes an HTTP GET request to the /groups/{groupId}/settings endpoint.

Prerequisites: Pro, Business, or Education account.
Scopes: group:read:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Group Id

String

Group ID.

x

Custom query fields

String

Provide the name of the field by which you would like to filter the response. For example, if you provide "host_video" as the value of this field, you will get a response similar to the following: { "schedule_meeting": { "host_video": false } } You can provide multiple values by separating them with commas(example: "host_video,participant_video).

option

Enumeration, one of:

MEETING_AUTHENTICATION
RECORDING_AUTHENTICATION

* meeting_authentication: Use this query parameter to view meeting authentication configuration applied on the group.

* recording_authentication: Use this query parameter to view recording authentication configuration applied on the group.

* meeting_security: Use this query parameter to view meeting security settings applied on the group.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get Live Stream Details For Meeting

<zoom-connector-mule-4:get-live-stream-details-for-meeting>

Zoom allows users to live stream a meeting to a custom platform. Use this API to get a meeting’s live stream configuration details such as Stream URL, Stream Key, and Page URL. This operation makes an HTTP GET request to the /meetings/{meetingId}/livestream endpoint.

Prerequisites: Meeting host must be a licensed user with a Pro or higher plan. Live streaming details must have been configured for the meeting.
Scopes: meeting:read:admin meeting:read
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

String

Unique identifier of the meeting.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get Live Stream Details For Webinar

<zoom-connector-mule-4:get-live-stream-details-for-webinar>

Zoom allows users to live stream a webinar to a custom platform. Use this API to get a webinar’s live stream configuration details such as Stream URL, Stream Key, and Page URL. This operation makes an HTTP GET request to the /webinars/{webinarId}/livestream endpoint.

Prerequisites: Pro or higher plan with a Webinar Add-on. Live streaming details must have been configured for the webinar.
Scopes: webinar:read:admin webinar:read
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Webinar Id

String

The webinar’s unique ID.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get Location

<zoom-connector-mule-4:get-location>

Use this API to return an emergency service location’s information. This operation makes an HTTP GET request to the /phone/locations/{locationId} endpoint.

Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin permissions.
Scopes: phone:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Location Id

String

The emergency service location’s ID.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get Phone Number Details

<zoom-connector-mule-4:get-phone-number-details>

Use this API to get information about an account’s Zoom Phone number. This operation makes an HTTP GET request to the /phone/numbers/{numberId} endpoint.

Prerequisites: A Pro or higher account plan. A Zoom phone license.
Scopes: phone:read:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Number Id

String

Unique identifier of the Phone Number. This can be retrieved from the List Phone Numbers API.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get Phone Recordings

<zoom-connector-mule-4:get-phone-recordings>

Use this API to list an account’s call recordings. This operation makes an HTTP GET request to the /phone/recordings endpoint.

Prerequisites: A Pro or higher account plan. A Zoom phone license. Account owner or admin privileges.
Scopes: phone:read:admin, phone:write:admin, phone_recording:read:admin

Parameters

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. The default is 30, and the maximum is 100.

from

String

Start date and time in yyyy-mm-dd format or yyyy-MM-dd HH:mm:ss format. The date range defined by the from and to parameters should only be one month as the report includes only one month worth of data at once.

to

String

End date and time in yyyy-mm-dd format or yyyy-MM-dd HH:mm:ss format, the same formats supported by the from parameter.

Owner type

String

The owner type. The allowed values are null, user, or callQueue. The default is null. If null, returns all owner types.

all

Recording type

String

The recording type. The allowed values are null, OnDemand, or Automatic. The default is null. If null, returns all recording types.

Site ID

String

The site ID. The default is All sites.

All sites

Query date type

Enumeration, one of:

START_TIME
END_TIME

The query’s date type.

START_TIME

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get Plan Usage

<zoom-connector-mule-4:get-plan-usage>

Get information on usage of plans of an account. This API supports regular accounts as well as master and sub accounts. To get the plan usage of a regular account, use the account:read:admin scope and provide me as the value of the accountId path parameter. To get plan usage of a master account, provide the keyword "me" as the value of the accountId path parameter and use the billing:master scope. To get plan usage of a sub account, provide the actual account Id of the sub account as the value of the accountId path parameter and use the billing:master scope. This operation makes an HTTP GET request to the /accounts/{accountId}/plans/usage endpoint.

Prerequisites: Account type: master account on a paid Pro, Business, or Enterprise plan.
Scope: billing:master for master and sub accounts. account:read:admin for regular Zoom accounts.
Rate Limit Label: Heavy

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Account Id

String

Account ID.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get Ps Operation Logs

<zoom-connector-mule-4:get-psoperation-logs>

The Phone System operation logs report allows account owners and admins to view monthly Zoom phone related admin operation details. Use this API to retrieve the Phone System Operation Logs Report. Account owners and admins can also access this information by logging into their Zoom accounts and navigating to phone system operation logs. This operation makes an HTTP GET request to the /phone/reports/operationlogs endpoint.

Prerequisites: Account must be enrolled in Pro or a higher plan. Account must be enrolled in a Zoom phone plan.
Scopes: phone:read:admin, phone:write: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 provides only one month worth of data per API request.

to

String

End date in 'yyyy-mm-dd' format.

Category type

String

Filter the response by the category of the action performed. By default, the value of this field is "all" and thus, the response will include log of all operations for the defined period. To only include response for a specific category type, provide a value for category_type from this table.

all

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get Role Information

<zoom-connector-mule-4:get-role-information>

Each Zoom user automatically has a role which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list of privileges. Use this API to get information including specific privileges assigned to a role. This operation makes an HTTP GET request to the /roles/{roleId} endpoint.

Prerequisites: A Pro or higher plan. For role management and updates, you must be the Account Owner or user with role management permissions.
Scopes: role:read:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Role Id

String

Role ID.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get Setting Template

<zoom-connector-mule-4:get-setting-template>

Use this API to return information about an account’s phone template. This operation makes an HTTP GET request to the /phone/setting_templates/{templateId} endpoint.

Prerequisites: A Business or Enterprise account. A Zoom Phone license.
Scopes: phone:write:admin or phone:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Template Id

String

Unique identifier of the template.

x

Custom query fields

String

Provide the name of the field to use to filter the response. For example, if you provide "description" as the value of the field, you will get a response similar to the following: {description: template description}.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get Tracking Sources

<zoom-connector-mule-4:get-tracking-sources>

Webinar Registration Tracking Sources allow you to see where your registrants are coming from if you share the webinar registration page in multiple platforms. You can then use the source tracking to see the number of registrants generated from each platform. Use this API to list information on all the tracking sources of a webinar. This operation makes an HTTP GET request to the /webinars/{webinarId}/tracking_sources endpoint.

Prerequisites: Webinar license. Registration must be required for the Webinar.
Scopes: webinar:read:admin, webinar:read
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Webinar Id

Number

The webinar ID in "long" format (represented as int64 data type in JSON).

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get User Contact

<zoom-connector-mule-4:get-user-contact>

A user under an organization’s Zoom account has internal users listed under Company Contacts in the Zoom Client. A Zoom user can also add another Zoom user as a contact. Call this API to get information on a specific contact of the Zoom user. Note that this API only supports user-managed OAuth app. This operation makes an HTTP GET request to the /chat/users/me/contacts/{contactId} endpoint.

Scope: chat_contact:read
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Contact Id

String

The user’s contact ID or email address. The contact can be either a company contact or an external contact.

x

Query presence status

Boolean

The presence status of the contact. Include this query parameter with a value of true to get the presence status of the contact in the response.

false

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get User Contacts

<zoom-connector-mule-4:get-user-contacts>

A user under an organization’s Zoom account has internal users listed under Company Contacts in the Zoom Client. A Zoom user can also add another Zoom user as a contact. Call this API to list all the contacts of a Zoom user. Zoom contacts are categorized into "company contacts" and "external contacts". You must specify the contact type in the type query parameter. If you do not specify, by default, the type will be set as company contact. Note that this API only supports user-managed OAuth app. This operation makes an HTTP GET request to the /chat/users/me/contacts endpoint.

Scope: chat_contact:read
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

type

String

The type of contact. The value can be one of the following:

* company

Contacts from the user’s organization.

* external

External contacts.

company

Page size

Number

The number of records returned with a single API call.

10

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get User Level Channel

<zoom-connector-mule-4:get-user-level-channel>

Zoom chat channels allow users to communicate via chat in private or public groups. Use this API to get information about a specific channel. This operation makes an HTTP GET request to the /chat/channels/{channelId} endpoint.

Scope: chat_channel:read
Rate Limit Label: Medium

Note that this API supports only user-managed OAuth apps. If you use an Account-Level OAuth Access token, you can only retrieve the channel information for the authorized user. You can’t retrieve the channel information of other account users. Use the Account-Level Get Channel Info API to retrieve the channel information of other account users.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Channel Id

String

Unique identifier of a channel.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get Zr Account Profile

<zoom-connector-mule-4:get-zraccount-profile>

Get details on the account profile of a Zoom Room. This information can only by accessed either by the Zoom Room Account Owner or a user with Zoom Rooms admin permission. To get information on an individual Room Profile, use Get Zoom Room Profile API instead. This operation makes an HTTP GET request to the /rooms/account_profile endpoint.

Prerequisites: Zoom account owner or Zoom Rooms admin permissions.
Scopes: room:read:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get Zr Account Settings

<zoom-connector-mule-4:get-zraccount-settings>

Get details on Account Settings of a Zoom Room. With this API, you can view either the Account Meeting Settings or the Alert Settings (Client Alert Settings and Notfication Settings) of the Zoom Rooms account. By default, only Account Meeting Settings are returned. To view only Alert Settings, specify alert as the value of the setting_type query parameter. This operation makes an HTTP GET request to the /rooms/account_settings endpoint.

Prerequisites: Zoom Room licenses. Owner or Admin privileges on the Zoom Account.
Scopes: room:read:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Setting type

Enumeration, one of:

MEETING
ALERT

The type of setting that you would like to retrieve:

* meeting

Meeting settings of the Zoom Rooms Account.

* alert

Alert Settings applied on the Zoom Rooms Account.

* signage

View digital signage settings of the Zoom Rooms Account.

MEETING

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get Zr Location Profile

<zoom-connector-mule-4:get-zrlocation-profile>

Each location type of the Zoom Rooms Location Hierarchy has a profile page that includes information such as name of the location, address, or support email. Use this API to retrieve information about a specific Zoom Rooms location type such as information about the city where the Zoom Rooms is located. This operation makes an HTTP GET request to the /rooms/locations/{locationId} endpoint.

Prerequisites: Account owner or admin permission. Zoom Rooms version 4.0 or higher.
Scopes: room:read:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Location Id

String

Unique identifier of the location type. This can be retrieved using the [List Zoom Room Location API](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) (Id property in the response).

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get Zr Location Settings

<zoom-connector-mule-4:get-zrlocation-settings>

Get information on meeting or alert settings applied to Zoom Rooms located in a specific location. By default, only Meeting Settings are returned. To view only Alert Settings, specify alert as the value of the setting_type query parameter. This operation makes an HTTP GET request to the /rooms/locations/{locationId}/settings endpoint.

Prerequisites: Zoom Room licenses. Owner or Admin privileges on the Zoom Account.
Scopes: room:read:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Location Id

String

Unique identifier of the location type. This can be retrieved using the [List Zoom Room Location API](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) (Id property in the response).

x

Setting type

String

The type of setting that you would like to retrieve. alert: Alert Settings applied on the Zoom Rooms Account. meeting: Meeting settings of the Zoom Rooms Account. signage: Digital signage settings of the Zoom Rooms Account.

meeting

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get Zr Location Structure

<zoom-connector-mule-4:get-zrlocation-structure>

Get the location hierarchial structure(s) applied on the Zoom Rooms in an account. This operation makes an HTTP GET request to the /rooms/locations/structure endpoint.

Prerequisites: Zoom Rooms version 4.0 or higher. Account owner or admin permissions.
Scopes: room:read:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get Zr Profile

<zoom-connector-mule-4:get-zrprofile>

Zoom Rooms is a software-based room system that provides an integrated experience for audio conferencing, wireless screen sharing and video conferencing. Use this API to get detailed information on a specific Zoom Room in a Zoom account. This operation makes an HTTP GET request to the /rooms/{roomId} endpoint.

Prerequisites: Pro or a higher plan with Zoom Room license.
Scopes: room:read:admin
Rate Limit Label: Medium

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. This can be retrieved from the response of List Zoom Rooms API.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Get Zr Settings

<zoom-connector-mule-4:get-zrsettings>

Get information on meeting or alert settings applied to a specific Zoom Room. By default, only Meeting Settings are returned. To view only Alert Settings, specify alert as the value of the setting_type query parameter. This operation makes an HTTP GET request to the /rooms/{roomId}/settings endpoint.

Prerequisites: Zoom Room licenses. Owner or Admin privileges on the Zoom Account.
Scopes: room:read:admin
Rate Limit Label: Medium

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

Setting type

String

The type of setting that you would like to retrieve. alert: Alert Settings applied on the Zoom Rooms Account. meeting: Meeting settings of the Zoom Rooms Account.

meeting

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Group

<zoom-connector-mule-4:group>

Get a group under an account. This operation makes an HTTP GET request to the /groups/{groupId} endpoint.

Prerequisites: Pro, Business, or Education account.
Scopes: group:read:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Group Id

String

The group ID. Can be retrieved by calling GET /groups.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Group Create

<zoom-connector-mule-4:group-create>

Create a group under an account. You can add a maximum of 100 groups in one account per day. If you go over, you will get an error. You can add a maximum of 5000 groups in one account. This operation makes an HTTP POST request to the /groups endpoint.

Prerequisites: Pro or higher account.
Scopes: group:write:admin
Rate Limit Label: 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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Group Delete

<zoom-connector-mule-4:group-delete>

Delete a group. This operation makes an HTTP DELETE request to the /groups/{groupId} endpoint.

Prerequisites: Pro, Business, or Education account.
Scopes: group:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Group Id

String

The group ID. Can be retrieved by calling GET /groups.

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Group Locked Settings

<zoom-connector-mule-4:group-locked-settings>

Update a group’s locked settings. If you lock a setting, the group members will not be able to modify it individually. Note that the force_pmi_jbh_password field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality. This operation makes an HTTP PATCH request to the /groups/{groupId}/lock_settings endpoint.

Prerequisites: Pro, Business, or Education account.
Scopes: group:write:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Group Id

String

ID of the group.

x

Custom query fields

String

Provide the name of the field by which you would like to filter the response. For example, if you provide "host_video" as the value of this field, you will get a response similar to the following: { "schedule_meeting": { "host_video": false } }. You can provide multiple values by separating them with commas (example: "host_video,participant_video).

option

String

Specify meeting_security as the value of this field if you would like to view security settings applied on a meeting hosted by the users in this group.

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Group Members

<zoom-connector-mule-4:group-members>

List the members of a group under your account. This operation makes an HTTP GET request to the /groups/{groupId}/members endpoint.

Prerequisites: Pro, Business, or Education account.
Scopes: group:read:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Group Id

String

The group ID. Can be retrieved by calling GET /groups.

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Group Members Create

<zoom-connector-mule-4:group-members-create>

Add members to a group under your account. This operation makes an HTTP POST request to the /groups/{groupId}/members endpoint.

Prerequisites: Pro, Business, or Education account.
Scopes: group:write:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Group Id

String

The group ID. Can be retrieved by calling GET /groups.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Group Members Delete

<zoom-connector-mule-4:group-members-delete>

Delete a member from a group in a Zoom account. This operation makes an HTTP DELETE request to the /groups/{groupId}/members/{memberId} endpoint.

Prerequisites: Pro, Business, or Education account.
Scopes: group:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Group Id

String

The group ID. Can be retrieved by calling GET /groups.

x

Member Id

String

The member 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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Group Update

<zoom-connector-mule-4:group-update>

Update a group under your account. This operation makes an HTTP PATCH request to the /groups/{groupId} endpoint.

Prerequisites: Pro, Business, or Education account.
Scopes: group:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Group Id

String

The group ID. Can be retrieved by calling GET /groups.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Groups

<zoom-connector-mule-4:groups>

List groups under an account. This operation makes an HTTP GET request to the /groups endpoint.

Prerequisites: Pro or higher account.
Scopes: group:read:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Im Chat Messages

<zoom-connector-mule-4:im-chat-messages>

Retrieve IM chat messages for a specified period of time. This API only supports oauth2. This operation makes an HTTP GET request to the /im/chat/sessions/{sessionId} endpoint.

Scopes: imchat:read
Rate Limit Label: Medium

Deprecated: By the end of 2021, Zoom will deprecate this API in favor of a consolidated set of APIs. The API will still be available for you to use, though Zoom will no longer provide support for it. For further information, refer to Announcements: IM APIs Deprecation.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Session Id

String

IM chat session 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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Im Chat Sessions

<zoom-connector-mule-4:im-chat-sessions>

Retrieve IM Chat sessions for a specified period of time. This API only supports Oauth2. This operation makes an HTTP GET request to the /im/chat/sessions endpoint.

Scopes: imchat:read, imchat:read:admin
Rate Limit Label: Heavy

Deprecated: By the end of 2021, Zoom will deprecate this API in favor of a consolidated set of APIs. The API will still be available for you to use, though Zoom will no longer provide support for it. For further information, refer to Announcements: IM APIs Deprecation.

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Im Group

<zoom-connector-mule-4:im-group>

Retrieve an IM directory group under your account. This operation makes an HTTP GET request to the /im/groups/{groupId} endpoint.

Scopes: imgroup:read:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Group Id

String

The group ID. Can be retrieved by calling GET /groups.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Im Group Create

<zoom-connector-mule-4:im-group-create>

Create an IM directory group under your account. This operation makes an HTTP POST request to the /im/groups endpoint.

Scopes: imgroup: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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Im Group Delete

<zoom-connector-mule-4:im-group-delete>

Delete an IM directory group under your account. This operation makes an HTTP DELETE request to the /im/groups/{groupId} endpoint.

Scopes: imgroup:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Group Id

String

The group ID. Can be retrieved by calling GET /groups.

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Im Group Members

<zoom-connector-mule-4:im-group-members>

List the members of an IM directory group. This operation makes an HTTP GET request to the /im/groups/{groupId}/members endpoint.

Scope: imgroup:read:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Group Id

String

The group ID. Can be retrieved by calling GET /groups.

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Im Group Members Create

<zoom-connector-mule-4:im-group-members-create>

Add members to an IM directory group under an account. This operation makes an HTTP POST request to the /im/groups/{groupId}/members endpoint.

Scope: imgroup:write:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Group Id

String

The group ID. Can be retrieved by calling GET /groups.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Im Group Members Delete

<zoom-connector-mule-4:im-group-members-delete>

Delete a member from an IM directory group under an account. This operation makes an HTTP DELETE request to the /im/groups/{groupId}/members/{memberId} endpoint.

Scopes: imgroup:write:admin * Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Group Id

String

The group ID. Can be retrieved by calling GET /groups.

x

Member Id

String

The member 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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Im Group Update

<zoom-connector-mule-4:im-group-update>

Update an IM directory group under your account. This operation makes an HTTP PATCH request to the /im/groups/{groupId} endpoint.

Scopes: imgroup:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Group Id

String

The group ID. Can be retrieved by calling GET /groups.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Im Groups

<zoom-connector-mule-4:im-groups>

List IM directory groups. This operation makes an HTTP GET request to the /im/groups endpoint.

Scopes: imgroup:read:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

In Meeting Recording Control

<zoom-connector-mule-4:in-meeting-recording-control>

Use this API to control the in-meeting recording features, such as starting a recording, stopping a recording, pausing a recording, and resuming a recording. This API only works for Cloud Recordings and not for local recordings. This operation makes an HTTP PATCH request to the /live_meetings/{meetingId}/events endpoint.

Prerequisites: The meeting must be a live meeting. Cloud Recording must be enabled. The user using this API must either be the host or alternative host of the meeting.
Scopes: meeting:write, meeting:write:admin, meeting:master

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

String

Unique identifier of the live meeting.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Invite Channel Members

<zoom-connector-mule-4:invite-channel-members>

Use this API to invite members that are in a user’s contact list to a channel. For user-level apps, pass the me value instead of the userId parameter. This operation makes an HTTP POST request to the /chat/users/{userId}/channels/{channelId}/members endpoint.

Scopes: chat_channel:write:admin
Rate Limit Label: Medium

Note: For an account-level OAuth app, this API can only be used on behalf of a user who is assigned with a role that has the Edit permission for Chat Channels.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Channel Id

String

Channel ID: Unique identifier of the channel.

x

User Id

String

Unique identifier of the user who is the owner of this channel.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Join Channel

<zoom-connector-mule-4:join-channel>

A channel can have one or multiple members. Use this API to join a channel that is open for anyone in the same organization to join. You cannot use this API to join private channels that only allows invited members to be a part of it. Note that this API only supports user-managed OAuth app. This operation makes an HTTP POST request to the /chat/channels/{channelId}/members/me endpoint.

Scope: chat_channel:write
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Channel Id

String

Channel ID.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Leave Channel

<zoom-connector-mule-4:leave-channel>

If you’re no longer interested in being a member of an existing channel, you can leave the channel at any time. Use this API to leave a specific channel. After leaving the channel, you can no longer access information from that channel. Note that this API only supports user-managed OAuth app. This operation makes an HTTP DELETE request to the /chat/channels/{channelId}/members/me endpoint.

Scope: chat_channel:write
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Channel Id

String

Unique identifier of a channel.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

List Account Phone Numbers

<zoom-connector-mule-4:list-account-phone-numbers>

Use this API to list all Zoom Phone numbers in a Zoom account. This operation makes an HTTP GET request to the /phone/numbers endpoint.

Prerequisites: A Pro or higher account plan. A Zoom phone license.
Scopes: phone:read:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

type

Enumeration, one of:

ASSIGNED
UNASSIGNED
ALL

Query response by number assignment. The value can be one of the following:

* assigned

The number has been assigned to either a user, a call queue, an auto-receptionist, or a common area phone in an account.

* unassigned

The number is not assigned to anyone.

* all

Include both assigned and unassigned numbers in the response.

* byoc

Include Bring Your Own Carrier (BYOC) numbers only in the response.

Extension type

Enumeration, one of:

USER
CALL_QUEUE
AUTO_RECEPTIONIST
COMMON_AREA_PHONE

The type of assignee to whom the number is assigned. The value can be one of the following: user callQueue autoReceptionist commonAreaPhone

Page size

Number

Number of records returned within a single API call.

30

Number type

Enumeration, one of:

TOLL
TOLLFREE

The type of phone number. The value can be either toll or tollfree.

Pending numbers

Boolean

Include or exclude pending numbers in the response. The value can be either true or false.

false

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 a specific phone site. See [Managing multiple sites](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites) or [Adding a site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15) for details.

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

List Archived Files

<zoom-connector-mule-4:list-archived-files>

Zoom’s archiving solution allows account administrators to set up an automated mechanism to record, collect and archive meeting data to a 3rd party platform of their choice and hence, satisfy FINRA and/ or other compliance requirements. Use this API to retrieve the archived meeting or webinar files of an account. This operation makes an HTTP GET request to the /archive_files endpoint.

Prerequisites: Enable cloud recording. Follow the enablement process to access the archiving feature.
Scope: recording: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

from

String

Start date for the query in "yyyy-MM-dd''T''HH:mm:ss''Z''" format. The duration for the query defined using the "from" and "to" parameters should not exceed 7 days as this API only provides a week’s data at once.

to

String

End date for the query in "yyyy-MM-dd''T''HH:mm:ss''Z''" format.

Query date type

Enumeration, one of:

MEETING_START_TIME
ARCHIVE_COMPLETE_TIME

The query date type for the from and to parameters.

MEETING_START_TIME

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

List Blocked List

<zoom-connector-mule-4:list-blocked-list>

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

Prerequisites: Pro or higher account plan with Zoom phone license.
Scope: phone:read:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Page size

Number

The total number of records returned from 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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

List Byocsip Trunk

<zoom-connector-mule-4:list-byocsiptrunk>

Use this API to return a list of an account’s assigned BYOC (Bring Your Own Carrier) SIP (Session Initiation Protocol) trunks. This operation makes an HTTP GET request to the /phone/sip_trunk/trunks endpoint.

Prerequisites: A Business or Enterprise account.
Scopes: phone:write:admin or phone:master
Rate Limit Label: Light

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

List Call Logs Metrics

<zoom-connector-mule-4:list-call-logs-metrics>

Call logs provide a record of all incoming and outgoing calls over Zoom Phone in an account. Use this API to list monthly call logs metrics. You can use query parameters to filter the response by date, site and MOS(Mean Opinion Score) of the call. This operation makes an HTTP GET request to the /phone/metrics/call_logs endpoint.

Prerequisites: Business, or Education account. Zoom Phone license.
Scopes: phone:read:admin, phone:write:admin
Rate Limit Label: Heavy

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

from

String

Start date for the report in yyyy-mm-dd format. Specify a 30 day range using the from and to parameters as the response provides a maximum of a month worth of data per API request.

to

String

End date for the report in yyyy-mm-dd format.

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.

Quality type

String

Filter call logs by voice quality. Zoom uses MOS of 3.5 as a general baseline to categorize calls by call quality. A MOS greater than or equal to 3.5 means good quality, while below 3.5 means poor quality. The value of this field can be one of the following:

* good

Retrieve call logs of the call(s) with good quality of voice.

* bad

Retrieve call logs of the call(s) with good quality of voice.

* all

Retrieve all call logs without filtering by voice quality.

Page size

Number

The number of records returned within a single 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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

List Call Queues

<zoom-connector-mule-4:list-call-queues>

Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service, etc. Use this API to list Call queues. This operation makes an HTTP GET request to the /phone/call_queues endpoint.

Prerequisites: Pro, Business, or Education account. Account owner or admin permissions. Zoom Phone license.
Scopes: phone:read:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Page size

Number

The number of records returned from 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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

List Calling Plans

<zoom-connector-mule-4:list-calling-plans>

Use this API to return all of an account’s Zoom Phone calling plans. This operation makes an HTTP GET request to the /phone/calling_plans endpoint.

Prerequisites: A Pro or a higher account. A Zoom Phone license.
Scopes: phone:read:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

List Channel Members

<zoom-connector-mule-4:list-channel-members>

Use this API to list all members of a channel. For user-level apps, pass the me value instead of the userId parameter. This operation makes an HTTP GET request to the /chat/users/{userId}/channels/{channelId}/members endpoint.

Scopes: chat_channel:read:admin
Rate Limit Label: Medium

Note: For an account-level OAuth app, this API can only be used on behalf of a user who is assigned with a role that has the View or Edit permission for Chat Channels.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Channel Id

String

Channel ID.

x

User Id

String

Unique identifier of the user who is the owner of this channel.

x

Page size

Number

The number of records returned with 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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

List Common Area Phones

<zoom-connector-mule-4:list-common-area-phones>

Use this API to list all of an account’s common area phones. A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don’t belong to a specific employees, you could add a common area phone so that any person can use it. This operation makes an HTTP GET request to the /phone/common_area_phones endpoint.

Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin permissions. A supported device.
Scopes: phone: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

The total number of records returned from 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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

List Digital Signage Content

<zoom-connector-mule-4:list-digital-signage-content>

List information about existing Zoom Rooms digital signage content in a Zoom account. You can also access this information by logging into your Zoom account in the Zoom web portal and visiting the Digital Signage Content page listed under Room Management. This operation makes an HTTP GET request to the /rooms/digital_signage endpoint.

Prerequisites: Pro or a higher account with Zoom Rooms. Existing content files or folder in Digital Signage Content page.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

type

String

Specify the type of digital signage resource. The value can be one of the following:

* content

Returns information about content files.

* folder

Returns information about the folder where the content files are located.

Folder ID

String

Unique identifier of the folder where the content is located. Provide this field if you would like to filter the response by contents that are only available in a specific folder.

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

List External Contacts

<zoom-connector-mule-4:list-external-contacts>

Use this API to list external contacts. This operation makes an HTTP GET request to the /phone/external_contacts endpoint.

Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin permissions.
Scopes: phone:read:admin
Rate Limit Label: Light

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

List Internal Callout Countries

<zoom-connector-mule-4:list-internal-callout-countries>

Retrieve the list of internal call-out countries of a master account or a sub account. To list call-out enabled countries of a sub account, provide the account ID of the sub account in the accountId path parameter. To list call-out enabled countries of a master account, provide me as the value of the accountId path parameter. This operation makes an HTTP GET request to the /accounts/{accountId}/sip_trunk/callout_countries endpoint.

Prerequisites: The account making this API request must be a master account 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 list Call-out enabled countries to a sub account, provide the account ID of the sub account in the accountId path parameter. To list Call-out enabled countries of a master account, provide me as the value of the accountId path parameter.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

List Internal Numbers

<zoom-connector-mule-4:list-internal-numbers>

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

Prerequisites: The account making this API request must be a master account 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 list the internal numbers of a sub account, provide the account ID of the sub account in the accountId path parameter. To list the internal numbers of a master account, provide me as the value of the accountId path parameter.

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

List Locations

<zoom-connector-mule-4:list-locations>

Use this API to list emergency service locations. This operation makes an HTTP GET request to the /phone/locations endpoint.

Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin permissions.
Scopes: phone:read:admin
Rate Limit Label: Light

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

List Meeting Satisfaction

<zoom-connector-mule-4:list-meeting-satisfaction>

If the End of Meeting Feedback Survey option is enabled, attendees will be prompted with a survey window where they can tap either the Thumbs Up or Thumbs Down button that indicates their Zoom meeting experience. With this API, you can get information on the attendees' meeting satisfaction. Specify a monthly date range for the query using the from and to query parameters. The month should fall within the last six months. To get information on the survey results with negative experiences (indicated by Thumbs Down), use the Get Zoom Meetings Client Feedback API. This operation makes an HTTP GET request to the /metrics/client/satisfaction endpoint.

Scopes: dashboard:read:admin
Rate Limit Label: Heavy

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

from

String

The start date for the query in the yyyy-mm-dd format.

to

String

The end date for the query in the yyyy-mm-dd format.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

List Meeting Templates

<zoom-connector-mule-4:list-meeting-templates>

Use this API to list meeting templates that are available to use by a user. For user-level apps, pass the me value instead of the userId parameter. This operation makes an HTTP GET request to the /users/{userId}/meeting_templates endpoint.

Scopes: meeting:read or meeting:read:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

Unique identifier of the user. Retrieve the value of this field by calling the List users API.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

List Past Meeting Files

<zoom-connector-mule-4:list-past-meeting-files>

Note that this API has been deprecated and is no longer supported due to GCM encryption updates for security purposes. To learn about saving the in-meeting chat files via Zoom Client, refer to the Saving in-meeting chat guide. List files sent via in-meeting chat during a meeting. The in-meeting files are deleted after 24 hours of the meeting completion time. This operation makes an HTTP GET request to the /past_meetings/{meetingId}/files endpoint.

Scope: meeting:read, meeting:read:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

Number

The meeting ID in long format. The data type of this field is long, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a long data type and not as an integer, as the meeting IDs can be longer than 10 digits.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

List Past Meeting Polls

<zoom-connector-mule-4:list-past-meeting-polls>

Polls allow the meeting host to survey attendees. Use this API to list poll results of a meeting. This operation makes an HTTP GET request to the /past_meetings/{meetingId}/polls endpoint.

Prerequisites: Host user type must be Pro. Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
Scopes: meeting:read:admin, meeting:read
Rate Limit Label: Medium

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

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

List Past Webinar Files

<zoom-connector-mule-4:list-past-webinar-files>

Note that this API has been deprecated and is no longer supported due to GCM encryption updates for security purposes. List files sent via in-meeting chat during a meeting. The in-meeting files are deleted after 24 hours of the meeting completion time. This operation makes an HTTP GET request to the /past_webinars/{webinarId}/files endpoint.

Scope: webinar:read, webinar:read:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Webinar Id

String

Webinar ID.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

List Past Webinar Poll Results

<zoom-connector-mule-4:list-past-webinar-poll-results>

The polling feature for a webinar enables you to create single choice or multiple choice polling questions for your webinars. Use this API to retrieve the results for Webinar Polls of a specific Webinar. This operation makes an HTTP GET request to the /past_webinars/{webinarId}/polls endpoint.

Prerequisites: Webinar license
Scopes: webinar:read:admin, webinar:read
Rate Limit Label: Medium

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

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

List Past Webinar Qa

<zoom-connector-mule-4:list-past-webinar-qa>

The Question & Answer (Q&A) feature for Webinars allows attendees to ask questions during the Webinar and for the panelists, co-hosts and host to answer their questions. Use this API to list Q&A of a specific Webinar. This operation makes an HTTP GET request to the /past_webinars/{webinarId}/qa endpoint.

Prerequisites: Webinar license
Scopes: webinar:read:admin, webinar:read
Rate Limit Label: Medium

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

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

List Phone Devices

<zoom-connector-mule-4:list-phone-devices>

List all the desk phone devices that are configured with Zoom Phone on an account. This operation makes an HTTP GET request to the /phone/devices endpoint.

Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin permissions.
Scopes: phone:read:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

type

Enumeration, one of:

ASSIGNED
UNASSIGNED

State of the device. The value should be either assigned to list devices that have been assigned to user(s) or unassigned to list devices that have not yet been assigned to any user in the Zoom account.

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

List Phone Sites

<zoom-connector-mule-4:list-phone-sites>

Sites enable you to organize Zoom Phone users in your organization. Use this API to list all the sites that have been created for an account. This operation makes an HTTP GET request to the /phone/sites endpoint.

Prerequisites: Multiple Sites must be enabled. Pro or a higher account with Zoom Phone enabled.
Scope: phone: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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

List Phone Users

<zoom-connector-mule-4:list-phone-users>

Use this API to return a list of all of an account’s users who are assigned a Zoom Phone license. This operation makes an HTTP GET request to the /phone/users endpoint.

Prerequisites: A Pro or higher account plan. A Zoom phone license.
Scopes: phone:read:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Page size

Number

The number of records returned from a single API call.

30

Site ID

String

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

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

List Setting Templates

<zoom-connector-mule-4:list-setting-templates>

Use this API to get a list of all the created phone template settings. This operation makes an HTTP GET request to the /phone/setting_templates endpoint.

Prerequisites: A Business or Enterprise account. A Zoom Phone license.
Scopes: phone:read:admin or phone:read
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Page size

Number

Number of records returns within a single API call.

30

Site ID

String

Unique identifier of the Site. This field is required only if multiple sites have been enabled. of the site. Required only when multiple sites are enabled. See [Managing multiple sites](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites) for details. If this is not provided, the response lists the account level setting templates.

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

List Shared Line Groups

<zoom-connector-mule-4:list-shared-line-groups>

A shared line group allows Zoom Phone admins to share a phone number and extension with a group of phone users or common area phones. This gives members of the shared line group access to the group’s direct phone number and voicemail. Use this API to list all the Shared Line Groups. This operation makes an HTTP GET request to the /phone/shared_line_groups endpoint.

Prerequisites: Pro or higher account with Zoom Phone license. Account owner or admin privileges.
Scopes: phone:read:admin, phone:write:admin
Rate Limit Label: 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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

List Sip Groups

<zoom-connector-mule-4:list-sip-groups>

Use this API to list SIP (Session Initiation Protocol) groups. This operation makes an HTTP GET request to the /phone/sip_groups endpoint.

Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin permissions.
Scopes: phone:read:admin
Rate Limit Label: Light

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

List Sip Phones

<zoom-connector-mule-4:list-sip-phones>

Zoom’s Phone System Integration (PSI), also referred as SIP phones, enables an organization to leverage the Zoom client to complete a softphone registration to supported premise based PBX system. End users will have the ability to have softphone functionality within a single client while maintaining a comparable interface to Zoom Phone. Use this API to list SIP phones on an account. This operation makes an HTTP GET request to the /sip_phones endpoint.

Prerequisites: Currently only supported on Cisco and Avaya PBX systems. User must enable SIP Phone Integration by contacting the Sales team.
Scope: sip_phone:read:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Search key

String

User name or email address of a user. If this parameter is provided, only the SIP phone system integration enabled for that specific user will be returned. Otherwise, all SIP phones on an account will be returned.

Page size

Number

Number of records returned within a single API call.

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

List Sip Trunk Numbers

<zoom-connector-mule-4:list-sip-trunk-numbers>

With SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed to make and deliver phone calls) over a direct and private connection between the customer’s network and the Zoom cloud. Meeting participants that dial into a meeting or have the meeting call them, and are On-Net from the perspective of the customers' IP telephony network, will be connected over this trunk rather than over the PSTN. Use this API to list all the numbers that are configured for SIP Connected Audio in a Zoom Account. This operation makes an HTTP GET request to the /sip_trunk/numbers endpoint.

Prerequisites: Pro or a higher account with SIP Connected Audio plan enabled. The account must be a master account.
Scopes: sip_trunk:master
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

List Sip Trunks

<zoom-connector-mule-4:list-siptrunks>

With SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed to make and deliver phone calls) over a direct and private connection between the customer’s network and the Zoom cloud. Meeting participants that dial into a meeting or have the meeting call them, and are On-Net from the perspective of the customer’s IP telephony network, will be connected over this trunk rather than over the PSTN. Use this API to list all the SIP trunks assigned to a master account or a sub account of the master account. To retrieve SIP trunks assigned to a sub account, provide the account ID of the sub account in the accountId path parameter. To retrieve SIP trunks of a master account, provide me as the value of the accountId path parameter. This operation makes an HTTP GET request to the /accounts/{accountId}/sip_trunk/trunks endpoint.

Prerequisites: The account must either be a master account or a sub account with API Partner Plan and SIP Connected Audio Plan.
Scope: sip_trunk:read:admin

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 SIP trunks assigned to a sub account, provide the account ID of the sub account in the as the value of this field. To retrieve SIP trunks of a master account, provide me as the value of this field.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

List Webinar Participants

<zoom-connector-mule-4:list-webinar-participants>

Use this API to list all the participants who attended a webinar hosted in the past. This operation makes an HTTP GET request to the /past_webinars/{webinarId}/participants endpoint.

Prerequisites: Pro or higher plan with a Webinar Add-on.
Scopes: webinar:read:admin webinar:read
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Webinar Id

String

Unique identifier of the webinar. You can retrieve the value of this field by calling the [list webinars](https://marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinars) API.

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

List Webinar Templates

<zoom-connector-mule-4:list-webinar-templates>

Use this API to list a user’s existing webinar templates' information. For user-level apps, pass the me value instead of the userId parameter. When you schedule a webinar, you can save the settings for that webinar as a template for scheduling future webinars. This operation makes an HTTP GET request to the /users/{userId}/webinar_templates endpoint.

Prerequisites: Pro or a higher account with Webinar plan enabled.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

User ID.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

List Zoom Rooms

<zoom-connector-mule-4:list-zoom-rooms>

Zoom Rooms is a software-based room system that provides an integrated experience for audio conferencing, wireless screen sharing and video conferencing. Use this API to list all the existing Zoom Rooms in a Zoom account. This operation makes an HTTP GET request to the /rooms endpoint.

Prerequisites: Pro or a higher plan with Zoom Room license.
Scopes: room:read:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

status

Enumeration, one of:

OFFLINE
AVAILABLE
IN_MEETING
UNDER_CONSTRUCTION

The status of the Zoom Room.

type

Enumeration, one of:

ZOOM_ROOM
SCHEDULING_DISPLAY_ONLY
DIGITAL_SIGNAGE_ONLY

Type of the Zoom Rooms.

Unassigned rooms

Boolean

Use this query parameter with a value of true if you would like to see Zoom Rooms in your account that have not been assigned to anyone yet.

false

Page size

Number

Number of records returned within a single API call.

30

Location ID

String

Parent location ID of the Zoom Room.

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

List Zr Devices

<zoom-connector-mule-4:list-zrdevices>

List information about the devices that are being used for a specific Zoom Room in an account. This operation makes an HTTP GET request to the /rooms/{roomId}/devices endpoint.

Prerequisites: Pro or a higher plan with Zoom Room license. Account owner or admin permissions.
Scopes: room:read:admin
Rate Limit Label: Medium

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. This can be retrieved from the response of List Zoom Rooms API.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

List Zr Locations

<zoom-connector-mule-4:list-zrlocations>

A Zoom account owner or a Zoom Room administrator can establish a location hierarchy to help manage Zoom Rooms that are spread among a variety of locations. Use this API to list the different location types used for Zoom Rooms in an account. This operation makes an HTTP GET request to the /rooms/locations endpoint.

Prerequisites: Account owner or admin permissions. Zoom Rooms Version 4.0 or higher.
Scopes: room:read:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Parent location ID

String

A Unique identifier of the parent location. For instance, if a Zoom Room is located in Floor 1 of Building A, the location of Building A will be the parent location of Floor 1. Use this parameter to filter the response by a specific location hierarchy level.

type

String

Use this field to filter the response by the type of location. The value can be one of the following: country, states, city, campus, building, floor.

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Listimmessages

<zoom-connector-mule-4:listimmessages>

Get IM Chat messages for a specified period of time. This API only supports Oauth2. This operation makes an HTTP GET request to the /im/users/{userId}/chat/messages endpoint.

Scopes: imchat:read
Rate Limit Label: Medium

Deprecated: By the end of 2021, Zoom will deprecate this API in favor of a consolidated set of APIs. The API will still be available for you to use, though Zoom will no longer provide support for it. For further information, refer to Announcements: IM APIs Deprecation.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address.

x

Chat user

String

Chat user’s ID or email address.

channel

String

IM Channel’s ID.

date

String

IM message''s query date time, format as yyyy-MM-dd.

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Manage E911signage

<zoom-connector-mule-4:manage-e911signage>

Display or hide E911 emergency alert text content from Zoom Rooms digital signage. This operation makes an HTTP PATCH request to the /rooms/events endpoint.

Prerequisites: Zoom Rooms 5.3.0 or higher. Zoom Rooms digital signage must be enabled.
Scope: room:write:admin

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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Mark Message

<zoom-connector-mule-4:mark-message>

Mark a message as read or unread. For user-level apps, pass the me value instead of the userId parameter. Note that for an account-level OAuth app, this API can only be used on behalf of a user who is assigned with a role that has the Edit permission for Chat Messages. This operation makes an HTTP PATCH request to the /chat/users/{userId}/messages/{messageId}/status endpoint.

Rate Limit Label: Medium

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

Message Id

String

Unique identifier of the message.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Meeting

<zoom-connector-mule-4:meeting>

Retrieve the details of a meeting. This operation makes an HTTP GET request to the /meetings/{meetingId} endpoint.

Scopes: meeting:read:admin meeting:read
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

Number

The meeting ID in long format. The data type of this field is long, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a long data type and not as an integer, as the meeting IDs can be longer than 10 digits.

x

Occurrence ID

String

Meeting Occurrence ID. Provide this field to view meeting details of a particular occurrence of the recurring meeting.

Show previous occurrences

Boolean

Set the value of this field to true if you would like to view meeting details of all previous occurrences of a recurring meeting.

false

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Meeting Create

<zoom-connector-mule-4:meeting-create>

Create a meeting for a user. For user-level apps, pass the me value instead of the userId parameter. This API has a daily rate limit of 100 requests per day. Therefore, only 100 Create a Meeting API requests are permitted within a 24 hour window for a user. The start_url of a meeting is a URL using which a host or an alternative host can start a meeting. The expiration time for the start_url field is two hours for all regular users. For custCreate meeting hosts ( i.e., users created using the custCreate option via the Create Users API, the expiration time of the start_url field is 90 days from the generation of the start_url. For security reasons, the recommended way to retrieve the updated value for the start_url field programmatically (after expiry) is by calling the Retrieve a Meeting API and referring to the value of the start_url field in the response. This operation makes an HTTP POST request to the /users/{userId}/meetings endpoint.

Scopes: meeting:write:admin meeting:write
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Meeting Delete

<zoom-connector-mule-4:meeting-delete>

Delete a meeting. This operation makes an HTTP DELETE request to the /meetings/{meetingId} endpoint.

Scopes: meeting:write:admin meeting:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

Number

The meeting ID in long format. The data type of this field is long, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a long data type and not as an integer, as the meeting IDs can be longer than 10 digits.

x

Occurrence ID

String

The meeting occurrence ID.

Schedule for reminder

Boolean

* true

Notify host and alternative host about the meeting cancellation via email.

* false

Do not send any email notification.

false

Cancel meeting reminder

String

* true

Notify registrants about the meeting cancellation via email.

* false

Do not send any email notification to meeting registrants.

false

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Meeting Invitation

<zoom-connector-mule-4:meeting-invitation>

Retrieve the meeting invite note that was sent for a specific meeting. This operation makes an HTTP GET request to the /meetings/{meetingId}/invitation endpoint.

Scopes: meeting:read:admin meeting:read
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

Number

The meeting ID in long format. The data type of this field is long, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a long data type and not as an integer, as the meeting IDs can be longer than 10 digits.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Meeting Invite Links Create

<zoom-connector-mule-4:meeting-invite-links-create>

Use this API to create a batch of invitation links for a meeting. This operation makes an HTTP POST request to the /meetings/{meetingId}/invite_links endpoint.

Scopes: meeting:write:admin, meeting:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

Number

The meeting ID in long format. The data type of this field is long, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a long data type and not as an integer, as the meeting IDs can be longer than 10 digits.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Meeting Live Stream Status Update

<zoom-connector-mule-4:meeting-live-stream-status-update>

Zoom allows users to live stream a meeting to a custom platform. Use this API to update the status of a meeting’s live stream. This operation makes an HTTP PATCH request to the /meetings/{meetingId}/livestream/status endpoint.

Prerequisites: Meeting host must have a Pro license.
Scopes: meeting:write:admin meeting:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

Number

The meeting ID in long format. The data type of this field is long, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a long data type and not as an integer, as the meeting IDs can be longer than 10 digits.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Meeting Live Stream Update

<zoom-connector-mule-4:meeting-live-stream-update>

Use this API to update a meeting’s live stream information. Zoom allows users to live stream a meeting to a custom platform. This operation makes an HTTP PATCH request to the /meetings/{meetingId}/livestream endpoint.

Prerequisites: Meeting host must have a Pro license.
Scopes: meeting:write:admin, meeting:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

Number

The meeting ID in long format. The data type of this field is long, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a long data type and not as an integer, as the meeting IDs can be longer than 10 digits.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Meeting Poll Create

<zoom-connector-mule-4:meeting-poll-create>

Polls allow the meeting host to survey attendees. Use this API to create a poll for a meeting. This operation makes an HTTP POST request to the /meetings/{meetingId}/polls endpoint.

Prerequisites: Host user type must be a Pro or higher plan. Polling feature must be enabled in the host’s account. Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
Scopes: meeting:write:admin meeting:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

Number

The meeting ID in long format. The data type of this field is long, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a long data type and not as an integer, as the meeting IDs can be longer than 10 digits.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Meeting Poll Delete

<zoom-connector-mule-4:meeting-poll-delete>

Polls allow the meeting host to survey attendees. Use this API to delete a meeting poll. This operation makes an HTTP DELETE request to the /meetings/{meetingId}/polls/{pollId} endpoint.

Prerequisites: Host user type must be Pro. Polling feature should be enabled in the host’s account. Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
Scopes: meeting:write:admin meeting:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

Number

The meeting ID in long format. The data type of this field is long, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a long data type and not as an integer, as the meeting IDs can be longer than 10 digits.

x

Poll Id

String

The poll 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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Meeting Poll Get

<zoom-connector-mule-4:meeting-poll-get>

Polls allow the meeting host to survey attendees. Use this API to get information about a specific meeting poll. This operation makes an HTTP GET request to the /meetings/{meetingId}/polls/{pollId} endpoint.

Scopes: meeting:read:admin meeting:read
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

Number

The meeting ID in long format. The data type of this field is long, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a long data type and not as an integer, as the meeting IDs can be longer than 10 digits.

x

Poll Id

String

The poll ID.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Meeting Poll Update

<zoom-connector-mule-4:meeting-poll-update>

Polls allow the meeting host to survey attendees. Use this API to update the information of a specific meeting poll. This operation makes an HTTP PUT request to the /meetings/{meetingId}/polls/{pollId} endpoint.

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

Number

The meeting ID in long format. The data type of this field is long, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a long data type and not as an integer, as the meeting IDs can be longer than 10 digits.

x

Poll Id

String

The poll 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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Meeting Polls

<zoom-connector-mule-4:meeting-polls>

Polls allow the meeting host to survey attendees. Use this API to list the polls of a meeting. This operation makes an HTTP GET request to the /meetings/{meetingId}/polls endpoint.

Prerequisites: Host user type must be a Pro or higher plan. Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
Scopes: meeting:read:admin meeting:read
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

Number

The meeting ID in long format. The data type of this field is long, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a long data type and not as an integer, as the meeting IDs can be longer than 10 digits.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Meeting Quality Score

<zoom-connector-mule-4:meeting-quality-score>

Get the quality scores of a meeting. This operation makes an HTTP GET request to the /metrics/quality endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Meeting Recording Registrant Create

<zoom-connector-mule-4:meeting-recording-registrant-create>

Cloud Recordings of past Zoom Meetings can be made on-demand. Users should be registered to view these recordings. Use this API to register a user to gain access to the On-demand Cloud Recordings of a past meeting. This operation makes an HTTP POST request to the /meetings/{meetingId}/recordings/registrants endpoint.

Scopes: recording:write:admin, recording:write.
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

Number

The meeting ID in long format. The data type of this field is long, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a long data type and not as an integer, as the meeting IDs can be longer than 10 digits.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Meeting Recording Registrant Status

<zoom-connector-mule-4:meeting-recording-registrant-status>

A registrant can either be approved or denied from viewing the on-demand recording. Use this API to update a registrant’s status. This operation makes an HTTP PUT request to the /meetings/{meetingId}/recordings/registrants/status endpoint.

Scopes: recording:write:admin, recording:write
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

Number

The meeting ID in long format. The data type of this field is long, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a long data type and not as an integer, as the meeting IDs can be longer than 10 digits.

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Meeting Recording Registrants

<zoom-connector-mule-4:meeting-recording-registrants>

Cloud Recordings of past Zoom Meetings can be made on-demand. Users should be registered to view these recordings. Use this API to list the registrants of On-demand Cloud Recordings of a past meeting. This operation makes an HTTP GET request to the /meetings/{meetingId}/recordings/registrants endpoint.

Scopes: recording:read:admin, recording:read.
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

Number

The meeting ID in long format. The data type of this field is long, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a long data type and not as an integer, as the meeting IDs can be longer than 10 digits.

x

status

Enumeration, one of:

PENDING
APPROVED
DENIED

The registrant status: pending - Registrant''s status is pending. approved - Registrant''s status is approved. denied - Registrant''s status is denied.

APPROVED

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Meeting Registrant Create

<zoom-connector-mule-4:meeting-registrant-create>

Register a participant for a meeting. Note that there is a maximum limit of 4999 registrants per meeting and users will see an error if the capacity is reached. This operation makes an HTTP POST request to the /meetings/{meetingId}/registrants endpoint.

Prerequisites: Host user type must be "Licensed".
Scopes: meeting:write:admin meeting:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

Number

The meeting ID in long format. The data type of this field is long, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a long data type and not as an integer, as the meeting IDs can be longer than 10 digits.

x

Occurrence ids

String

Occurrence IDs. You can find these with the meeting get API. Multiple values separated by comma.

Body

String

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Meeting Registrant Question Update

<zoom-connector-mule-4:meeting-registrant-question-update>

Update registration questions that will be displayed to users while registering for a meeting. This operation makes an HTTP PATCH request to the /meetings/{meetingId}/registrants/questions endpoint.

Scopes: meeting:write, meeting:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

Number

The meeting ID in long format. The data type of this field is long, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a long data type and not as an integer, as the meeting IDs can be longer than 10 digits.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Meeting Registrant Status

<zoom-connector-mule-4:meeting-registrant-status>

Update a meeting registrant’s status by either approving, cancelling, or denying a registrant from joining the meeting. This operation makes an HTTP PUT request to the /meetings/{meetingId}/registrants/status endpoint.

Scopes: meeting:write:admin meeting:write
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

Number

The meeting ID in long format. The data type of this field is long, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a long data type and not as an integer, as the meeting IDs can be longer than 10 digits.

x

Occurrence ID

String

The meeting occurrence ID.

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Meeting Registrants

<zoom-connector-mule-4:meeting-registrants>

A host or a user with admin permission can require registration for a Zoom meeting. Use this API to list users that have registered for a meeting. This operation makes an HTTP GET request to the /meetings/{meetingId}/registrants endpoint.

Scopes: meeting:read:admin meeting:read
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

Number

The meeting ID in long format. The data type of this field is long, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a long data type and not as an integer, as the meeting IDs can be longer than 10 digits.

x

Occurrence ID

String

The meeting occurrence ID.

status

Enumeration, one of:

PENDING
APPROVED
DENIED

The registrant status:

* pending

Registrant’s status is pending.

* approved

Registrant’s status is approved.

* denied

Registrant’s status is denied.

APPROVED

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Meeting Registrants Questions Get

<zoom-connector-mule-4:meeting-registrants-questions-get>

List registration questions that will be displayed to users while registering for a meeting. This operation makes an HTTP GET request to the /meetings/{meetingId}/registrants/questions endpoint.

Scopes: meeting:read, meeting:read:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

Number

The meeting ID in long format. The data type of this field is long, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a long data type and not as an integer, as the meeting IDs can be longer than 10 digits.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Meeting Status

<zoom-connector-mule-4:meeting-status>

Update the status of a meeting. This operation makes an HTTP PUT request to the /meetings/{meetingId}/status endpoint.

Scopes: meeting:write:admin meeting:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

Number

The meeting ID in long format. The data type of this field is long, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a long data type and not as an integer, as the meeting IDs can be longer than 10 digits.

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Meeting Update

<zoom-connector-mule-4:meeting-update>

Update the details of a meeting. This API has a rate limit of 100 requests per day. Because of this, a meeting can only be updated for a maximum of 100 times within a 24 hour period. This operation makes an HTTP PATCH request to the /meetings/{meetingId} endpoint.

Scopes: meeting:write:admin, meeting:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

Number

The meeting ID in long format. The data type of this field is long, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a long data type and not as an integer, as the meeting IDs can be longer than 10 digits.

x

Occurrence ID

String

Meeting occurrence id. Support change of agenda, start_time, duration, settings: {host_video, participant_video, join_before_host, mute_upon_entry, waiting_room, watermark, auto_recording}

Body

String

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Meetingregistrantdelete

<zoom-connector-mule-4:meetingregistrantdelete>

Delete a meeting registrant. This operation makes an HTTP DELETE request to the /meetings/{meetingId}/registrants/{registrantId} endpoint.

Scopes: meeting:write:admin meeting:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

Number

The meeting ID.

x

Registrant Id

String

The meeting registrant ID.

x

Occurrence ID

String

The meeting occurence ID.

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Meetings

<zoom-connector-mule-4:meetings>

List all the meetings that were scheduled for a user (meeting host). For user-level apps, pass the me value instead of the userId parameter. This API only supports scheduled meetings. This API does not return information about instant meetings. This operation makes an HTTP GET request to the /users/{userId}/meetings endpoint.

Scopes: meeting:read:admin, meeting:read
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

x

type

Enumeration, one of:

SCHEDULED
LIVE
UPCOMING

The meeting types: scheduled - This includes all valid past meetings (unexpired), live meetings and upcoming scheduled meetings. It is equivalent to the combined list of "Previous Meetings" and "Upcoming Meetings" displayed in the user’s [Meetings page](https://zoom.us/meeting) on the Zoom Web Portal. live - All the ongoing meetings. upcoming - All upcoming meetings including 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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Participant Feedback

<zoom-connector-mule-4:participant-feedback>

When a meeting ends, each attendee will be prompted to share their meeting experience by clicking either thumbs up or thumbs down. Use this API to retrieve the feedback submitted for a specific meeting. Note that this API only works for meetings scheduled after December 20, 2020. This operation makes an HTTP GET request to the /metrics/meetings/{meetingId}/participants/satisfaction endpoint.

Prerequisites: Feedback to Zoom setting must be enabled by the participant prior to the meeting. The user making the API request must be enrolled in a Business or a higher plan.
Scope: dashboard_meetings:read:admiin
Rate Limit Label: 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

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

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Participant Webinar Feedback

<zoom-connector-mule-4:participant-webinar-feedback>

When a Webinar ends, each attendee will be prompted to share their Webinar experience by clicking either thumbs up or thumbs down. Use this API to retrieve the feedback submitted for a specific webinar. Note that this API only works for meetings scheduled after December 20, 2020. This operation makes an HTTP GET request to the /metrics/webinars/{webinarId}/participants/satisfaction endpoint.

Prerequisites: Feedback to Zoom setting must be enabled by the participant prior to the meeting. The user making the API request must be enrolled in a Business or a higher plan.
Scope: dashboard_webinars:read:admin
Rate Limit Label: 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
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

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Past Meeting Details

<zoom-connector-mule-4:past-meeting-details>

Get details on a past meeting. This operation makes an HTTP GET request to the /past_meetings/{meetingUUID} endpoint.

Scopes: meeting:read:admin meeting:read
Rate Limit Label: Light

Note: Please double encode your UUID when using this API if the UUID begins with a '/'or contains '//' in it.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting UUID

String

The meeting’s universally unique identifier (UUID). Each meeting instance generates a UUID. For example, after a meeting ends, a new UUID is generated for the next meeting instance. If the meeting UUID begins with a / character or contains a // character, you must double-encode the meeting UUID when using the meeting UUID for other API calls.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Past Meeting Participants

<zoom-connector-mule-4:past-meeting-participants>

Retrieve information on participants from a past meeting. This operation makes an HTTP GET request to the /past_meetings/{meetingUUID}/participants endpoint.

Prerequisites: Paid account on a Pro or higher plan.
Scopes: meeting:read:admin meeting:read
Rate Limit Label: Medium

Note: Please double encode your UUID when using this API if the UUID begins with a '/'or contains '//' in it.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting UUID

String

The meeting’s universally unique identifier (UUID). Each meeting instance generates a UUID. For example, after a meeting ends, a new UUID is generated for the next meeting instance. If the meeting UUID begins with a / character or contains a // character, you must double-encode the meeting UUID when using the meeting UUID for other API calls.

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Past Meetings

<zoom-connector-mule-4:past-meetings>

Get a list of ended meeting instances. This operation makes an HTTP GET request to the /past_meetings/{meetingId}/instances endpoint.

Scopes: meeting:read:admin meeting:read
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

Number

The meeting ID in long format. The data type of this field is long, which is represented as int64 in JSON. While storing the meeting ID in your database, store it as a long data type and not as an integer, as the meeting IDs can be longer than 10 digits.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Past Webinars

<zoom-connector-mule-4:past-webinars>

List past webinar instances. This operation makes an HTTP GET request to the /past_webinars/{webinarId}/instances endpoint.

Scopes: webinar:read:admin webinar:read
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Webinar Id

Number

The webinar ID in the long format, which is represented as the int64 data type in JSON.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Phone Setting

<zoom-connector-mule-4:phone-setting>

Use this API to return an account’s settings. This operation makes an HTTP GET request to the /phone/settings endpoint.

Prerequisites: A Business or Enterprise account. A Zoom Phone license.
Scopes: phone:read, phone:read:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Account Id

String

Account ID.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Phone User

<zoom-connector-mule-4:phone-user>

Use this API to return a user’s Zoom phone profile. For user-level apps, pass the me value instead of the userId parameter. This operation makes an HTTP GET request to the /phone/users/{userId} endpoint.

Prerequisites: A Business or Enterprise account. A Zoom Phone license.
Scopes: phone:read, phone:read:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Phone User Call Logs

<zoom-connector-mule-4:phone-user-call-logs>

Use this API to get a user’s Zoom phone call logs. For user-level apps, pass the me value instead of the userId parameter. This operation makes an HTTP GET request to the /phone/users/{userId}/call_logs endpoint.

Prerequisites: A Business or Enterprise account. A Zoom Phone license.
Scopes: phone:read, phone:read:admin, phone_call_log:read, phone_call_log:read:admin
Rate Limit Label: Heavy

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

x

Page size

Number

Number of records returned within a single API call.

30

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

type

Enumeration, one of:

ALL
MISSED

type

Phone number

String

Filter API responses to include call logs of only the phone number defined in this field.

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

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Phone User Recordings

<zoom-connector-mule-4:phone-user-recordings>

Use this API to get a user’s Zoom Phone recordings. For user-level apps, pass the me value instead of the userId parameter. This operation makes an HTTP GET request to the /phone/users/{userId}/recordings endpoint.

Prerequisites: A Business or Enterprise account. A Zoom Phone license.
Scopes: phone:read, phone:read:admin, phone_recording:read, phone_recording:read:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

x

Page size

Number

Number of records returned within a single API call.

30

from

String

Start date for the query in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the response includes only one month worth of recording data. The month defined should fall within the last six months.

to

String

End date.

x

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Phone User Settings

<zoom-connector-mule-4:phone-user-settings>

Use this API to get a user’s Zoom Phone profile settings. For user-level apps, pass the me value instead of the userId parameter. This operation makes an HTTP GET request to the /phone/users/{userId}/settings endpoint.

Prerequisites: A Business or Enterprise account. A Zoom Phone license.
Scopes: phone:read, phone:read:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Phone User Voice Mails

<zoom-connector-mule-4:phone-user-voice-mails>

Use this API to get a user’s Zoom Phone voicemails. For user-level apps, pass the me value instead of the userId parameter. This operation makes an HTTP GET request to the /phone/users/{userId}/voice_mails endpoint.

Prerequisites: A Business or Enterprise account. A Zoom Phone license.
Scopes: phone:read, phone:read:admin, phone_voicemail:read, phone_voicemail:read:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

x

Page size

Number

Number of records returned within a single API call.

30

status

Enumeration, one of:

ALL
READ
UNREAD

Status of the voice mail

ALL

from

String

Start date for the query in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the response includes only one month worth of voicemail data. The month defined should fall within the last six months.

to

String

End date.

x

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Post Phone Sip Trunk

<zoom-connector-mule-4:post-phone-siptrunk>

A master account owner can use this API to assign SIP (Session Initiation Protocol) trunks to a subaccount. This operation makes an HTTP POST request to the /accounts/{accountId}/phone/sip_trunk/trunks endpoint.

Prerequisites: A Business or Enterprise account.
Scopes: phone:master
Rate Limit Label: 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.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

React Message

<zoom-connector-mule-4:react-message>

Use this API to react (add or remove) to a chat message with an emoji. For an account-level OAuth app, this API can only be used on behalf of a user who is assigned with a role that has the Edit permission for Chat Messages. This operation makes an HTTP PATCH request to the /chat/users/{userId}/messages/{messageId}/emoji_reactions endpoint.

Scopes: chat_message:write, chat_message:write:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user’s unique ID.

x

Message Id

String

The message''s unique ID.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Recording Delete

<zoom-connector-mule-4:recording-delete>

Delete all recording files of a meeting. This operation makes an HTTP DELETE request to the /meetings/{meetingId}/recordings endpoint.

Prerequisites: Cloud Recording should be enabled on the user’s account.
Scopes: recording:write:admin recording:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

String

To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID, the response will be for the latest meeting instance. To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request.

x

action

Enumeration, one of:

TRASH
DELETE

The recording delete actions:

* trash

Move recording to trash.

* delete

Delete recording permanently.

TRASH

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Recording Delete One

<zoom-connector-mule-4:recording-delete-one>

Delete a specific recording file from a meeting. Note that to use this API, you must enable the "The host can delete cloud recordings" setting. You can find this setting in the Recording tab of the Settings interface in the Zoom web portal. This operation makes an HTTP DELETE request to the /meetings/{meetingId}/recordings/{recordingId} endpoint.

Scopes: recording:write:admin, recording:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

String

To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID, the response will be for the latest meeting instance. To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request.

x

Recording Id

String

The recording ID.

x

action

Enumeration, one of:

TRASH
DELETE

The recording delete actions:

* trash

Move recording to trash.

* delete

Delete recording permanently.

TRASH

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Recording Get

<zoom-connector-mule-4:recording-get>

Get all the recordings from a meeting or Webinar instance. The recording files can be downloaded via the download_url property listed in the response. To access a password-protected cloud recording, add an access_token parameter to the download URL and provide OAuth access token or JWT as the access_token value. This operation makes an HTTP GET request to the /meetings/{meetingId}/recordings endpoint.

Scopes: recording:read:admin, recording:read
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

String

To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID, the response will be for the latest meeting instance. To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request.

x

Include fields

String

Get the download_access_token field for downloading meeting recordings.

ttl

Number

Time to live (TTL) of the download_access_token. This is only valid if the include_fields query parameter contains download_access_token. The range is between 0-604800.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Recording Registrant Question Update

<zoom-connector-mule-4:recording-registrant-question-update>

For on-demand meeting recordings, you can include fields with questions that will be shown to registrants when they register to view the recording. Use this API to update registration questions that are to be answered by users while registering to view a recording. This operation makes an HTTP PATCH request to the /meetings/{meetingId}/recordings/registrants/questions endpoint.

Scopes: recording:write:admin, recording:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

String

To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID, the response will be for the latest meeting instance. To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Recording Registrants Questions Get

<zoom-connector-mule-4:recording-registrants-questions-get>

For on-demand meeting recordings, you can include fields with questions that will be shown to registrants when they register to view the recording. Use this API to retrieve a list of questions that are displayed for users to complete when registering to view the recording of a specific meeting. This operation makes an HTTP GET request to the /meetings/{meetingId}/recordings/registrants/questions endpoint.

Scopes: recording:read:admin, recording:read
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

String

To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID, the response will be for the latest meeting instance. To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Recording Setting Update

<zoom-connector-mule-4:recording-setting-update>

Retrieve settings applied to a meeting’s Cloud Recording. This operation makes an HTTP GET request to the /meetings/{meetingId}/recordings/settings endpoint.

Scopes: recording:read:admin recording:read
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

String

To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID, the response will be for the latest meeting instance. To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Recording Settings Update

<zoom-connector-mule-4:recording-settings-update>

Update settings applied to a meeting’s Cloud Recording. This operation makes an HTTP PATCH request to the /meetings/{meetingId}/recordings/settings endpoint.

Scopes: recording:write:admin recording:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

String

To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID, the response will be for the latest meeting instance. To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Recording Status Update

<zoom-connector-mule-4:recording-status-update>

Zoom allows users to recover recordings from trash for up to 30 days from the deletion date. Use this API to recover all deleted cloud recordings of a specific meeting. This operation makes an HTTP PUT request to the /meetings/{meetingId}/recordings/status endpoint.

Prerequisites: A Pro user with Cloud Recording enabled.
Scopes: recording:write:admin recording:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

String

To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID, the response will be for the latest meeting instance. To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request.

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Recording Status Update One

<zoom-connector-mule-4:recording-status-update-one>

Zoom allows users to recover recordings from trash for up to 30 days from the deletion date. Use this API to recover a single recording file from the meeting. This operation makes an HTTP PUT request to the /meetings/{meetingId}/recordings/{recordingId}/status endpoint.

Scopes: recording:write:admin recording:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting Id

String

To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID, the response will be for the latest meeting instance. To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request.

x

Recording Id

String

The recording 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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Recordings List

<zoom-connector-mule-4:recordings-list>

Use this API to list all cloud recordings of a user. For user-level apps, pass the me value instead of the userId parameter. Note that to access a user’s password protected cloud recording, add an access_token parameter to the download URL and provide either the JWT or the user’s OAuth access token as the value of the access_token parameter. When a user records a meeting or a webinar by choosing the Record to the Cloud option, the video, audio, and chat text are recorded in the Zoom cloud. This operation makes an HTTP GET request to the /users/{userId}/recordings endpoint.

Prerequisites: Pro or a higher plan. Cloud Recording must be enabled on the user’s account.
Scopes: recording:read:admin, recording:read
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

x

Page size

Number

Number of records returned within a single API call.

30

mc

String

Query Metadata of Recording if an On-Premise Meeting Connector was used for the meeting.

false

trash

Boolean

Query trash.

* true

List recordings from trash.

* false

Do not list recordings from the trash. The default value is false. If you set it to true, you can use the trash_type property to indicate the type of Cloud recording that you need to retrieve.

false

from

String

The start date in 'yyyy-mm-dd' UTC format for the date range for which you would like to retrieve recordings. The maximum range can be a month. If no value is provided for this field, the default will be current date. For example, if you make the API request on June 30, 2020, without providing the from and to parameters, by default the value of 'from' field will be 2020-06-30 and the value of the 'to' field will be 2020-07-01. Note: The "trash" files cannot be filtered by date range and thus, the "from" and "to" fields should not be used for trash files.

to

String

End date in 'yyyy-mm-dd' 'yyyy-mm-dd' UTC format.

Trash type

String

The type of Cloud recording that you would like to retrieve from the trash. The value can be one of the following:

* meeting_recordings

List all meeting recordings from the trash.

* recording_file

List all individual recording files from the trash.

meeting_recordings

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Remove A Channel Member

<zoom-connector-mule-4:remove-achannel-member>

A channel can have one or multiple members. Use this API to remove a member from a chat channel. For user-level apps, pass the me value instead of the userId parameter. This operation makes an HTTP DELETE request to the /chat/users/{userId}/channels/{channelId}/members/{memberId} endpoint.

Scopes: chat_channel:write:admin
Rate Limit Label: Medium

Note: For an account-level OAuth app, this API can only be used on behalf of a user who is assigned with a role that has Edit permission for Chat Channels.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Channel Id

String

Unique identifier of the Channel from where you would like to remove a member. This can be retrieved from the List Channels API.

x

Member Id

String

Email address of the member whom you would like to be remove from the channel.

x

User Id

String

Unique identifier of the channel owner.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Remove A User Level Channel Member

<zoom-connector-mule-4:remove-auser-level-channel-member>

A channel can have one or multiple members. Use this API to remove a member from a chat channel. This operation makes an HTTP DELETE request to the /chat/channels/{channelId}/members/{memberId} endpoint.

Scopes: chat_channel:write
Rate Limit Label: Medium

Note that this API only supports user-managed OAuth app.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Channel Id

String

Unique identifier of the Channel from where you would like to remove a member. This can be retrieved from the List Channels API.

x

Member Id

String

Email address of the member whom you would like to be remove from the channel.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Report Cloud Recording

<zoom-connector-mule-4:report-cloud-recording>

Retrieve cloud recording usage report for a specified period. You can only get cloud recording reports that are one day ealier than the current date and for the most recent period of 6 months. The date gap between from and to dates should be smaller or equal to 30 days. This operation makes an HTTP GET request to the /report/cloud_recording endpoint.

Prerequisites: Pro or higher plan.
Scopes: report:read:admin
Rate Limit Label: 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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Report Daily

<zoom-connector-mule-4:report-daily>

Retrieve daily report to access the account-wide usage of Zoom services for each day in a given month. It lists the number of new users, meetings, participants, and meeting minutes. This operation makes an HTTP GET request to the /report/daily endpoint.

Prerequisites: Pro or higher plan.
Scopes: report:read:admin
Rate Limit Label: Heavy

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

year

Number

Year for this report.

month

Number

Month for this report.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Report Meeting Details

<zoom-connector-mule-4:report-meeting-details>

Get a detailed report for a past meeting. This operation makes an HTTP GET request to the /report/meetings/{meetingId} endpoint.

Prerequisites: Pro or a higher plan.
Scopes: report:read:admin
Rate Limit Label: 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

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Report Meeting Participants

<zoom-connector-mule-4:report-meeting-participants>

Use this API to return a report of a past meeting with two or more participants, including the host. To return a report for past meeting with only one participant, use the List meeting participants API. This operation makes an HTTP GET request to the /report/meetings/{meetingId}/participants endpoint.

Prerequisites: Pro or a higher plan.
Scopes: report:read:admin
Rate Limit Label: 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

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.

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Report Meeting Polls

<zoom-connector-mule-4:report-meeting-polls>

Retrieve a report of poll results for a past meeting. This operation makes an HTTP GET request to the /report/meetings/{meetingId}/polls endpoint.

Prerequisites: Pro or a higher plan.
Scopes: report:read:admin
Rate Limit Label: 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

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Report Meetings

<zoom-connector-mule-4:report-meetings>

Retrieve a report on past meetings and webinars for a specified time period. The time range for the report is limited to a month and the month must fall within the past six months. Meetings and webinars are returned only if they have two or more unique participants. This operation makes an HTTP GET request to the /report/users/{userId}/meetings endpoint.

Prerequisites: Pro or higher plan.
Scopes: report:read:admin
Rate Limit Label: Heavy

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

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

type

Enumeration, one of:

PAST
PAST_ONE

The meeting types:

* past

Past meetings.

* pastOne

Past one user meetings.

PAST

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Report Operation Logs

<zoom-connector-mule-4:report-operation-logs>

The Operations Logs report allows you to audit admin and user activity, such as adding a new user, changing account settings, and deleting recordings. Use this API to retrieve operation logs report for a specified period of time. This operation makes an HTTP GET request to the /report/operationlogs endpoint.

Prerequisites: Pro or higher plan.
Scopes: report:read:admin
Rate Limit Label: 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

Page size

Number

Number of records returned within a single API call.

30

Category type

Enumeration, one of:

ALL
USER
USER_SETTINGS
ACCOUNT
BILLING
IM
RECORDING
PHONE_CONTACTS
WEBINAR
SUB_ACCOUNT
ROLE
ZOOM_ROOMS

Filter your response by a category type to see reports for a specific category. The value for this field can be one of the following: all, user, user_settings, account, billing, im, recording, phone_contacts, webinar, sub_account, role, or zoom_rooms.

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Report Sign In Sign Out Activities

<zoom-connector-mule-4:report-sign-in-sign-out-activities>

Retrieve a list of sign in and sign out activity logs report of users under a Zoom account. This operation makes an HTTP GET request to the /report/activities endpoint.

Prerequisites: Pro or higher plan.
Scopes: report:read:admin
Rate Limit Label: Heavy

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

from

String

Start date for which you would like to view the activity logs report. Using the from and to parameters, specify a monthly date range for the report as the API only provides one month worth of data in one request. The specified date range should fall within the last six months.

to

String

End date up to which you would like to view the activity logs report.

Page size

Number

The number of records to be returned within a single API call

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Report Telephone

<zoom-connector-mule-4:report-telephone>

The telephone report allows you to view who dialed into meetings via phone (Audio Conferencing or SIP Connected Audio) and which number they dialed into and other details. Use this API to get a telephone report for a specified period of time. This operation makes an HTTP GET request to the /report/telephone endpoint.

Prerequisites: Pro or higher plan.
Scopes: report:read:admin
Rate Limit Label: Heavy

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

type

Enumeration, one of:

j_1
j_3

Audio types:

* 1

Toll-free Call-in & Call-out.

* 2

Toll.

* 3

SIP Connected Audio.

j_1

Query date type

Enumeration, one of:

START_TIME
END_TIME

Date types: start_time - Query by call start time. end_time - Query by call end time.

START_TIME

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Report Users

<zoom-connector-mule-4:report-users>

A user is considered to be an active host during the month specified in the "from" and "to" range, if the user has hosted at least one meeting during this period. If the user didn’t host any meetings during this period, the user is considered to be inactive. The Active Hosts report displays a list of meetings, participants, and meeting minutes for a specific time range, up to one month. The month should fall within the last six months. The Inactive Hosts report pulls a list of users who were not active during a specific period of time. Use this API to retrieve an active or inactive host report for a specified period of time. The time range for the report is limited to a month and the month should fall under the past six months. You can specify the type of report and date range using the query parameters. This operation makes an HTTP GET request to the /report/users endpoint.

Prerequisites: Pro or higher plan.
Scopes: report:read:admin
Rate Limit Label: Heavy

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

type

Enumeration, one of:

ACTIVE
INACTIVE

Active or inactive hosts.

* active

Active hosts.

* inactive

Inactive hosts.

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Report Webinar Details

<zoom-connector-mule-4:report-webinar-details>

Retrieve a report containing past webinar details. This operation makes an HTTP GET request to the /report/webinars/{webinarId} endpoint.

Prerequisites: Pro or higher plan with Webinar add-on.
Scopes: report:read:admin
Rate Limit Label: 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

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Report Webinar Participants

<zoom-connector-mule-4:report-webinar-participants>

Get a detailed report on each attendee of a webinar. This operation makes an HTTP GET request to the /report/webinars/{webinarId}/participants endpoint.

Prerequisites: Pro or a higher plan with Webinar add-on enabled.
Scopes: report:read:admin
Rate Limit Label: 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

Page size

Number

Number of records returned within a single API call.

30

Include fields

Enumeration, one of:

REGISTRANT_ID

Enter 'registrant_id' as the value for this field if you would like to see the registrant ID attribute included in the response of this API call. A registrant ID is a unique identifier of a 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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Report Webinar Polls

<zoom-connector-mule-4:report-webinar-polls>

Retrieve a report on past webinar polls. This operation makes an HTTP GET request to the /report/webinars/{webinarId}/polls endpoint.

Prerequisites: Pro or a higher plan with Webinar add-on enabled.
Scopes: report:read:admin
Rate Limit Label: 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

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Report Webinar Qa

<zoom-connector-mule-4:report-webinar-qa>

The Question & Answer (Q&A) feature for webinars allows attendees to ask questions during the webinar and for the panelists, co-hosts, and host to answer their questions. Use this API to retrieve a report on question and answers from past webinars. This operation makes an HTTP GET request to the /report/webinars/{webinarId}/qa endpoint.

Prerequisites: Pro or a higher plan with Webinar add-on enabled.
Scopes: report:read:admin
Rate Limit Label: 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

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Role Member Delete

<zoom-connector-mule-4:role-member-delete>

User roles can have a set of permissions that allows access only to the pages a user needs to view or edit. Use this API to unassign a user’s role. This operation makes an HTTP DELETE request to the /roles/{roleId}/members/{memberId} endpoint.

Prerequisites: A Pro or a higher plan.
Scope: role:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Role Id

String

The role ID.

x

Member Id

String

Member’s 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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Role Members

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

User roles can have a set of permissions that enables access only to the pages a user needs to view or edit. Use this API to list all the members that are assigned a specific role. This operation makes an HTTP GET request to the /roles/{roleId}/members endpoint.

Prerequisites: A Pro or a higher plan.
Scope: role:read:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Role Id

String

The role ID.

x

Page count

String

Number of pages returned for this request.

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Roles

<zoom-connector-mule-4:roles>

List roles on your account. This operation makes an HTTP GET request to the /roles endpoint.

Prerequisites: Pro or higher plan. For setting the initial role, you must be the Account Owner. For subsequent role management, you must be the Account Owner or user with role management permissions.
Scopes: role:read:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Search Company Contacts

<zoom-connector-mule-4:search-company-contacts>

A user under an organization’s Zoom account has internal users listed under Company Contacts in the Zoom Client. Use this API to search users that are in the company contacts of a Zoom account. Using the search_key query parameter, provide either first name, last name, or the email address of the user that you would like to search for. Optionally, set query_presence_status to true to include the presence status of a contact. This operation makes an HTTP GET request to the /contacts endpoint.

Scopes: contact:read:admin, contact:read
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Search key

String

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

x

Query presence status

String

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

Page size

Number

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

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Senda Chat Message

<zoom-connector-mule-4:senda-chat-message>

Send chat messages on Zoom to either an individual user who is in your contact list or to a channel of which you are a member. For user-level apps, pass the me value instead of the userId parameter. To send a message to a contact, provide the contact’s email address in the to_contact field. To send a message to a channel, provide the channel’s ID in to_channel parameter. This operation makes an HTTP POST request to the /chat/users/{userId}/messages endpoint.

Scopes: chat_message:write, chat_message:write:admin
Rate Limit Label: Medium

Note: For an account-level OAuth app, this API can only be used on behalf of a user who is assigned with a role that has the Edit permission for Chat Messages.

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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Sendimmessages

<zoom-connector-mule-4:sendimmessages>

Send chat message to a user. Note that this API only supports OAuth 2.0. This operation makes an HTTP POST request to the /im/users/me/chat/messages endpoint.

Scope: imchat:write
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Chat user

String

The email address (registered with Zoom) or the userId of the chat user.

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Set Up Account

<zoom-connector-mule-4:set-up-account>

After assigning a Zoom phone license to an account, an admin or account owner can proceed with the initial Zoom phone set up using this API. This operation makes an HTTP POST request to the /accounts/{accountId}/phone/setup endpoint.

Prerequisites: A Paid account. A Pro or a higher account plan. Master account option enabled.
Scopes: phone:write:admin, phone:write
Rate Limit Label: 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.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Switch User Account

<zoom-connector-mule-4:switch-user-account>

Disassociate a user from one account and move the user to another account under the same master account. With this API, a user under a master account or a sub account can be moved to another sub account within the same master account. To move a user from a master account to a sub account, use me as the value for accountId. In this scenario, "me" refers to the Account ID of the master account. To move a user from one sub account to another sub account, provide the sub account’s Account ID as the value for accountId. This operation makes an HTTP PUT request to the /accounts/{accountId}/users/{userId}/account endpoint.

Prerequisites: The account should have Pro or a higher plan with master account option enabled. The user whose account needs to be switched should not be an admin or an owner of that account. The user should not have the same managed domain as the account owner.
Scope: user:master
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

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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Testget Record Archived Files

<zoom-connector-mule-4:testget-record-archived-files>

List the archived recording files of the specific meeting instance. For more information, read our Managing archiving of meeting and webinar data documentation. This operation makes an HTTP GET request to the /past_meetings/{meetingUUID}/archive_files endpoint.

Prerequisites: Enable cloud recording. Follow the enablement process to access the archiving feature.
Scopes: recording:read
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Meeting UUID

String

The meeting’s universally unique identifier (UUID). Each meeting instance generates a UUID. For example, after a meeting ends, a new UUID is generated for the next meeting instance. If the meeting UUID begins with a / character or contains a // character, you must double-encode the meeting UUID when using the meeting UUID for other API calls.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Trackingfield Create

<zoom-connector-mule-4:trackingfield-create>

Tracking fields enable you to analyze usage by various fields within an organization. Use this API to create a new tracking field. This operation makes an HTTP POST request to the /tracking_fields endpoint.

Prerequisites: Business, Education, API, or higher plan
Scope: trackingfield:write:admin
Rate Limit Label: 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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Trackingfield Delete

<zoom-connector-mule-4:trackingfield-delete>

Tracking fields enable you to analyze usage by various fields within an organization. Use this API to delete a tracking field. This operation makes an HTTP DELETE request to the /tracking_fields/{fieldId} endpoint.

Prerequisites: Business, Education, API, or higher plan.
Scope: trackingfield:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Field Id

String

The Tracking Field 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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Trackingfield Get

<zoom-connector-mule-4:trackingfield-get>

Tracking fields enable you to analyze usage by various fields within an organization. When scheduling a meeting, the tracking field is included in the meeting options. Use this API to get information on a tracking field. This operation makes an HTTP GET request to the /tracking_fields/{fieldId} endpoint.

Prerequisites: Business, Education, API, or higher plan
Scopes: trackingfield:read:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Field Id

String

The Tracking Field ID.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Trackingfield List

<zoom-connector-mule-4:trackingfield-list>

Tracking fields enable you to analyze usage by various fields within an organization. Use this API to list all the tracking fields on your Zoom account. This operation makes an HTTP GET request to the /tracking_fields endpoint.

Prerequisites: Business, Education, API, or higher plan
Scopes: trackingfield:read:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Trackingfield Update

<zoom-connector-mule-4:trackingfield-update>

Tracking fields enable you to analyze usage by various fields within an organization. Use this API to update a tracking field. This operation makes an HTTP PATCH request to the /tracking_fields/{fieldId} endpoint.

Prerequisites: Business, Education, API, or higher plan
Scope: trackingfield:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Field Id

String

The Tracking Field ID.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Tsp

<zoom-connector-mule-4:tsp>

Get information on the Telephony Service Provider on an account level. This operation makes an HTTP GET request to the /tsp endpoint.

Prerequisites: A Pro or a higher plan.
Scopes: tsp:read:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Tsp Update

<zoom-connector-mule-4:tsp-update>

Update information of the Telephony Service Provider set up on an account. This operation makes an HTTP PATCH request to the /tsp endpoint.

Prerequisites: TSP account option should be enabled.
Scopes: tsp:write:admin
Rate Limit Label: 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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Tsp Url Update

<zoom-connector-mule-4:tsp-url-update>

A global dial-in page can provide a list of global access numbers to use for audio conferencing. By calling this API, you can set the URL for the global dial-in page of a user whose Zoom account has TSP and special TSP with third-party audio conferencing options enabled. This operation makes an HTTP PATCH request to the /users/{userId}/tsp/settings endpoint.

Scopes: tsp:write:admin tsp:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The userId or email address of the user.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Un Assign Phone Num Call Queue

<zoom-connector-mule-4:un-assign-phone-num-call-queue>

After assigning a phone number, you can unbind it if you don’t want it to be assigned to a call queue. Use this API to unbind a phone number from a Call Queue. After successful unbinding, the number will appear in the Unassigned tab. This operation makes an HTTP DELETE request to the /phone/call_queues/{callQueueId}/phone_numbers/{phoneNumberId} endpoint.

Prerequisites: Pro or higher account plan. Account owner or admin permissions. Zoom Phone license.
Scopes: phone:write:admin
Rate Limit Label: 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. This can be retrieved from the List Call Queues API.

x

Phone Number Id

String

Unique identifier of the Phone Number.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Unassign All Members

<zoom-connector-mule-4:unassign-all-members>

Use this API to remove all members from a Call Queue who were previously assigned to that Call Queue. The members could be phone users or common area phones. This operation makes an HTTP DELETE request to the /phone/call_queues/{callQueueId}/members endpoint.

Prerequisites: Pro or higher account plan. Zoom Phone license.
Scopes: phone:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Call Queue Id

String

Call Queue ID.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Unassign All Phone Nums Auto Receptionist

<zoom-connector-mule-4:unassign-all-phone-nums-auto-receptionist>

Unassign all phone numbers that were previously assigned to an auto receptionist. This operation makes an HTTP DELETE request to the /phone/auto_receptionists/{autoReceptionistId}/phone_numbers endpoint.

Prerequisites: Pro or higher account plan with Zoom Phone License. Account owner or admin permissions.
Scopes: phone:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Auto Receptionist Id

String

Auto Receptionist ID.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Unassign A Phone Num Auto Receptionist

<zoom-connector-mule-4:unassign-aphone-num-auto-receptionist>

Unassign a specific phone number that was previously assigned to an auto receptionist. This operation makes an HTTP DELETE request to the /phone/auto_receptionists/{autoReceptionistId}/phone_numbers/{phoneNumberId} endpoint.

Prerequisites: Pro or higher account plan with Zoom Phone License. Account owner or admin permissions.
Scopes: phone:write:admin
Rate Limit Label: 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. This can be retrieved from the List Phone Sites API.

x

Phone Number Id

String

Unique identifier of the phone number or provide the actual phone number in e164 format (example: +19995550123).

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Unassign A Phone Num Call Queue

<zoom-connector-mule-4:unassign-aphone-num-call-queue>

Use this API to unbind all phone numbers that are assigned to a call queue. After successful unbinding, the numbers will appear in the Unassigned tab. If you only need to unassign a specific phone number, use the Unassign a Phone Number API instead. This operation makes an HTTP DELETE request to the /phone/call_queues/{callQueueId}/phone_numbers endpoint.

Prerequisites: Pro or higher account plan. Account owner or admin permissions. Zoom Phone license.
Scopes: phone:write:admin
Rate Limit Label: 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. This can be retrieved from List Call Queues API.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Unassign Calling Plan

<zoom-connector-mule-4:unassign-calling-plan>

Use this API to unassign a Zoom Phone user’s calling plan. For user-level apps, pass the me value instead of the userId parameter. This operation makes an HTTP DELETE request to the /phone/users/{userId}/calling_plans/{type} endpoint.

Prerequisites: A Business or Enterprise account. A Zoom Phone license.
Scopes: phone:write, phone:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

User ID.

x

type

String

The type of the calling plan that was assigned to user. (e.g: The value of type would be "200" for the Unlimited US/Canada calling plan.)

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Unassign Calling Plans From Common Area Phone

<zoom-connector-mule-4:unassign-calling-plans-from-common-area-phone>

Use this API to unassign a calling plan from a common area phone. This operation makes an HTTP DELETE request to the /phone/common_area_phones/{commonAreaPhoneId}/calling_plans/{type} endpoint.

Prerequisites: A Pro or higher account with a Zoom Phone license. An account owner or admin permissions.
Scopes: phone:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Common Area Phone Id

String

The common area phone''s unique ID.

x

type

String

The calling plan to remove.

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Unassign Member From Call Queue

<zoom-connector-mule-4:unassign-member-from-call-queue>

Use this API to remove a member from a Call Queue who was previously added to that Call Queue. The member could be a phone user or a common area phone. A member who is a Call Queue Manager cannot be unassigned from the Call Queue using this API. This operation makes an HTTP DELETE request to the /phone/call_queues/{callQueueId}/members/{memberId} endpoint.

Prerequisites: Pro or higher account plan. Zoom Phone license.
Scopes: phone:write:admin
Rate Limit Label: 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 from which the member needs to be unassigned.

x

Member Id

String

Unique identifier of the member who needs to be unassigned.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Unassign Phone Number

<zoom-connector-mule-4:unassign-phone-number>

Use this API to unassign a Zoom Phone user’s phone number. For user-level apps, pass the me value instead of the userId parameter. After assigning a phone number, you can remove it if you do not want it to be assigned to anyone. This operation makes an HTTP DELETE request to the /phone/users/{userId}/phone_numbers/{phoneNumberId} endpoint.

Prerequisites: A Business or Enterprise account. A Zoom Phone license. The user must have been previously assigned a Zoom Phone number.
Scopes: phone:write, phone:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

Provide either userId or email address of the user.

x

Phone Number Id

String

Provide either phone number or phoneNumberId of the user.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Unassign Phone Numbers From Common Area Phone

<zoom-connector-mule-4:unassign-phone-numbers-from-common-area-phone>

Use this API to unassign a phone number from a common Area phone. This operation makes an HTTP DELETE request to the /phone/common_area_phones/{commonAreaPhoneId}/phone_numbers/{phoneNumberId} endpoint.

Prerequisites: A Pro or a higher account with a Zoom Phone license. An account owner or admin permissions.
Scopes: phone:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Common Area Phone Id

String

The common area phone''s unique ID.

x

Phone Number Id

String

The phone number or the phone number''s unique 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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Update Account Lock Settings

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

Account Locked Settings enable turning settings on or off for all users in your account. No user except the account admin or account owner can change these settings. With lock settings, you force the settings on for all users. Use this API to update an account’s locked settings. Note that this API can be used by Zoom Accounts that are on a Pro or a higher plan as well accounts that have master and sub accounts options enabled. This operation makes an HTTP PATCH request to the /accounts/{accountId}/lock_settings endpoint.

Prerequisites: Pro or a higher paid account.
Scope: account:write:admin
Rate Limit Label: Medium

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

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Update Account Owner

<zoom-connector-mule-4:update-account-owner>

Use this API to change an account’s owner. An account’s current owner can change the account’s owner to another user on the same account. This operation makes an HTTP PUT request to the /accounts/{accountId}/owner endpoint.

Prerequisites: An account owner or admin permissions of an account. The account making this API request must be on a Pro or a higher account plan with master account privileges.
Scopes: account:write:admin or account: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''s account ID.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Update A Device

<zoom-connector-mule-4:update-adevice>

Update information of a desk phone device. This operation makes an HTTP PATCH request to the /phone/devices/{deviceId} endpoint.

Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin permissions.
Scopes: phone:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Device Id

String

Unique identifier of the device.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Update A Group Member

<zoom-connector-mule-4:update-agroup-member>

If a user is a member in multiple groups, you can set a primary group for the user. The group member will use the primary group’s settings by default. However, if settings are locked in other groups, those settings continue to be locked for that user. By default, the primary group is the first group that user is added to. Use this API to perform either of the following tasks: Simultaneously remove a member from one group and move the member to a different group, or set a primary group for the user. This operation makes an HTTP PATCH request to the /groups/{groupId}/members/{memberId} endpoint.

Prerequisites: Pro or higher account
Scopes: group:write:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Group Id

String

Unique identifier of the group. Can be retrieved by calling GET /groups API. To change a member''s primary group, provide the groupId of the member''s current primary group as the value of this field. To remove a member from one group and move the member to another group, provide the groupId of the group from which the member is to be moved.

x

Member Id

String

Unique identifier of the group member. Can be retrieved by calling the [List Group Members](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groupmembers) API.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Update A Shared Line Group

<zoom-connector-mule-4:update-ashared-line-group>

A shared line group allows Zoom Phone admins to share a phone number and extension with a group of phone users or common area phones. This gives members of the shared line group access to the group’s direct phone number and voicemail. Use this API to update the information of a Shared Line Group. This operation makes an HTTP PATCH request to the /phone/shared_line_groups/{sharedLineGroupId} endpoint.

Prerequisites: * Pro or higher account with Zoom Phone license. Account owner or admin privileges.
Scopes: phone:write:admin
Rate Limit Label: 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 that is to be updated.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Update Auto Receptionist

<zoom-connector-mule-4:update-auto-receptionist>

An auto receptionist answers calls with a personalized recording and routes calls to a phone user, call queue, common area phone, or voicemail. An auto receptionist can also be set up so that it routes calls to an interactive voice response (IVR) system to allow callers to select the routing options. Use this API to change the information , such as display name and extension number, assigned to the main auto receptionist. This operation makes an HTTP PATCH request to the /phone/auto_receptionists/{autoReceptionistId} endpoint.

Prerequisites: Pro or higher account with Zoom Phone license.
Scopes: phone:write:admin
Rate Limit Label: 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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Update Blocked List

<zoom-connector-mule-4:update-blocked-list>

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

Prerequisites: Pro or higher account plan with Zoom phone license
Scope: phone:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Blocked List Id

String

Unique identifier of the blocked list.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Update Call Queue

<zoom-connector-mule-4:update-call-queue>

Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, or customer service. Use this API to update information of a specific Call Queue. This operation makes an HTTP PATCH request to the /phone/call_queues/{callQueueId} endpoint.

Prerequisites: Pro, Business, or Education account. Account owner or admin permissions. Zoom Phone license.
Scopes: phone:write:admin
Rate Limit Label: 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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Update Channel

<zoom-connector-mule-4:update-channel>

Use this API to update the name of a specific channel created by a user. For user-level apps, pass the me value instead of the userId parameter. Zoom chat channels allow users to communicate via chat in private or public channels. This operation makes an HTTP PATCH request to the /chat/users/{userId}/channels/{channelId} endpoint.

Scopes: chat_channel:write:admin
Rate Limit Label: Medium

Note: For an account-level OAuth app, this API can only be used on behalf of a user who is assigned with a role that has the Edit permission for Chat Channel.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Channel Id

String

Channel ID.

x

User Id

String

Unique identifier of the Zoom user who is the owner of the channel.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Update Common Area Phone

<zoom-connector-mule-4:update-common-area-phone>

Use this API to update details on a specific common area phone in an account. A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it, for example, if your office has shared desks that don’t belong to a specific employee, you could add a common area phone so that any person can use it. This operation makes an HTTP PATCH request to the /phone/common_area_phones/{commonAreaPhoneId} endpoint.

Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin permissions. A supported device.
Scopes: phone:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Common Area Phone Id

String

Common Area Phone ID.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Update External Contact

<zoom-connector-mule-4:update-external-contact>

Use this API to update an external contact’s information. This operation makes an HTTP PATCH request to the /phone/external_contacts/{externalContactId} endpoint.

Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin permissions.
Scopes: phone:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

External Contact Id

String

External contact ID.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Update Group Settings

<zoom-connector-mule-4:update-group-settings>

Update settings for a group. Note: The force_pmi_jbh_password field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality. This operation makes an HTTP PATCH request to the /groups/{groupId}/settings endpoint.

Prerequisites: Pro, Business, or Education account
Scopes: group:write:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Group Id

String

ID of the group.

x

Custom query fields

String

Provide the name of the field by which you would like to filter the response. For example, if you provide "host_video" as the value of this field, you will get a response similar to the following: { "schedule_meeting": { "host_video": false } } You can provide multiple values by separating them with commas(example: "host_video,participant_video).

option

Enumeration, one of:

MEETING_AUTHENTICATION
RECORDING_AUTHENTICATION
MEETING_SECURITY

option

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Update Location

<zoom-connector-mule-4:update-location>

Use this API to update an emergency location’s information. This operation makes an HTTP PATCH request to the /phone/locations/{locationId} endpoint.

Prerequisites: Pro or a higher account with Zoom Phone license. Account owner or admin permissions.
Scopes: phone:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Location Id

String

The emergency service location’s ID.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Update Phone Number Details

<zoom-connector-mule-4:update-phone-number-details>

Use this API to update a Zoom Phone number’s information. This operation makes an HTTP PATCH request to the /phone/numbers/{numberId} endpoint.

Prerequisites: A Paid account
Scopes: phone:write, phone:write:admin, phone:master
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Number Id

String

Phone number ID.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Update Phone Settings

<zoom-connector-mule-4:update-phone-settings>

Master account owners can use this API to enable the BYOC (Bring Your Own Carrier) option for a subaccount. This operation makes an HTTP PATCH request to the /phone/settings endpoint.

Prerequisites: A Business or Enterprise account
Scopes: phone:master

Parameters

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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Update Phone Sip Trunk

<zoom-connector-mule-4:update-phone-siptrunk>

Use this API to update a subaccount’s assigned SIP (Session Initiation Protocol) trunk information. This operation makes an HTTP PATCH request to the /accounts/{accountId}/phone/sip_trunk/trunks/{sipTrunkId} endpoint.

Prerequisites: A Business or Enterprise account
Scopes: phone:master
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Sip Trunk Id

String

Unique identifier of the SIP trunk.

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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Update Presence Status

<zoom-connector-mule-4:update-presence-status>

Use this API to update a user’s presence status. For user-level apps, pass the me value instead of the userId parameter. A user’s status cannot be updated more than once per minute, for example, you can only submit a maximum of one update request per minute for a single user. Users in the Zoom desktop client and mobile apps are assigned with a presence status. The presence status informs users of their contact’s availability. Users can also change their own presence status to one of the following: Away, Do not disturb, Available, In a calendar event, Presenting, In a Zoom meeting, or On a call. Note that a user’s presence status cannot be updated via this API if the user is not logged in to the Zoom client. This operation makes an HTTP PUT request to the /users/{userId}/presence_status endpoint.

Scopes: user:write, user:write:admin
Rate Limit Label: Medium

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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Update Role

<zoom-connector-mule-4:update-role>

Each Zoom user automatically has a role which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list. Use this API to change the privileges, name, and description of a specific role. This operation makes an HTTP PATCH request to the /roles/{roleId} endpoint.

Prerequisites: A Pro or higher plan. For role management and updates, you must be the Account Owner or user with role management permissions.
Scopes: role:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Role Id

String

Role ID.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Update Room Profile

<zoom-connector-mule-4:update-room-profile>

Update basic information on a specific Zoom Room in a Zoom account. This operation makes an HTTP PATCH request to the /rooms/{roomId} endpoint.

Prerequisites: Pro or a higher plan with Zoom Room license.
Scopes: room:write:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Room Id

String

Unique identifier of a Zoom Room.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Update Setting Template

<zoom-connector-mule-4:update-setting-template>

Use this API to update or modify a phone template’s settings. This operation makes an HTTP PATCH request to the /phone/setting_templates/{templateId} endpoint.

Prerequisites: A Business or Enterprise account. A Zoom Phone license.
Scopes: phone:write:admin or phone:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Template Id

String

The Template ID.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Update Sip Phone

<zoom-connector-mule-4:update-sipphone>

Zoom’s Phone System Integration (PSI), also referred as SIP phones, enables an organization to leverage the Zoom client to complete a softphone registration to supported premise based PBX system. End users will have the ability to have softphone functionality within a single client while maintaining a comparable interface to Zoom Phone. Use this API to update information of a specific SIP Phone on a Zoom account. This operation makes an HTTP PATCH request to the /sip_phones/{phoneId} endpoint.

Prerequisites: Currently only supported on Cisco and Avaya PBX systems. The account owner or account admin must first enable SIP Phone Integration by contacting the 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

Phone Id

String

Unique identifier of the SIP Phone. This can be retrieved from the List SIP Phones API.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Update Site Details

<zoom-connector-mule-4:update-site-details>

Sites allow you to organize Zoom Phone users in your organization. Use this API to update information about a specific site. This operation makes an HTTP PATCH request to the /phone/sites/{siteId} endpoint.

Prerequisites: Account must have a Pro or a higher plan with Zoom Phone license.
Scope: phone:write:admin
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Site Id

String

Unique identifier of the site.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Update User Level Channel

<zoom-connector-mule-4:update-user-level-channel>

Zoom chat channels allow users to communicate via chat in private or public channels. Use this API to update the name of a specific channel that you created. This operation makes an HTTP PATCH request to the /chat/channels/{channelId} endpoint.

Scope: chat_channel:write
Rate Limit Label: Medium

Note that this API only supports user-managed OAuth app.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Channel Id

String

Channel ID.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Update User Profile

<zoom-connector-mule-4:update-user-profile>

Use this API to update a user’s Zoom Phone profile. For user-level apps, pass the me value instead of the userId parameter. This operation makes an HTTP PATCH request to the /phone/users/{userId} endpoint.

Prerequisites: A Business or Enterprise account. A Zoom Phone license.
Scopes: phone:write, phone:write:admin
Rate Limit Label: 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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Update User Setting

<zoom-connector-mule-4:update-user-setting>

Use this API to update the voicemail access permissions of a user. For user-level apps, pass the me value 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 PATCH 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

Setting Type

String

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

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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Update Zoom Room Acc Settings

<zoom-connector-mule-4:update-zoom-room-acc-settings>

Update account settings applied for Zoom Rooms in a Zoom account. With this API, you can update either the Account Meeting Settings or the Alert Settings (Client Alert Settings and Notfication Settings) of the Zoom Rooms account by specifying the required setting type in the setting_type parameter. To update only Alert Settings, specify alert as the value of the setting_type query parameter and to update only Account Meeting Settings, specify meeting as the value of the setting_type query parameter. This operation makes an HTTP PATCH request to the /rooms/account_settings endpoint.

Prerequisites: Zoom Room licenses. Owner or Admin privileges on the Zoom Account.
Scopes: room:write:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Setting type

String

The type of setting that you would like to update.

* alert

Alert Settings applied on the Zoom Rooms Account.

* meeting

Meeting settings of the Zoom Rooms Account.

* signage

View digital signage settings of the Zoom Rooms Account.

meeting

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Update Zoom Rooms Location Structure

<zoom-connector-mule-4:update-zoom-rooms-location-structure>

Update the location hierarchial structure(s) applied on the Zoom Rooms in an account. This operation makes an HTTP PATCH request to the /rooms/locations/structure endpoint.

Prerequisites: Zoom Rooms version 4.0 or higher. Account owner or admin permissions.
Scopes: room:write:admin
Rate Limit Label: Medium

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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Update Zr Acc Profile

<zoom-connector-mule-4:update-zracc-profile>

Update information on the account profile of a Zoom Room. This information can only by accessed either by the Zoom Room Account Owner or a user with Zoom Rooms admin permission. To update information on an individual Room Profile, use Update Zoom Room Profile API instead. This operation makes an HTTP PATCH request to the /rooms/account_profile endpoint.

Prerequisites: Zoom account owner or Zoom Rooms admin permissions
Scopes: room:write:admin
Rate Limit Label: Medium

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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Update Zr Location Profile

<zoom-connector-mule-4:update-zrlocation-profile>

Each location type of the Zoom Rooms Location Hierarchy has a profile page that includes information such as name of the location, address, support email, etc. Use this API to update information about a specific Zoom Rooms location type such as information about the city where the Zoom Rooms are located. This operation makes an HTTP PATCH request to the /rooms/locations/{locationId} endpoint.

Prerequisites: Account owner or admin permission. Zoom Rooms version 4.0 or higher.
Scopes: room:write:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Location Id

String

Unique identifier of the location. This can be retrieved from the [List Zoom Room Locations](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) API.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Update Zr Location Settings

<zoom-connector-mule-4:update-zrlocation-settings>

Update information on either meeting or alert settings applied to Zoom Rooms located in a specific location. To update Alert Settings, specify alert as the value of the setting_type query parameter. Similarly, to update Meeting Settings, specify meeting as the value of the setting_type query parameter. This operation makes an HTTP PATCH request to the /rooms/locations/{locationId}/settings endpoint.

Prerequisites: Zoom Room licenses. Owner or Admin privileges on the Zoom Account.
Scopes: room:write:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Location Id

String

Unique identifier of the location type. This can be retrieved using the [List Zoom Room Location API](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) (Id property in the response).

x

Setting type

String

The type of setting that you would like to update.

* alert

Alert Settings applied on the Zoom Rooms Account.

* meeting

Meeting settings of the Zoom Rooms Account.

* signage

Digital signage settings.

meeting

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Update Zr Settings

<zoom-connector-mule-4:update-zrsettings>

Update either meeting or alert settings applied to a specific Zoom Room. To update Alert Settings, specify alert as the value of the setting_type query parameter. To update Meeting Settings, specify meeting as the value of the setting_type query parameter. This operation makes an HTTP PATCH request to the /rooms/{roomId}/settings endpoint.

Prerequisites: Zoom Room licenses. Owner or Admin privileges on the Zoom Account.
Scopes: room:write:admin
Rate Limit Label: Medium

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

Setting type

String

The type of setting that you would like to update. alert: Alert Settings applied on the Zoom Room. meeting: Meeting settings of the Zoom Room. signage: Digital signage settings applied on the Zoom Room.

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Upload Group Vb

<zoom-connector-mule-4:upload-group-vb>

Use this API to upload virtual background files for all users in a group to use. This operation makes an HTTP POST request to the /groups/{groupId}/settings/virtual_backgrounds endpoint.

Prerequisites: Virtual background feature must be enabled on the account.
Scope: group:write:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Group Id

String

Unique identifier of the group. Retrieve the value for this field by calling the List groups API.

x

File ids

String

Provide the ID of the file that is to be deleted. To delete multiple files, provide comma-separated values for this field.

File - Body

String

The content of the 'file' part.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Upload Vb

<zoom-connector-mule-4:upload-vb>

Use this API to upload virtual background files for all users on the account to use. This operation makes an HTTP POST request to the /accounts/{accountId}/settings/virtual_backgrounds endpoint.

Prerequisites: Virtual background feature must be enabled on the account.
Scope: 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

Unique identifier of the account.

x

File - Body

String

The content of the 'file' part.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Upload V Buser

<zoom-connector-mule-4:upload-vbuser>

Use this API to upload virtual background files to a user’s profile. For user-level apps, pass the me value instead of the userId parameter. Note: A user profile cannot exceed more than 10 files. This operation makes an HTTP POST request to the /users/{userId}/settings/virtual_backgrounds endpoint.

Prerequisites: Virtual background feature must be enabled on the account.
Scopes: user:write:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

Unique identifier of the user. Retrieve the value for this field by calling the List users API.

x

File - Body

String

The content of the 'file' part.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

User

<zoom-connector-mule-4:user>

View a specific user’s information on a Zoom account. A Zoom account can have one or more users. For user-level apps, pass the me value instead of the userId parameter. Note: Users who have not activated their account have a status of pending, and the created_at time displays the time at which the API call was made. This operation makes an HTTP GET request to the /users/{userId} endpoint.

Scopes: user:read:admin, user:read, user_info:read. Note: The user_info:read scope is only available when you pass the me value for the $userId value.
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

x

Login type

Enumeration, one of:

j_0
j_1
j_11
j_21
j_23
j_24
j_27
j_97
j_98
j_99
j_100
j_101

The user’s login method:

* 0 - Facebook OAuth

* 1 - Google OAuth

* 24 - Apple OAuth

* 27 - Microsoft OAuth

* 97 - Mobile device

* 98 - RingCentral OAuth

* 99- API user

* 100 - Zoom Work email

* 101 - Single Sign-On (SSO)

The following login methods are available only in China:

* 11 - Phone number

* 21 - WeChat

* 23 - Alipay

Encrypted email

Boolean

Whether the email address passed for the userId value is an encrypted email address:

* true

The email address is encrypted.

* false

The email address is not encrypted. If you do not query this parameter, this value defaults to null (false).

false

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

User Assistant Create

<zoom-connector-mule-4:user-assistant-create>

Use this API to assign assistants to a user. In the request body, provide either the user’s ID or the user’s email address. For user-level apps, pass the me value instead of the userId parameter. Assistants are the users to whom the current user has assigned the scheduling privilege. These assistants can schedule meeting on behalf of the current user as well as manage and act as an alternative host for all meetings if the admin has enabled Co-host option on the account. This operation makes an HTTP POST request to the /users/{userId}/assistants endpoint.

Prerequisites: The user as well as the assistant must have Licensed or an On-prem license. Assistants must be under the current user’s account.
Scopes: user:write:admin, user:write
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

User Assistant Delete

<zoom-connector-mule-4:user-assistant-delete>

Delete a specific assistant of a user. For user-level apps, pass the me value instead of the userId parameter. Assistants are the users to whom the current user has assigned the scheduling privilege. These assistants can schedule meeting on behalf of the current user as well as manage and act as an alternative host for all meetings if the admin has enabled Co-host option on the account. This operation makes an HTTP DELETE request to the /users/{userId}/assistants/{assistantId} endpoint.

Prerequisites: The user as well as the assistant must have Licensed or an On-prem license. Assistants must be under the current user’s account.
Scopes: user:write:admin, user:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

x

Assistant Id

String

Assistant 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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

User Assistants

<zoom-connector-mule-4:user-assistants>

List a user’s assistants. For user-level apps, pass the me value instead of the userId parameter. Assistants are the users to whom the current user has assigned the scheduling privilege. These assistants can schedule meeting on behalf of the current user as well as manage and act as an alternative host for all meetings if the admin has enabled Co-host option on the account. This operation makes an HTTP GET request to the /users/{userId}/assistants endpoint.

Prerequisites: Current user as well as the assistant must have Licensed or an On-prem license. Assistants must be under the current user’s account.
Scopes: user:read:admin, user:read
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

User Assistants Delete

<zoom-connector-mule-4:user-assistants-delete>

Delete all assistants of the current user. For user-level apps, pass the me value instead of the userId parameter. Assistants are the users to whom the current user has assigned the scheduling privilege. These assistants can schedule meeting on behalf of the current user as well as manage and act as an alternative host for all meetings if the admin has enabled Co-host option on the account. This operation makes an HTTP DELETE request to the /users/{userId}/assistants endpoint.

Prerequisites: The user as well as the assistant must have Licensed or an On-prem license. Assistants must be under the current user’s account.
Scopes: user:write:admin, user:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

User Create

<zoom-connector-mule-4:user-create>

A Zoom account can have one or more users. Use this API to add a new user to your account. This operation makes an HTTP POST request to the /users endpoint.

Prerequisites: Pro or higher plan
Scopes: user:write:admin user:write
Rate Limit Label: 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

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

User Delete

<zoom-connector-mule-4:user-delete>

Use this API to disassociate (unlink) a user or permanently delete a user. For user-level apps, pass the me value instead of the userId parameter. Deleting a user permanently removes the user and their data from Zoom. Users can create a new Zoom account using the same email address. An account owner or an account admin can transfer meetings, webinars, and cloud recordings to another Zoom user account before deleting. Disassociating a user unlinks the user from the associated Zoom account and provides the user their own basic free Zoom account. The disassociated user can then purchase their own Zoom licenses. An account owner or account admin can transfer the user’s meetings, webinars, and cloud recordings to another user before disassociation. This operation makes an HTTP DELETE request to the /users/{userId} endpoint.

Scopes: user:write:admin, user:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

x

action

Enumeration, one of:

DISASSOCIATE
DELETE

Delete action options:

* disassociate

Disassociate a user.

* delete

Permanently delete a user. Note: To delete pending user in the account, use disassociate.

DISASSOCIATE

Transfer email

String

Transfer email.

Transfer meeting

Boolean

Transfer meeting.

false

Transfer webinar

Boolean

Transfer webinar.

false

Transfer recording

Boolean

Transfer recording.

false

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

User Email

<zoom-connector-mule-4:user-email>

Verify if a user’s email is registered with Zoom. Note: You can successfully check if a user is a registered Zoom user only if the user signed up for Zoom via email and is within your account. If you provide an email address of a user who is not in your account, the value of "existed_email" parameter will be "false" irrespective of whether or not the user is registered with Zoom. The response of this API call will not include users who joined Zoom using options such as "Sign in with SSO", "Sign in with Google", or "Sign in with Facebook" even if they are in the same account as yours. This operation makes an HTTP GET request to the /users/email endpoint.

Scopes: user:read:admin user:read
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

email

String

The email address to be verified.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

User Email Update

<zoom-connector-mule-4:user-email-update>

Change a user’s email address on a Zoom account that has managed domain set up. For user-level apps, pass the me value instead of the userId parameter. If the Zoom account in which the user belongs has multiple managed domains, then the email to be updated must match one of the managed domains. A user’s email address can only be changed for a maximum of 3 times in a day (24 hours). This operation makes an HTTP PUT request to the /users/{userId}/email endpoint.

Prerequisites: Managed domain must be enabled in the account. The new email address should not already exist in Zoom.
Scopes: user:write:admin, user:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

User Pa Cs

<zoom-connector-mule-4:user-pacs>

Use this API to list a user’s Personal Audio Conference accounts. For user-level apps, pass the me value instead of the userId parameter. PAC allows Pro or higher account holders to host meetings through PSTN (phone dial-in) only. This operation makes an HTTP GET request to the /users/{userId}/pac endpoint.

Prerequisites: A Pro or higher plan with Premium Audio Conferencing add-on. Personal Audio Conference must be enabled in the user’s profile.
Scopes: pac:read:admin, pac:read
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

User Password

<zoom-connector-mule-4:user-password>

Update a user’s password for logging into Zoom. For user-level apps, pass the me value instead of the userId parameter. After this request is processed successfully, an email notification is sent to the user stating that the password was changed. This operation makes an HTTP PUT request to the /users/{userId}/password endpoint.

Prerequisites: Owner or admin of the Zoom account.
Scopes: user:write:admin user:write
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

User Permission

<zoom-connector-mule-4:user-permission>

Use this API to get permissions that have been granted to the user. For user-level apps, pass the me value instead of the userId parameter. Users can be assigned a set of permissions that allows them to access only the pages/information that a user needs to view or edit. This operation makes an HTTP GET request to the /users/{userId}/permissions endpoint.

Scopes: user:read:admin, user:read
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

User Picture

<zoom-connector-mule-4:user-picture>

Upload a user’s profile picture. For user-level apps, pass the me value instead of the userId parameter. Provide multipart/form-data as the value of the content-type header for this request. This API supports .jpeg and .png file formats. This operation makes an HTTP POST request to the /users/{userId}/picture endpoint.

Scopes: user:write:admin, user:write
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

x

Pic _ file - Body

String

The content of the 'Pic file' part.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

User Scheduler Delete

<zoom-connector-mule-4:user-scheduler-delete>

Delete a scheduler. For user-level apps, pass the me value instead of the userId parameter. Schedulers are users on whose behalf the current user (assistant) can schedule meetings for. By calling this API, the current user will no longer be a scheduling assistant of this scheduler. This operation makes an HTTP DELETE request to the /users/{userId}/schedulers/{schedulerId} endpoint.

Prerequisites: Current user must be under the same account as the scheduler.
Scopes: user:write:admin, user:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

x

Scheduler Id

String

Scheduler’s 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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

User Schedulers

<zoom-connector-mule-4:user-schedulers>

List all the schedulers of a user. For user-level apps, pass the me value instead of the userId parameter. Schedulers in this context are the users for whom the current user can schedule meetings for. For example, if the current user (the user whose userId was passed in the path parameter) is "user A", the response of this API will contain a list of user(s), for whom user A can schedule and manage meetings. User A is the assistant of these users and thus has scheduling privilege for these user(s). This operation makes an HTTP GET request to the /users/{userId}/schedulers endpoint.

Prerequisites: Current user must be under the same account as the scheduler.
Scopes: user:read:admin, user:read
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

User Schedulers Delete

<zoom-connector-mule-4:user-schedulers-delete>

Delete all of a user’s schedulers. For user-level apps, pass the me value instead of the userId parameter. Schedulers are users on whose behalf the current user (assistant) can schedule meetings for. By calling this API, the current user will no longer be a scheduling assistant of any user. This operation makes an HTTP DELETE request to the /users/{userId}/schedulers endpoint.

Prerequisites: Current user (assistant) must be under the same account as the scheduler.
Scopes: user:write:admin, user:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

User Settings

<zoom-connector-mule-4:user-settings>

Retrieve a user’s settings. For user-level apps, pass the me value instead of the userId parameter. This operation makes an HTTP GET request to the /users/{userId}/settings endpoint.

Scopes: user:read:admin, user:read
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

x

Login type

Enumeration, one of:

j_0
j_1
j_11
j_21
j_23
j_24
j_27
j_97
j_98
j_99
j_100
j_101

The user’s login method:

* 0 - Facebook OAuth

* 1 - Google OAuth

* 24 - Apple OAuth

* 27 - Microsoft OAuth

* 97 - Mobile device

* 98 - RingCentral OAuth

* 99- API user

* 100 - Zoom Work email

* 101 - Single Sign-On (SSO)

The following login methods are available only in China:

* 11 - Phone number

* 21 - WeChat

* 23 - Alipay

option

Enumeration, one of:

MEETING_AUTHENTICATION
RECORDING_AUTHENTICATION

* meeting_authentication

Use this query parameter to view meeting authentication configuration applied on the user’s account.

* recording_authentication

Use this query parameter to view recording authentication configuration applied on the user’s account.

* meeting_security

Use this query parameter to view meeting security settings applied on the user’s account.

Custom query fields

String

Provide the name of the field by which you would like to filter the response. For example, if you provide "host_video" as the value of this field, you will get a response similar to the following: { "schedule_meeting": { "host_video": false } }. You can provide multiple values by separating them with commas (example: "host_video,participant_video).

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

User Settings Update

<zoom-connector-mule-4:user-settings-update>

Update a user’s settings. For user-level apps, pass the me value instead of the userId parameter. This operation makes an HTTP PATCH request to the /users/{userId}/settings endpoint.

Scopes: user:write:admin, user:write
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

x

option

Enumeration, one of:

MEETING_AUTHENTICATION
RECORDING_AUTHENTICATION
MEETING_SECUIRTY

option

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

User Sso Token Delete

<zoom-connector-mule-4:user-ssotoken-delete>

Revoke a user’s SSO token. For user-level apps, pass the me value instead of the userId parameter. After calling this API, the SSO user will be logged out of their current Zoom session. This operation makes an HTTP DELETE request to the /users/{userId}/token endpoint.

Scopes: user:write:admin, user:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

User Status

<zoom-connector-mule-4:user-status>

Use this API to deactivate an active user or to reactivate a deactivated user. For user-level apps, pass the me value instead of the userId parameter. An account owner or admins can deactivate as well as activate a user in a Zoom account. Deactivating a user will remove all licenses associated with a user. It will prevent the deactivated user from logging into their Zoom account. A deactivated user can be reactivated. Reactivating a user grants the user access to login to their Zoom account. This operation makes an HTTP PUT request to the /users/{userId}/status endpoint.

Scopes: user:write:admin, user:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

User Token

<zoom-connector-mule-4:user-token>

Retrieve a user’s token. For user-level apps, pass the me value instead of the userId parameter. This token is used for starting meetings with the Client SDK. If a user signed into Zoom using Google or Facebook, a null value will be returned for the token. To get the token with this API, ask the user to sign into Zoom using their email and password instead. This operation makes an HTTP GET request to the /users/{userId}/token endpoint.

Scopes: user:read:admin, user:read
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

x

type

Enumeration, one of:

TOKEN
ZAK

User token types:

* token

Used for starting meetings with the client SDK. This token expires in 14 days and a new token will be returned after the expiry.

* zak

Used for generating the start meeting URL. The token expiration time is two hours. For API users, the expiration time is 90 days.

ttl

Number

Use this field in conjunction with the type field where the value of type field is zak. The value of this field denotes the expiry time of the zak token in seconds. For example, if you would like the zak token to be expired after one hour of the token generation, the value of this field should be 3600.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

User Tsp

<zoom-connector-mule-4:user-tsp>

Each user can have a maximum of two TSP accounts. Use this API to retrieve details of a specific TSP account enabled for a specific user. This operation makes an HTTP GET request to the /users/{userId}/tsp/{tspId} endpoint.

Scopes: tsp:read:admin tsp:read
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

x

Tsp Id

Enumeration, one of:

j_1
j_2

TSP account ID.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

User Tsp Create

<zoom-connector-mule-4:user-tspcreate>

Add a user’s TSP account. This operation makes an HTTP POST request to the /users/{userId}/tsp endpoint.

Scopes: tsp:write:admin tsp:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

User Tsp Delete

<zoom-connector-mule-4:user-tspdelete>

Delete a user’s TSP account. This operation makes an HTTP DELETE request to the /users/{userId}/tsp/{tspId} endpoint.

Scopes: tsp:write:admin tsp:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

x

Tsp Id

Enumeration, one of:

j_1
j_2

TSP 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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

User Ts Ps

<zoom-connector-mule-4:user-tsps>

A user can have a maximum of two TSP accounts. Use this API to list all TSP accounts of a user. This operation makes an HTTP GET request to the /users/{userId}/tsp endpoint.

Scopes: tsp:read:admin tsp:read
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

User Tsp Update

<zoom-connector-mule-4:user-tspupdate>

Update a user’s TSP account. This operation makes an HTTP PATCH request to the /users/{userId}/tsp/{tspId} endpoint.

Scopes: tsp:write:admin tsp:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

x

Tsp Id

Enumeration, one of:

j_1
j_2

TSP account ID.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

User Update

<zoom-connector-mule-4:user-update>

Update information on a user’s Zoom profile. For user-level apps, pass the me value instead of the userId parameter. This operation makes an HTTP PATCH request to the /users/{userId} endpoint.

Scopes: user:write:admin user:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

x

Login type

Enumeration, one of:

j_0
j_1
j_11
j_21
j_23
j_24
j_27
j_97
j_98
j_99
j_100
j_101

The user’s login method:

* 0 - Facebook OAuth

* 1 - Google OAuth

* 24 - Apple OAuth

* 27 - Microsoft OAuth

* 97 - Mobile device

* 98 - RingCentral OAuth

* 99- API user

* 100 - Zoom Work email

* 101 - Single Sign-On (SSO)

The following login methods are available only in China:

* 11 - Phone number

* 21 - WeChat

* 23 - Alipay

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

User Vanity Name

<zoom-connector-mule-4:user-vanity-name>

A personal meeting room is a virtual meeting room that can be permanently assigned to a user. Use this API to check if a personal meeting room with the given name exists or not. This operation makes an HTTP GET request to the /users/vanity_name endpoint.

Scopes: user:read:admin user:read
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Vanity name

String

Personal meeting room name.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

User Zak

<zoom-connector-mule-4:user-zak>

Get a user’s Zoom Access Token (ZAK). You can use a ZAK to enable a non-login user to join a meeting on your app. Non-login users do not need to enter their username and password to join meetings. This operation makes an HTTP GET request to the /users/me/zak endpoint.

Scope: user_zak:read
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Users

<zoom-connector-mule-4:users>

A Zoom account can have one or more users. Use this API to list users on your account. This operation makes an HTTP GET request to the /users endpoint.

Scopes: user:read:admin
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

status

Enumeration, one of:

ACTIVE
INACTIVE
PENDING

User statuses:

* active

Users with an active status.

* inactive

Users who are deactivated.

* pending

Users with a pending status.

ACTIVE

Page size

Number

Number of records returned within a single API call.

30

Role ID

String

Unique identifier of the role. Provide this parameter if you would like to filter the response by a specific role. You can retrieve Role IDs from List Roles API.

Include fields

String

Provide a value for this field if you would like to see the following attribute in the response of this API call:

* custom_attributes

Returns custom attributes that are associated with the user. `

* host_key`

Returns host key of the user.

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Webinar

<zoom-connector-mule-4:webinar>

Zoom users with a Webinar Plan have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees. Use this API to get details of a scheduled webinar. This operation makes an HTTP GET request to the /webinars/{webinarId} endpoint.

Prerequisites: Pro or higher plan with a Webinar Add-on.
Scopes: webinar:read:admin webinar:read
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Webinar Id

Number

The webinar ID in the long format, which is represented as the int64 data type in JSON.

x

Occurrence ID

String

Unique Identifier that identifies an occurrence of a recurring webinar. Recurring webinars can have a maximum of 50 occurrences. When you create a recurring Webinar using Create a Webinar API, you can retrieve the Occurrence ID from the response of the API call.

Show previous occurrences

Boolean

Set the value of this field to true if you would like to view Webinar details of all previous occurrences of a recurring Webinar.

false

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Webinar Absentees

<zoom-connector-mule-4:webinar-absentees>

List absentees of a webinar. This operation makes an HTTP GET request to the /past_webinars/{WebinarUUID}/absentees endpoint.

Scopes: webinar:read:admin webinar:read
Rate Limit Label: Heavy

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Webinar UUID

String

The Webinar UUID. Each Webinar instance will generate its own Webinar UUID (i.e., after a Webinar ends, a new UUID will be generated for the next instance of the Webinar). Please double encode your UUID when using it for API calls if the UUID begins with a ''/'' or contains ''//'' in it.

x

Occurrence ID

String

The meeting occurrence ID.

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Webinar Create

<zoom-connector-mule-4:webinar-create>

Use this API to schedule a webinar for a user (host). For user-level apps, pass the me value instead of the userId parameter. Zoom users with a Webinar Plan have access to creating and managing webinars. Webinars allow a host to broadcast a Zoom meeting to up to 10,000 attendees. This operation makes an HTTP POST request to the /users/{userId}/webinars endpoint.

Prerequisites: Pro or higher plan with a Webinar add-on.
Scopes: webinar:write:admin, webinar:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Webinar Delete

<zoom-connector-mule-4:webinar-delete>

Delete a webinar. This operation makes an HTTP DELETE request to the /webinars/{webinarId} endpoint.

Prerequisites: Pro or higher plan with a Webinar Add-on.
Scopes: webinar:write:admin webinar:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Webinar Id

Number

The webinar ID in the long format, which is represented as the int64 data type in JSON.

x

Occurrence ID

String

The meeting occurrence ID.

Cancel webinar reminder

String

true: Notify panelists and registrants about the webinar cancellation via email. false: Do not send any email notification to webinar registrants and panelists. The default value of this field is false.

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Webinar Invite Links Create

<zoom-connector-mule-4:webinar-invite-links-create>

Use this API to create a batch of invitation links for a webinar. This operation makes an HTTP POST request to the /webinars/{webinarId}/invite_links endpoint.

Prerequisites: Business, Education, or API Plan with Webinar add-on.
Scopes: webinar:write:admin, webinar:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Webinar Id

Number

The webinar ID in the long format, which is represented as the int64 data type in JSON.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Webinar Live Stream Status Update

<zoom-connector-mule-4:webinar-live-stream-status-update>

Zoom allows users to live stream a webinar to a custom platform. Use this API to update the status of a webinar’s live stream. This operation makes an HTTP PATCH request to the /webinars/{webinarId}/livestream/status endpoint.

Prerequisites: Pro or higher plan with a Webinar Add-on. Live streaming details must have been configured for the webinar.
Scopes: webinar:write:admin webinar:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Webinar Id

Number

The webinar ID in the long format, which is represented as the int64 data type in JSON.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Webinar Live Stream Update

<zoom-connector-mule-4:webinar-live-stream-update>

Zoom allows users to live stream a webinar to a custom platform. Use this API to update a webinar’s live stream information. This operation makes an HTTP PATCH request to the /webinars/{webinarId}/livestream endpoint.

Prerequisites: Pro or higher plan with a Webinar Add-on. Live streaming details must have been configured for the webinar.
Scopes: webinar:write:admin webinar:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Webinar Id

Number

The webinar ID in the long format, which is represented as the int64 data type in JSON.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Webinar Panelist Create

<zoom-connector-mule-4:webinar-panelist-create>

Panelists in a webinar can view and send video, screen share, annotate, etc., and do much more compared to attendees in a webinar. Use this API to add panelists to a scheduled webinar. This operation makes an HTTP POST request to the /webinars/{webinarId}/panelists endpoint.

Prerequisites: Pro or a higher plan with Webinar Add-on.
Scopes: webinar:write:admin webinar:write
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Webinar Id

Number

The webinar ID in the long format, which is represented as the int64 data type in JSON.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Webinar Panelist Delete

<zoom-connector-mule-4:webinar-panelist-delete>

Remove a single panelist from a webinar. You can retrieve the panelistId by calling List Panelists API. This operation makes an HTTP DELETE request to the /webinars/{webinarId}/panelists/{panelistId} endpoint.

Prerequisites: Pro or a higher plan with Webinar Add-on.
Scopes: webinar:write:admin webinar:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Webinar Id

Number

The webinar ID in the long format, which is represented as the int64 data type in JSON.

x

Panelist Id

Number

The panelist ID or panelist email.

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Webinar Panelists

<zoom-connector-mule-4:webinar-panelists>

Panelists in a webinar can view and send video, screen share, annotate, etc., and do much more compared to attendees in a webinar. Use this API to list all the panelists of a webinar. This operation makes an HTTP GET request to the /webinars/{webinarId}/panelists endpoint.

Prerequisites: Pro or a higher plan with Webinar Add-on.
Scopes: webinar:read:admin webinar:read
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Webinar Id

Number

The webinar ID in the long format, which is represented as the int64 data type in JSON.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Webinar Panelists Delete

<zoom-connector-mule-4:webinar-panelists-delete>

Remove all the panelists from a Webinar. This operation makes an HTTP DELETE request to the /webinars/{webinarId}/panelists endpoint.

Prerequisites: Pro or a higher plan with Webinar Add-on.
Scopes: webinar:write:admin webinar:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Webinar Id

Number

The webinar ID in the long format, which is represented as the int64 data type in JSON.

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Webinar Poll Create

<zoom-connector-mule-4:webinar-poll-create>

Create a poll for a webinar. This operation makes an HTTP POST request to the /webinars/{webinarId}/polls endpoint.

Scopes: webinar:write:admin webinar:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Webinar Id

Number

The webinar ID in the long format, which is represented as the int64 data type in JSON.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Webinar Poll Delete

<zoom-connector-mule-4:webinar-poll-delete>

Delete a webinar’s poll. This operation makes an HTTP DELETE request to the /webinars/{webinarId}/polls/{pollId} endpoint.

Scopes: webinar:write:admin webinar:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Webinar Id

Number

The webinar ID in the long format, which is represented as the int64 data type in JSON.

x

Poll Id

String

The poll 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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Webinar Poll Get

<zoom-connector-mule-4:webinar-poll-get>

Get a webinar’s poll details. This operation makes an HTTP GET request to the /webinars/{webinarId}/polls/{pollId} endpoint.

Scopes: webinar:read:admin webinar:read
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Webinar Id

Number

The webinar ID in the long format, which is represented as the int64 data type in JSON.

x

Poll Id

String

The poll ID.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Webinar Poll Update

<zoom-connector-mule-4:webinar-poll-update>

Update a webinar’s poll. This operation makes an HTTP PUT request to the /webinars/{webinarId}/polls/{pollId} endpoint.

Scopes: webinar:write:admin webinar:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Webinar Id

Number

The webinar ID in the long format, which is represented as the int64 data type in JSON.

x

Poll Id

String

The poll 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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Webinar Polls

<zoom-connector-mule-4:webinar-polls>

List all the polls of a webinar. This operation makes an HTTP GET request to the /webinars/{webinarId}/polls endpoint.

Scopes: webinar:read:admin webinar:read
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Webinar Id

Number

The webinar ID in the long format, which is represented as the int64 data type in JSON.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Webinar Registrant Create

<zoom-connector-mule-4:webinar-registrant-create>

Zoom users with a Webinar Plan have access to creating and managing webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a Webinar with registration requires your registrants to complete a brief form before receiving the link to join the Webinar. Use this API to create and submit the registration of a user for a webinar. This operation makes an HTTP POST request to the /webinars/{webinarId}/registrants endpoint.

Prerequisites: Pro or higher plan with a Webinar Add-on.
Scopes: webinar:write:admin webinar:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Webinar Id

Number

The webinar ID in the long format, which is represented as the int64 data type in JSON.

x

Occurrence ids

String

Occurrence ID. Get this value from the webinar get API. Multiple values separated by a comma.

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Webinar Registrant Get

<zoom-connector-mule-4:webinar-registrant-get>

Zoom users with a Webinar Plan have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a Webinar with registration requires your registrants to complete a brief form before receiving the link to join the Webinar. Use this API to get details on a specific user who has registered for the Webinar. This operation makes an HTTP GET request to the /webinars/{webinarId}/registrants/{registrantId} endpoint.

Prerequisites: The account must have a Webinar plan.
Scopes: webinar:read:admin webinar:read
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Webinar Id

Number

The webinar ID in the long format, which is represented as the int64 data type in JSON.

x

Registrant Id

String

The registrant ID.

x

Occurrence ID

String

The meeting occurrence ID.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Webinar Registrant Question Update

<zoom-connector-mule-4:webinar-registrant-question-update>

Scheduling a Webinar with registration requires your registrants to complete a brief form with fields and questions before they can receive the link to join the webinar. Use this API to update registration questions and fields of a scheduled webinar that are to be answered by users while registering for a webinar. This operation makes an HTTP PATCH request to the /webinars/{webinarId}/registrants/questions endpoint.

Prerequisites: Pro or higher plan with a Webinar Add-on. Registration option for the webinar should be set as required to use this API.
Scopes: webinar:write:admin webinar:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Webinar Id

Number

The webinar ID in the long format, which is represented as the int64 data type in JSON.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Webinar Registrant Status

<zoom-connector-mule-4:webinar-registrant-status>

Update a webinar registrant’s status. Using this API, you can specify whether you want to approve a registration, deny a registration or cancel a previously approved registration. This operation makes an HTTP PUT request to the /webinars/{webinarId}/registrants/status endpoint.

Scopes: webinar:write:admin webinar:write
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Webinar Id

Number

The webinar ID in the long format, which is represented as the int64 data type in JSON.

x

Occurrence ID

String

The meeting occurrence ID.

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Webinar Registrants

<zoom-connector-mule-4:webinar-registrants>

Zoom users with a Webinar Plan have access to creating and managing webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a Webinar with registration requires your registrants to complete a brief form before receiving the link to join the Webinar. Use this API to list all the users that have registered for a webinar. This operation makes an HTTP GET request to the /webinars/{webinarId}/registrants endpoint.

Prerequisites: Pro or higher plan with a Webinar Add-on.
Scopes: webinar:read:admin webinar:read
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Webinar Id

Number

The webinar ID in the long format, which is represented as the int64 data type in JSON.

x

Occurrence ID

String

The meeting occurrence ID.

status

Enumeration, one of:

PENDING
APPROVED
DENIED

The registrant status: pending - Registrant’s status is pending. approved - Registrant’s status is approved. denied - Registrant’s status is denied.

APPROVED

Tracking source ID

String

The tracking source ID for the registrants. Useful if you share the webinar registration page in multiple locations. See Creating source tracking links for webinar registration for details.

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Webinar Registrants Questions Get

<zoom-connector-mule-4:webinar-registrants-questions-get>

Scheduling a Webinar with registration requires your registrants to complete a brief form with fields and questions before they can receive the link to join the Webinar. Use this API to list registration questions and fields that are to be answered by users while registering for a webinar. This operation makes an HTTP GET request to the /webinars/{webinarId}/registrants/questions endpoint.

Prerequisites: Pro or higher plan with a Webinar Add-on.
Scopes: webinar:read:admin webinar:read
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Webinar Id

Number

The webinar ID in the long format, which is represented as the int64 data type in JSON.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Webinar Status

<zoom-connector-mule-4:webinar-status>

Update a webinar’s status. Use this API to end an ongoing webinar. This operation makes an HTTP PUT request to the /webinars/{webinarId}/status endpoint.

Prerequisites: The account must hold a valid Webinar Plan.
Scopes: webinar:write:admin webinar:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Webinar Id

Number

The webinar ID in the long format, which is represented as the int64 data type in JSON.

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Webinar Update

<zoom-connector-mule-4:webinar-update>

Zoom users with a Webinar Plan have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees. Use this API to make updates to a scheduled webinar. This operation makes an HTTP PATCH request to the /webinars/{webinarId} endpoint.

Prerequisites: Pro or higher plan with a Webinar Add-on.
Scopes: webinar:write:admin webinar:write
Rate Limit Label: Light

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Webinar Id

Number

The webinar ID in the long format, which is represented as the int64 data type in JSON.

x

Occurrence ID

String

Webinar occurrence ID. Support change of agenda, start_time, duration, settings: {host_video, panelist_video, hd_video, watermark, auto_recording}.

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:RETRY_EXHAUSTED
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Webinars

<zoom-connector-mule-4:webinars>

Use this API to list all the webinars that are scheduled by or on behalf a user (webinar host). For user-level apps, pass the me value instead of the userId parameter. Zoom users with a Webinar Plan have access to creating and managing webinars. Webinars allow a host to broadcast a Zoom meeting to up to 10,000 attendees. This operation makes an HTTP GET request to the /users/{userId}/webinars endpoint.

Prerequisites: Pro or higher plan with a Webinar Add-on.
Scopes: webinar:read:admin, webinar:read
Rate Limit Label: Medium

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

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

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type	Array of Any

For Configurations

Zoom Connector Configuration

Throws

ZOOM-CONNECTOR-MULE-4:BAD_REQUEST
ZOOM-CONNECTOR-MULE-4:CLIENT_ERROR
ZOOM-CONNECTOR-MULE-4:CONNECTIVITY
ZOOM-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:NOT_ACCEPTABLE
ZOOM-CONNECTOR-MULE-4:NOT_FOUND
ZOOM-CONNECTOR-MULE-4:SERVER_ERROR
ZOOM-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
ZOOM-CONNECTOR-MULE-4:TIMEOUT
ZOOM-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
ZOOM-CONNECTOR-MULE-4:UNAUTHORIZED
ZOOM-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE

Sources

On New Meeting Trigger

<zoom-connector-mule-4:on-new-meeting-trigger>

Parameters

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

User Id

String

The user ID or email address of the user. For user-level apps, pass me as the value for this field.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in a cluster.

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling.

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

On New Registrant Trigger

<zoom-connector-mule-4:on-new-registrant-trigger>

Parameters

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

Webinar Id

String

The webinar ID.

x

Status

String

The registrant status - pending, approved, or denied.

approved

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in a cluster.

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling.

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

Reconnect
Reconnect Forever

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Zoom Connector Configuration

Types

Default Header

Field

Type

Description

Default Value

Required

Key

String

Key for this type.

x

Value

String

Value for this type.

x

Default Query Param

Field

Type

Description

Default Value

Required

Key

String

Key for this type.

x

Value

String

Value for this type.

x

Proxy

Configures the settings used to connect through a proxy.

Field

Type

Description

Default Value

Required

Host

String

Hostname or IP address of the proxy server.

x

Port

Number

Port of the proxy server.

x

Username

String

Username to authenticate against the proxy server.

Password

String

Password to authenticate against the proxy server.

Non Proxy Hosts

String

TLS

Configures TLS to provide secure communications for the Mule app.

Field

Type

Description

Default Value

Required

Enabled Protocols

String

Comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

Comma-separated list of cipher suites enabled for this context.

Trust Store

Truststore

Configures the TLS truststore.

Key Store

Keystore

Configures the TLS keystore.

Revocation Check

Standard Revocation Check
Custom OCSP Responder
CRL File

Configures a revocation checking mechanism.

Truststore

Configures the truststore for TLS.

Field Type Description Default Value Required

Path

String

Path to the truststore. Mule resolves the path relative to the current classpath and file system, if possible.

Password

String

Password used to protect the truststore.

Type

String

Type of truststore.

Algorithm

String

Encryption algorithm that the truststore uses.

Insecure

Boolean

If true, Mule stops performing certificate validations. Setting this to true can make connections vulnerable to attacks.

Keystore

Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.

Field

Type

Description

Default Value

Required

Path

String

Path to the keystore. Mule resolves the path relative to the current classpath and file system, if possible.

Type

String

Type of store used.

Alias

String

Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.

Key Password

String

Password used to protect the private key.

Password

String

Password used to protect the keystore.

Algorithm

String

Encryption algorithm that the keystore uses.

Standard Revocation Check

Configures standard revocation checks for TLS certificates.

Field Type Description Default Value Required

Only End Entities

Boolean

Which elements to verify in the certificate chain:

true

Verify only the last element in the certificate chain.

false

Verify all elements in the certificate chain.

Prefer Crls

Boolean

How to check certificate validity:

true

Check the Certification Revocation List (CRL) for certificate validity.

false

Use the Online Certificate Status Protocol (OCSP) to check certificate validity.

No Fallback

Boolean

Whether to use the secondary method to check certificate validity:

true

Use the method that wasn’t specified in the Prefer Crls field (the secondary method) to check certificate validity.

false

Do not use the secondary method to check certificate validity.

Soft Fail

Boolean

What to do if the revocation server can’t be reached or is busy:

true

Avoid verification failure.

false

Allow the verification to fail.

Custom OCSP Responder

Configures a custom OCSP responder for certification revocation checks.

Field

Type

Description

Default Value

Required

Url

String

URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.

CRL File

Specifies the location of the certification revocation list (CRL) file.

Field

Type

Description

Default Value

Required

Path

String

Path to the CRL file.

Reconnection

Configures a reconnection strategy for an operation.

Field Type Description Default Value Required

Fails Deployment

Boolean

What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:

true

Allow the deployment to fail.

false

Ignore the results of the connectivity test.

Reconnection Strategy

Reconnect
Reconnect Forever

Reconnection strategy to use.

Reconnect

Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread.

Count

Number

How many reconnection attempts the Mule app can make.

Reconnect Forever

Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread.

Expiration Policy

Field

Type

Description

Default Value

Required

Max Idle Time

Number

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

Time Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Time unit for the Max Idle Time field.

HTTP Response Attributes

Field

Type

Description

Default Value

Required

Status Code

Number

x

Headers

Object

x

Reason Phrase

String

x

Repeatable In Memory Stream

Configures the in-memory streaming strategy by which the request fails if the data exceeds the MAX buffer size. Always run performance tests to find the optimal buffer size for your specific use case.

Field Type Description Default Value Required

Initial Buffer Size

Number

Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value.

Buffer Size Increment

Number

Amount by which the buffer size expands if it exceeds its initial size. Setting a value of 0 or lower specifies that the buffer can’t expand.

Max Buffer Size

Number

Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a STREAM_MAXIMUM_SIZE_EXCEEDED error. A value of less than or equal to 0 means no limit.

Buffer Unit

Enumeration, one of:

BYTE
KB
MB
GB

Unit for the Initial Buffer Size, Buffer Size Increment, and Buffer Unit fields.

Repeatable File Store Stream

Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream content in memory. If the stream content is larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.

Field

Type

Description

Default Value

Required

In Memory Size

Number

Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:

Configure a larger buffer size to avoid the number of times Mule needs to write the buffer on disk. This increases performance, but it also limits the number of concurrent requests your application can process, because it requires additional memory.
Configure a smaller buffer size to decrease memory load at the expense of response time.

Buffer Unit

Enumeration, one of:

BYTE
KB
MB
GB

Unit for the In Memory Size field.

Redelivery Policy

Configures the redelivery policy for executing requests that generate errors. You can add a redelivery policy to any source in a flow.

Field Type Description Default Value Required

Max Redelivery Count

Number

Maximum number of times that a redelivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error.

Message Digest Algorithm

String

Secure hashing algorithm to use if the Use Secure Hash field is true. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s hashCode() returned.

Message Identifier

Redelivery Policy Message Identifier

Defines which strategy is used to identify the messages.

Object Store

ObjectStore

Configures the object store that stores the redelivery counter for each message.

Redelivery Policy Message Identifier

Configures how to identify a redelivered message and how to find out when the message was redelivered.

Field Type Description Default Value Required

Use Secure Hash

Boolean

If true, Mule uses a secure hash algorithm to identify a redelivered message.

Id Expression

String

One or more expressions that determine when a message was redelivered. You can set this property only if the Use Secure Hash field is false.

Repeatable In Memory Iterable

Field

Type

Description

Default Value

Required

Initial Buffer Size

Number

The number of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

100

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.

100

Max Buffer Size

Number

The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

Repeatable File Store Iterable

Field

Type

Description

Default Value

Required

In Memory Objects

Number

The maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.

Buffer Unit

Enumeration, one of:

BYTE
KB
MB
GB

Unit for the In Memory Objects field.