Zoom

PATCH

/accounts/{accountId}/options

Update a sub account's options under the master account

Request

Path

Name	Data Type	Description
`accountId`	string	The account ID

Body

Name	Data Type	Description
`AccountOptions`	object	Account options object

Properties

`share_rc`	boolean Default value: `false`	Enable Share Virtual Room Connector.
`share_mc`	boolean Default value: `false`	Enable Share Meeting Connector.
`room_connectors`	string	Virtual Room Connector, multiple value separated by comma.
`pay_mode`	string Default value: `master` Allowed values: - `master` - `sub`	Payee
`meeting_connectors`	string	Meeting Connector, multiple value separated by comma.

Responses

204Account options updated

404Account not found

GET

/accounts/{accountId}/settings

Retrieve a sub account's settings under the master account

Request

Path

Name	Data Type	Description
`accountId`	string	The account ID

Responses

200Account settings returned

Body

Name	Data Type	Description
`Account settings`	object

Properties

zoom_rooms AccountSettingsZoomRooms


                        AccountSettingsZoomRooms

object

Account Settings: Zoom Rooms

Properties

`zr_post_meeting_feedback`	boolean	Zoom Room post meeting feedback
`weekly_system_restart`	boolean	Weekly system restart
`upcoming_meeting_alert`	boolean	Upcoming meeting alert
`ultrasonic`	boolean	Automatic direct sharing using ultrasonic proximity signal
`start_airplay_manually`	boolean	Start AirPlay service manually
`list_meetings_with_calendar`	boolean	Display meeting list with calendar integration
`hide_host_information`	boolean	Hide host and meeting ID from private meetings
`force_private_meeting`	boolean	Transform all meetings to private
`cmr_for_instant_meeting`	boolean	Cloud recording for instant meetings
`auto_start_stop_scheduled_meetings`	boolean	Automatic start/stop scheduled meetings

telephony AccountSettingsTelephony


                        AccountSettingsTelephony

object

Account Settings: Telephony

Properties

`third_party_audio`	boolean	3rd party audio conference
`audio_conference_info`	string	3rd party audio conference info

security AccountSettingsSecurity


                        AccountSettingsSecurity

object

Account Settings: Security

Properties

`import_photos_from_devices`	boolean	Allow importing of photos from photo library on the user's device
`hide_billing_info`	boolean	Hide billing information
`admin_change_name_pic`	boolean	Only account administrators can change user's username and picture

schedule_meting AccountSettingsScheduleMeeting


                        AccountSettingsScheduleMeeting

object

Account Settings: Schedule Meeting

Properties

`participant_video`	boolean	Participants Video
`not_store_meeting_topic`	boolean	Always display "Zoom Meeting" as the meeting topic
`join_before_host`	boolean	Join Before Host
`host_video`	boolean	Host Video
`force_pmi_jbh_password`	boolean	Require a password for Personal Meetings if attendees can join before host
`enforce_login_with_domains`	boolean	Only signed-in users with a specified domains can join meetings
`enforce_login_domains`	string	Only signed-in users with a specified domains
`enforce_login`	boolean	Only signed-in users can join meetings
`audio_type`	string Default value: `both` Allowed values: - `both` - `telephony` - `voip` - `thirdParty`	Audio Type

recording AccountSettingsRecording


                        AccountSettingsRecording

object

Account Settings: Recording

Properties

`show_timestamp`	boolean	Show timestamp on video
`save_chat_text`	boolean	Save chat text from the meeting
`recording_audio_transcript`	boolean	Audio transcript
`record_speaker_view`	boolean	Record the active speaker view
`record_gallery_view`	boolean	Record the gallery view
`record_audio_file`	boolean	Record an audio only file
`local_recording`	boolean	Local recording
`cloud_recording_download_host`	boolean	Only the host can download cloud recordings
`cloud_recording_download`	boolean	Cloud Recording Downloads
`cloud_recording`	boolean	Cloud recording
`auto_recording`	string Allowed values: - `local` - `cloud` - `none`	Automatic recording
`auto_delete_cmr_days`	integer	A specified number of days of auto delete cloud recordings
`auto_delete_cmr`	boolean	Auto delete cloud recordings after days
`account_user_access_recording`	boolean	Only users on my account can access cloud recordings

integration AccountSettingsIntegration


                        AccountSettingsIntegration

object

Account Settings: Integration

Properties

`microsoft_one_drive`	boolean	Microsoft OneDrive
`kubi`	boolean	Kubi
`google_drive`	boolean	Google Drive
`google_calendar`	boolean	Google Calendar
`dropbox`	boolean	Dropbox
`box`	boolean	Box

in_meeting AccountSettingsInMeeting


                        AccountSettingsInMeeting

object

Account Settings: In Meeting

Properties

`whiteboard`	boolean	Whiteboard
`webinar_question_answer`	boolean	Q&A in webinar
`watermark`	boolean	Add watermark when viewing shared screen
`virtual_background`	boolean	Virtual background
`use_html_format_email`	boolean	Use HTML format email for Outlook plugin
`stereo_audio`	boolean	Allow users to select stereo audio in their client settings
`show_meeting_control_toolbar`	boolean	Always show meeting control toolbar
`sending_default_email_invites`	boolean	Only show default email when sending email invites
`screen_sharing`	boolean	Screen sharing
`remote_control`	boolean	Remote control
`private_chat`	boolean	Private Chat
`post_meeting_feedback`	boolean	Display end-of-meeting experience feedback survey
`ports_range`	string Default value:	Listening ports range, separated by comma (ex 55,56). The ports range is between 1 to 65535
`polling`	boolean	Polling
`p2p_ports`	boolean	Listening ports range
`p2p_connetion`	boolean	Peer to Peer connection while only 2 people in a meeting
`original_audio`	boolean	Allow users to select original sound in their client settings
`group_hd`	boolean	Group HD video
`file_transfer`	boolean	File transfer
`feedback`	boolean	Feedback to Zoom
`far_end_camera_control`	boolean	Far end camera control
`e2e_encryption`	boolean	End-to-End Encryption
`dscp_video`	integer Minimum: 1 Maximum: 63	DSCP Video
`dscp_marking`	boolean	DSCP marking
`dscp_audio`	integer Minimum: 1 Maximum: 63	DSCP Audio
`co_host`	boolean	Co-Host
`closed_caption`	boolean	Closed caption
`chat`	boolean	Chat
`breakout_room`	boolean	Breakout room
`auto_saving_chat`	boolean	Auto Saving Chats
`auto_answer`	boolean	Enable Auto Answer Group
`attention_tracking`	boolean	Attention tracking
`attendee_on_hold`	boolean	Allow host to put attendee on hold
`anonymous_question_answer`	boolean	Allow Anonymous Q&A in Webinar
`annotation`	boolean	Annotation
`allow_show_zoom_windows`	boolean	Allow to share Zoom windows in desktop sharing
`alert_guest_join`	boolean	Identify guest participants in the meeting/webinar

feature AccountSettingsFeature


                        AccountSettingsFeature

object

Account Settings: Feature

Properties


                        meeting_capacity

integer
Default value: 100

Meeting capacity

email_notification AccountSettingsEmailNotification


                        AccountSettingsEmailNotification

object

Account Settings: Notification

Properties

`low_host_count_reminder`	boolean	When host licenses are running low
`jbh_reminder`	boolean	When attendees join meeting before host
`cloud_recording_avaliable_reminder`	boolean	Allow keep recording from being automatically deleted
`cancel_meeting_reminder`	boolean	When a meeting is cancelled
`alternative_host_reminder`	boolean	When an alternative host is set or removed from a meeting

404Account not found

PATCH

/accounts/{accountId}/settings

Update a sub account's settings under the master account

Request

Path

Name	Data Type	Description
`accountId`	string	The account ID

Body

Name	Data Type	Description
`Account settings`	object

Properties

zoom_rooms AccountSettingsZoomRooms


                        AccountSettingsZoomRooms

object

Account Settings: Zoom Rooms

Properties

`zr_post_meeting_feedback`	boolean	Zoom Room post meeting feedback
`weekly_system_restart`	boolean	Weekly system restart
`upcoming_meeting_alert`	boolean	Upcoming meeting alert
`ultrasonic`	boolean	Automatic direct sharing using ultrasonic proximity signal
`start_airplay_manually`	boolean	Start AirPlay service manually
`list_meetings_with_calendar`	boolean	Display meeting list with calendar integration
`hide_host_information`	boolean	Hide host and meeting ID from private meetings
`force_private_meeting`	boolean	Transform all meetings to private
`cmr_for_instant_meeting`	boolean	Cloud recording for instant meetings
`auto_start_stop_scheduled_meetings`	boolean	Automatic start/stop scheduled meetings

telephony AccountSettingsTelephony


                        AccountSettingsTelephony

object

Account Settings: Telephony

Properties

`third_party_audio`	boolean	3rd party audio conference
`audio_conference_info`	string	3rd party audio conference info

security AccountSettingsSecurity


                        AccountSettingsSecurity

object

Account Settings: Security

Properties

`import_photos_from_devices`	boolean	Allow importing of photos from photo library on the user's device
`hide_billing_info`	boolean	Hide billing information
`admin_change_name_pic`	boolean	Only account administrators can change user's username and picture

schedule_meting AccountSettingsScheduleMeeting


                        AccountSettingsScheduleMeeting

object

Account Settings: Schedule Meeting

Properties

`participant_video`	boolean	Participants Video
`not_store_meeting_topic`	boolean	Always display "Zoom Meeting" as the meeting topic
`join_before_host`	boolean	Join Before Host
`host_video`	boolean	Host Video
`force_pmi_jbh_password`	boolean	Require a password for Personal Meetings if attendees can join before host
`enforce_login_with_domains`	boolean	Only signed-in users with a specified domains can join meetings
`enforce_login_domains`	string	Only signed-in users with a specified domains
`enforce_login`	boolean	Only signed-in users can join meetings
`audio_type`	string Default value: `both` Allowed values: - `both` - `telephony` - `voip` - `thirdParty`	Audio Type

recording AccountSettingsRecording


                        AccountSettingsRecording

object

Account Settings: Recording

Properties

`show_timestamp`	boolean	Show timestamp on video
`save_chat_text`	boolean	Save chat text from the meeting
`recording_audio_transcript`	boolean	Audio transcript
`record_speaker_view`	boolean	Record the active speaker view
`record_gallery_view`	boolean	Record the gallery view
`record_audio_file`	boolean	Record an audio only file
`local_recording`	boolean	Local recording
`cloud_recording_download_host`	boolean	Only the host can download cloud recordings
`cloud_recording_download`	boolean	Cloud Recording Downloads
`cloud_recording`	boolean	Cloud recording
`auto_recording`	string Allowed values: - `local` - `cloud` - `none`	Automatic recording
`auto_delete_cmr_days`	integer	A specified number of days of auto delete cloud recordings
`auto_delete_cmr`	boolean	Auto delete cloud recordings after days
`account_user_access_recording`	boolean	Only users on my account can access cloud recordings

integration AccountSettingsIntegration


                        AccountSettingsIntegration

object

Account Settings: Integration

Properties

`microsoft_one_drive`	boolean	Microsoft OneDrive
`kubi`	boolean	Kubi
`google_drive`	boolean	Google Drive
`google_calendar`	boolean	Google Calendar
`dropbox`	boolean	Dropbox
`box`	boolean	Box

in_meeting AccountSettingsInMeeting


                        AccountSettingsInMeeting

object

Account Settings: In Meeting

Properties

`whiteboard`	boolean	Whiteboard
`webinar_question_answer`	boolean	Q&A in webinar
`watermark`	boolean	Add watermark when viewing shared screen
`virtual_background`	boolean	Virtual background
`use_html_format_email`	boolean	Use HTML format email for Outlook plugin
`stereo_audio`	boolean	Allow users to select stereo audio in their client settings
`show_meeting_control_toolbar`	boolean	Always show meeting control toolbar
`sending_default_email_invites`	boolean	Only show default email when sending email invites
`screen_sharing`	boolean	Screen sharing
`remote_control`	boolean	Remote control
`private_chat`	boolean	Private Chat
`post_meeting_feedback`	boolean	Display end-of-meeting experience feedback survey
`ports_range`	string Default value:	Listening ports range, separated by comma (ex 55,56). The ports range is between 1 to 65535
`polling`	boolean	Polling
`p2p_ports`	boolean	Listening ports range
`p2p_connetion`	boolean	Peer to Peer connection while only 2 people in a meeting
`original_audio`	boolean	Allow users to select original sound in their client settings
`group_hd`	boolean	Group HD video
`file_transfer`	boolean	File transfer
`feedback`	boolean	Feedback to Zoom
`far_end_camera_control`	boolean	Far end camera control
`e2e_encryption`	boolean	End-to-End Encryption
`dscp_video`	integer Minimum: 1 Maximum: 63	DSCP Video
`dscp_marking`	boolean	DSCP marking
`dscp_audio`	integer Minimum: 1 Maximum: 63	DSCP Audio
`co_host`	boolean	Co-Host
`closed_caption`	boolean	Closed caption
`chat`	boolean	Chat
`breakout_room`	boolean	Breakout room
`auto_saving_chat`	boolean	Auto Saving Chats
`auto_answer`	boolean	Enable Auto Answer Group
`attention_tracking`	boolean	Attention tracking
`attendee_on_hold`	boolean	Allow host to put attendee on hold
`anonymous_question_answer`	boolean	Allow Anonymous Q&A in Webinar
`annotation`	boolean	Annotation
`allow_show_zoom_windows`	boolean	Allow to share Zoom windows in desktop sharing
`alert_guest_join`	boolean	Identify guest participants in the meeting/webinar

feature AccountSettingsFeature


                        AccountSettingsFeature

object

Account Settings: Feature

Properties


                        meeting_capacity

integer
Default value: 100

Meeting capacity

email_notification AccountSettingsEmailNotification


                        AccountSettingsEmailNotification

object

Account Settings: Notification

Properties

`low_host_count_reminder`	boolean	When host licenses are running low
`jbh_reminder`	boolean	When attendees join meeting before host
`cloud_recording_avaliable_reminder`	boolean	Allow keep recording from being automatically deleted
`cancel_meeting_reminder`	boolean	When a meeting is cancelled
`alternative_host_reminder`	boolean	When an alternative host is set or removed from a meeting

Responses

204Account settings updated

404Account not found

DELETE

/accounts/{accountId}

GET

/accounts/{accountId}

Retrieve a sub account under the master account

Request

Path

Name	Data Type	Description
`accountId`	string	The account ID

Responses

200Account object returned

Body

Name	Data Type	Description
`body`

Properties


                        owner_id

string

Account Owner ID


                        owner_email

string

Account Owner email

options AccountOptions


                        AccountOptions

object

Account options object

Properties

`share_rc`	boolean Default value: `false`	Enable Share Virtual Room Connector.
`share_mc`	boolean Default value: `false`	Enable Share Meeting Connector.
`room_connectors`	string	Virtual Room Connector, multiple value separated by comma.
`pay_mode`	string Default value: `master` Allowed values: - `master` - `sub`	Payee
`meeting_connectors`	string	Meeting Connector, multiple value separated by comma.

id

string

Account ID


                        created_at

dateTime

Account creation date/time

404User not found

GET

/accounts

List all the sub accounts under the master account.

Request

Query

Name	Data Type	Description
`page_number`	integer Default value: `1`	Current page number of returned records.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.

Responses

200Account list returned

Body

Name	Data Type	Description
`Account List`	object	List of Accounts

Properties

`accounts`	array []	List of Account objects.
`total_records`	integer	The number of all records available across pages.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`page_number`	integer Default value: `1`	The page number of current results.
`page_count`	integer	The number of items returned on this page.

Extends

AccountListItem

Account object in account list

Properties

Name	Data Type	Description
`accounts`	array []	List of Account objects.

Pagination

Pagination Object

Properties

Name	Data Type	Description
`total_records`	integer	The number of all records available across pages.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`page_number`	integer Default value: `1`	The page number of current results.
`page_count`	integer	The number of items returned on this page.

POST

/accounts

Create a sub account under the master account

Request

Body

Name	Data Type	Description
`Account`	object	The account object represents an account on zoom. The person who created the account, or who the account was created for, is referred to as the Account owner. You can read more about the Zoom account structure here.

Properties


                        password

string

User's password.

options AccountOptions


                        AccountOptions

object

Account options object

Properties

`share_rc`	boolean Default value: `false`	Enable Share Virtual Room Connector.
`share_mc`	boolean Default value: `false`	Enable Share Meeting Connector.
`room_connectors`	string	Virtual Room Connector, multiple value separated by comma.
`pay_mode`	string Default value: `master` Allowed values: - `master` - `sub`	Payee
`meeting_connectors`	string	Meeting Connector, multiple value separated by comma.


                        last_name

string

User's last name.


                        first_name

string

User's first name.


                        email

string

User's email address.

Responses

201Account Created

Header

Name	Data Type	Description
`Content-Location`	string	Location of created Account

Body

Name	Data Type	Description
`body`

Properties

`owner_id`	string	Account Owner ID
`owner_email`	string	Account owner email
`id`	string	Account ID
`created_at`	string	Account created date time

409Account with that email already exists

GET

/accounts/{accountId}/billing

Retrieve billing information for a sub account under the master account

Request

Path

Name	Data Type	Description
`accountId`	string	The account ID

Responses

200Account billing contact information returned

Body

Name	Data Type	Description
`BillingContactRequired`	object	Billing Contact object

Properties

`zip`	string	Billing Contact's zip/postal code.
`state`	string	Billing Contact's state.
`phone_number`	string	Billing Contact's phone number.
`last_name`	string	Billing Contact's last name.
`first_name`	string	Billing Contact's first name.
`email`	string	Billing Contact's email address.
`country`	string	Billing Contact's country.
`city`	string	Billing Contact's city.
`apt`	string	Billing Contact's apartment/suite.
`address`	string	Billing Contact's address.

404Account not found

PATCH

/accounts/{accountId}/billing

Update billing information for a sub account under the master account

Request

Path

Name	Data Type	Description
`accountId`	string	The account ID

Body

Name	Data Type	Description
`BillingContact`	object	Billing Contact object

Properties

`zip`	string	Billing Contact's zip/postal code.
`state`	string	Billing Contact's state.
`phone_number`	string	Billing Contact's phone number.
`last_name`	string	Billing Contact's last name.
`first_name`	string	Billing Contact's first name.
`email`	string	Billing Contact's email address.
`country`	string	Billing Contact's country.
`city`	string	Billing Contact's city.
`apt`	string	Billing Contact's apartment/suite.
`address`	string	Billing Contact's address.

Responses

204Account billing contact information updated

404Account not found

POST

/accounts/{accountId}/plans/addons

Add an additional plan for sub account

Request

Path

Name	Data Type	Description
`accountId`	string	The account ID

Body

Name	Data Type	Description
`AccountPlanRequired`	object	Account plan object

Properties

`type`	string	Account plan type
`hosts`	integer	Account plan number of hosts.

Responses

201Account plans updated

PUT

/accounts/{accountId}/plans/addons

Update an additional plan for sub account

Request

Path

Name	Data Type	Description
`accountId`	string	The account ID

Body

Name	Data Type	Description
`AccountPlanRequired`	object	Account plan object

Properties

`type`	string	Account plan type
`hosts`	integer	Account plan number of hosts.

Responses

204Account plans updated

PUT

/accounts/{accountId}/plans/base

Update a base plan for a sub account

Request

Path

Name	Data Type	Description
`accountId`	string	The account ID

Body

Name	Data Type	Description
`AccountPlanBaseRequired`	object	Account base plan object

Properties

`type`	string	Account base plan type
`hosts`	integer	Account base plan number of hosts. For a Pro Plan, please select a value between 1 and 9. For a Business Plan, please select a value between 10 and 49. For a Education Plan, please select a value between 20 and 149. For a Free Trial Plan, please select a value between 1 and 9999.

Responses

204Account plans updated

GET

/accounts/{accountId}/plans

Retrieve plan information for a sub account under the master account

Request

Path

Name	Data Type	Description
`accountId`	string	The account ID

Responses

200Account plans returned

Body

Name	Data Type	Description
`AccountPlans`	object	Account Plans object

Properties

plan_zoom_rooms AccountPlan


                        AccountPlan

object

Account plan object

Properties

`type`	string	Account plan type
`hosts`	integer	Account plan number of hosts


                        plan_webinar

array [AccountPlan]

Additional Webinar Plans


                        AccountPlan

object

Account plan object

Properties

`type`	string	Account plan type
`hosts`	integer	Account plan number of hosts

plan_room_connector AccountPlan


                        AccountPlan

object

Account plan object

Properties

`type`	string	Account plan type
`hosts`	integer	Account plan number of hosts


                        plan_recording

string

Additional Cloud Recording Plan


                        plan_large_meeting

array [AccountPlan]

Additional Large Meeting Plans


                        AccountPlan

object

Account plan object

Properties

`type`	string	Account plan type
`hosts`	integer	Account plan number of hosts

plan_base AccountPlanBaseRequired


                        AccountPlanBaseRequired

object

Account base plan object

Properties

`type`	string	Account base plan type
`hosts`	integer	Account base plan number of hosts. For a Pro Plan, please select a value between 1 and 9. For a Business Plan, please select a value between 10 and 49. For a Education Plan, please select a value between 20 and 149. For a Free Trial Plan, please select a value between 1 and 9999.

plan_audio

404Account not fond

POST

/accounts/{accountId}/plans

Subscribe plans for a sub account of the master account

Request

Path

Name	Data Type	Description
`accountId`	string	The account ID

Body

Name	Data Type	Description
`body`	object

Properties

plan_zoom_rooms AccountPlan


                        AccountPlan

object

Account plan object

Properties

`type`	string	Account plan type
`hosts`	integer	Account plan number of hosts


                        plan_webinar

array [AccountPlan]

Additional Webinar Plans


                        AccountPlan

object

Account plan object

Properties

`type`	string	Account plan type
`hosts`	integer	Account plan number of hosts

plan_room_connector AccountPlan


                        AccountPlan

object

Account plan object

Properties

`type`	string	Account plan type
`hosts`	integer	Account plan number of hosts


                        plan_recording

string

Additional Cloud Recording Plan


                        plan_large_meeting

array [AccountPlan]

Additional Large Meeting Plans


                        AccountPlan

object

Account plan object

Properties

`type`	string	Account plan type
`hosts`	integer	Account plan number of hosts

plan_base AccountPlanBaseRequired


                        AccountPlanBaseRequired

object

Account base plan object

Properties

`type`	string	Account base plan type
`hosts`	integer	Account base plan number of hosts. For a Pro Plan, please select a value between 1 and 9. For a Business Plan, please select a value between 10 and 49. For a Education Plan, please select a value between 20 and 149. For a Free Trial Plan, please select a value between 1 and 9999.

plan_audio

contact BillingContactRequired


                        BillingContactRequired

object

Billing Contact object

Properties

`zip`	string	Billing Contact's zip/postal code.
`state`	string	Billing Contact's state.
`phone_number`	string	Billing Contact's phone number.
`last_name`	string	Billing Contact's last name.
`first_name`	string	Billing Contact's first name.
`email`	string	Billing Contact's email address.
`country`	string	Billing Contact's country.
`city`	string	Billing Contact's city.
`apt`	string	Billing Contact's apartment/suite.
`address`	string	Billing Contact's address.

Extends

AccountPlans

Account Plans object

Properties

Name Data Type Description

plan_zoom_rooms AccountPlan


                        AccountPlan

object

Account plan object

Properties

`type`	string	Account plan type
`hosts`	integer	Account plan number of hosts


                        plan_webinar

array [AccountPlan]

Additional Webinar Plans


                        AccountPlan

object

Account plan object

Properties

`type`	string	Account plan type
`hosts`	integer	Account plan number of hosts

plan_room_connector AccountPlan


                        AccountPlan

object

Account plan object

Properties

`type`	string	Account plan type
`hosts`	integer	Account plan number of hosts


                        plan_recording

string

Additional Cloud Recording Plan


                        plan_large_meeting

array [AccountPlan]

Additional Large Meeting Plans


                        AccountPlan

object

Account plan object

Properties

`type`	string	Account plan type
`hosts`	integer	Account plan number of hosts

plan_base AccountPlanBaseRequired


                        AccountPlanBaseRequired

object

Account base plan object

Properties

`type`	string	Account base plan type
`hosts`	integer	Account base plan number of hosts. For a Pro Plan, please select a value between 1 and 9. For a Business Plan, please select a value between 10 and 49. For a Education Plan, please select a value between 20 and 149. For a Free Trial Plan, please select a value between 1 and 9999.

plan_audio

Responses

201Account plans updated

Body

Name	Data Type	Description
`AccountPlans`	object	Account Plans object

Properties

plan_zoom_rooms AccountPlan


                        AccountPlan

object

Account plan object

Properties

`type`	string	Account plan type
`hosts`	integer	Account plan number of hosts


                        plan_webinar

array [AccountPlan]

Additional Webinar Plans


                        AccountPlan

object

Account plan object

Properties

`type`	string	Account plan type
`hosts`	integer	Account plan number of hosts

plan_room_connector AccountPlan


                        AccountPlan

object

Account plan object

Properties

`type`	string	Account plan type
`hosts`	integer	Account plan number of hosts


                        plan_recording

string

Additional Cloud Recording Plan


                        plan_large_meeting

array [AccountPlan]

Additional Large Meeting Plans


                        AccountPlan

object

Account plan object

Properties

`type`	string	Account plan type
`hosts`	integer	Account plan number of hosts

plan_base AccountPlanBaseRequired


                        AccountPlanBaseRequired

object

Account base plan object

Properties

`type`	string	Account base plan type
`hosts`	integer	Account base plan number of hosts. For a Pro Plan, please select a value between 1 and 9. For a Business Plan, please select a value between 10 and 49. For a Education Plan, please select a value between 20 and 149. For a Free Trial Plan, please select a value between 1 and 9999.

plan_audio

PUT

/meetings/{meetingId}/recordings/status

Recover a meeting's recordings

Request

Path

Name	Data Type	Description
`meetingId`	integer	The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.

Body

Name	Data Type	Description
`body`

Properties

action string
Allowed values:
- recover

Responses

204Meeting recording recover

404Meeting recording not found

PUT

/meetings/{meetingId}/recordings/{recordingId}/status

Recover a meeting one recording

Request

Path

Name	Data Type	Description
`recordingId`	string	The recording ID
`meetingId`	integer	The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.

Body

Name	Data Type	Description
`body`

Properties

action string
Allowed values:
- recover

Responses

204Meeting recording recover

404Meeting recording not found

DELETE

/meetings/{meetingId}/recordings/{recordingId}

Delete one meeting recording file

Request

Path

Name	Data Type	Description
`recordingId`	string	The recording ID
`meetingId`	integer	The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.

Query

Name	Data Type	Description
`action`	string Default value: `trash` Allowed values: - `trash` - `delete`	The recording delete action

Responses

204Meeting recording file deleted

404Meeting recording file not found

DELETE

/meetings/{meetingId}/recordings

Delete a meeting's recordings

Request

Path

Name	Data Type	Description
`meetingId`	integer	The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.

Query

Name	Data Type	Description
`action`	string Default value: `trash` Allowed values: - `trash` - `delete`	The recording delete action

Responses

204Meeting recording deleted

404Meeting recording not found

GET

/meetings/{meetingId}/recordings

Retrieve a meeting’s all recordings

Request

Path

Name	Data Type	Description
`meetingId`	integer	The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.

Responses

200Recording object returned

Body

Name	Data Type	Description
`body`

Extends

Recording

The recording meeting object

Properties

Name	Data Type	Description
`uuid`	string	Meeting unique ID
`total_size`	string	Total size
`topic`	string	Meeting topic
`start_time`	dateTime	Meeting start time
`recording_count`	string	Recording count
`id`	string	Meeting ID, also know as meeting number
`host_id`	string	ID of the user set as host of meeting
`duration`	integer	Meeting duration
`account_id`	string	ID of the user account

Extends

404Meeting recording not found

GET

/users/{userId}/recordings

List all the recordings

Request

Path

Name	Data Type	Description
`userId`	string	The user ID or email address

Query

Name	Data Type	Description
`trash`	boolean Default value: `false`	Query trash
`mc`	string Default value: `false`	Query mc
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`to`	date	End Date
`from`	date	Start Date

Responses

200List of Recording objects returned

Body

Name	Data Type	Description
`Recording List`	object	List of Recording

Properties

`Recording List`	array []	List of Recording
`total_records`	integer	The number of all records available across pages.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`page_count`	integer	The number of items returned on this page.
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.
`to`	date	End Date
`from`	date	Start Date,

Extends

PaginationToken

Pagination Object

Properties

Name	Data Type	Description
`total_records`	integer	The number of all records available across pages.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`page_count`	integer	The number of items returned on this page.
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.

DateTime

DateTime Object

Properties

Name	Data Type	Description
`to`	date	End Date
`from`	date	Start Date,

404User not found

GET

/metrics/crc

Get CRC Port usage hour by hour for a specified time period

Request

Query

Name	Data Type	Description
`to`	date	End Date
`from`	date	Start Date

Responses

200CRC Usage returned

Body

Name	Data Type	Description
`body`

Properties

`crc_ports_usage`	array []
`to`	date	End date for this report
`from`	date	Start date for this report

GET

/metrics/im

Retrieve metrics of Zoom IM

Request

Query

Name	Data Type	Description
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`to`	date	End Date
`from`	date	Start Date

Responses

200IM setails returned

Body

Name	Data Type	Description
`body`

Properties

`users`	array []
`total_records`	integer	The number of all records available across pages.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`page_count`	integer	The number of items returned on this page.
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.
`to`	date	End date for this report
`from`	date	Start date for this report

Extends

PaginationToken

Pagination Object

Properties

Name	Data Type	Description
`total_records`	integer	The number of all records available across pages.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`page_count`	integer	The number of items returned on this page.
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.

GET

/metrics/meetings/{meetingId}/participants/qos

Retrieve list of live or past meetings participants quality of service

Request

Path

Name	Data Type	Description
`meetingId`	integer	The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.

Query

Name	Data Type	Description
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.
`page_size`	integer Default value: `1` Maximum: 10	Number of items returned per page
`type`	string Default value: `live` Allowed values: - `past` - `live`	The meeting type

Responses

200Meeting Participants Returned

Body

Name	Data Type	Description
`Participant QOS List`	object	Participant QOS List

Properties


                        participants

array [QOSParticipant]

Array of user objects


                        Participant QOS

object

Participant QOS

Properties

`version`	string	Participant version
`user_qos`
`user_name`	string	Participant display name
`user_id`	uuid	Participant ID
`pc_name`	string	Participant PC name
`mac_addr`	string	Participant MAC Address
`location`	string	Participant location
`leave_time`	dateTime	Participant leave time
`join_time`	dateTime	Participant join time
`ip_address`	string	Participant IP Address
`harddisk_id`	string	Participant hard disk id
`domain`	string	Participant domain
`device`	string	Participant device


                        total_records

long

The number of all records available across pages.


                        page_size

integer
Default value: 1
Maximum: 10

The number of items per page.


                        page_count

long

The number of items returned on this page.


                        next_page_token

string

Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.

Extends

PaginationToken4Qos

Pagination Object

Properties

Name	Data Type	Description
`total_records`	long	The number of all records available across pages.
`page_size`	integer Default value: `1` Maximum: 10	The number of items per page.
`page_count`	long	The number of items returned on this page.
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.

GET

/metrics/meetings/{meetingId}/participants/sharing

Retrieve sharing/recording details of live or past meetings participant

Request

Path

Name	Data Type	Description
`meetingId`	integer	The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.

Query

Name	Data Type	Description
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`type`	string Default value: `live` Allowed values: - `past` - `live`	The meeting type

Responses

200Meeting Participants Returned

Body

Name	Data Type	Description
`body`

Properties

`participants`	array []	Array of participants
`total_records`	integer	The number of all records available across pages.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`page_count`	integer	The number of items returned on this page.
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.

Extends

PaginationToken

Pagination Object

Properties

Name	Data Type	Description
`total_records`	integer	The number of all records available across pages.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`page_count`	integer	The number of items returned on this page.
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.

GET

/metrics/meetings/{meetingId}/participants/{participantId}/qos

Retrieve live or past meetings participant quality of service

Request

Path

Name	Data Type	Description
`participantId`	string	The participant ID, such as 16778240
`meetingId`	integer	The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.

Query

Name	Data Type	Description
`type`	string Default value: `live` Allowed values: - `past` - `live`	The meeting type

Responses

200Meeting Participant QOS Returned

Body

Name	Data Type	Description
`Participant QOS`	object	Participant QOS

Properties

`version`	string	Participant version
`user_qos`
`user_name`	string	Participant display name
`user_id`	uuid	Participant ID
`pc_name`	string	Participant PC name
`mac_addr`	string	Participant MAC Address
`location`	string	Participant location
`leave_time`	dateTime	Participant leave time
`join_time`	dateTime	Participant join time
`ip_address`	string	Participant IP Address
`harddisk_id`	string	Participant hard disk id
`domain`	string	Participant domain
`device`	string	Participant device

GET

/metrics/meetings/{meetingId}/participants

Retrieve live or past meetings participants

Request

Path

Name	Data Type	Description
`meetingId`	integer	The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.

Query

Name	Data Type	Description
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`type`	string Default value: `live` Allowed values: - `past` - `pastOne` - `live`	The meeting type

Responses

200Meeting Participants Returned

Body

Name	Data Type	Description
`body`

Properties

`participants`	array []	Array of user objects
`total_records`	integer	The number of all records available across pages.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`page_count`	integer	The number of items returned on this page.
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.

Extends

PaginationToken

Pagination Object

Properties

Name	Data Type	Description
`total_records`	integer	The number of all records available across pages.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`page_count`	integer	The number of items returned on this page.
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.

GET

/metrics/meetings/{meetingId}

Retrieve live or past meetings detail

Request

Path

Name	Data Type	Description
`meetingId`	integer	The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.

Query

Name	Data Type	Description
`type`	string Default value: `live` Allowed values: - `past` - `pastOne` - `live`	The meeting type

Responses

200Meeting Returned

Body

Name	Data Type	Description
`Meeting Metrics`	object	Meeting metric details

Properties

`uuid`	uuid	Meeting UUID
`user_type`	string	User type
`topic`	string	Meeting topic
`start_time`	dateTime	Meeting start time
`participants`	integer	Meeting participant count
`id`	integer	Meeting ID
`host`	string	User display name
`has_voip`	boolean
`has_video`	boolean
`has_sip`	boolean
`has_screen_share`	boolean
`has_recording`	boolean
`has_pstn`	boolean
`has_3rd_party_audio`	boolean
`end_time`	dateTime	Meeting end time
`email`	string	User email
`duration`	string	Meeting duration

GET

/metrics/meetings

List live meetings or past meetings for a specified period

Request

Query

Name	Data Type	Description
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`to`	date	End Date
`from`	date	Start Date
`type`	string Default value: `live` Allowed values: - `past` - `pastOne` - `live`	The meeting type

Responses

200Meetings Returned

Body

Name	Data Type	Description
`body`

Properties


                        meetings

array [MeetingMetric]

Array of meeting objects


                        Meeting Metrics

object

Meeting metric details

Properties

`uuid`	uuid	Meeting UUID
`user_type`	string	User type
`topic`	string	Meeting topic
`start_time`	dateTime	Meeting start time
`participants`	integer	Meeting participant count
`id`	integer	Meeting ID
`host`	string	User display name
`has_voip`	boolean
`has_video`	boolean
`has_sip`	boolean
`has_screen_share`	boolean
`has_recording`	boolean
`has_pstn`	boolean
`has_3rd_party_audio`	boolean
`end_time`	dateTime	Meeting end time
`email`	string	User email
`duration`	string	Meeting duration


                        total_records

integer

The number of all records available across pages.


                        page_size

integer
Default value: 30
Maximum: 300

The amount of records returns within a single API call.


                        page_count

integer

The number of items returned on this page.


                        next_page_token

string

Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.

to

date

End date for this report


                        from

date

Start date for this report

Extends

PaginationToken

Pagination Object

Properties

Name	Data Type	Description
`total_records`	integer	The number of all records available across pages.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`page_count`	integer	The number of items returned on this page.
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.

GET

/metrics/webinars/{webinarId}/participants/qos

Retrieve list of live or past webinar participants quality of service

Request

Path

Name	Data Type	Description
`webinarId`	integer	The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance.

Query

Name	Data Type	Description
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.
`page_size`	integer Default value: `1` Maximum: 10	Number of items returned per page
`type`	string Default value: `live` Allowed values: - `past` - `live`	The webinar type

Responses

200Webinar Participants Returned

Body

Name	Data Type	Description
`Participant QOS List`	object	Participant QOS List

Properties


                        participants

array [QOSParticipant]

Array of user objects


                        Participant QOS

object

Participant QOS

Properties

`version`	string	Participant version
`user_qos`
`user_name`	string	Participant display name
`user_id`	uuid	Participant ID
`pc_name`	string	Participant PC name
`mac_addr`	string	Participant MAC Address
`location`	string	Participant location
`leave_time`	dateTime	Participant leave time
`join_time`	dateTime	Participant join time
`ip_address`	string	Participant IP Address
`harddisk_id`	string	Participant hard disk id
`domain`	string	Participant domain
`device`	string	Participant device


                        total_records

long

The number of all records available across pages.


                        page_size

integer
Default value: 1
Maximum: 10

The number of items per page.


                        page_count

long

The number of items returned on this page.


                        next_page_token

string

Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.

Extends

PaginationToken4Qos

Pagination Object

Properties

Name	Data Type	Description
`total_records`	long	The number of all records available across pages.
`page_size`	integer Default value: `1` Maximum: 10	The number of items per page.
`page_count`	long	The number of items returned on this page.
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.

GET

/metrics/webinars/{webinarId}/participants/sharing

Retrieve sharing/recording details of live or past webinar participant

Request

Path

Name	Data Type	Description
`webinarId`	integer	The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance.

Query

Name	Data Type	Description
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`type`	string Default value: `live` Allowed values: - `past` - `live`	The webinar type

Responses

200Webinar Participants Returned

Body

Name	Data Type	Description
`body`

Properties

`participants`	array []	Array of participants
`total_records`	integer	The number of all records available across pages.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`page_count`	integer	The number of items returned on this page.
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.

Extends

PaginationToken

Pagination Object

Properties

Name	Data Type	Description
`total_records`	integer	The number of all records available across pages.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`page_count`	integer	The number of items returned on this page.
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.

GET

/metrics/webinars/{webinarId}/participants/{participantId}/qos

Retrieve live or past webinar participant quality of service

Request

Path

Name	Data Type	Description
`participantId`	string	The participant ID, such as 16778240
`webinarId`	integer	The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance.

Query

Name	Data Type	Description
`type`	string Default value: `live` Allowed values: - `past` - `live`	The webinar type

Responses

200Webinar Participant QOS Returned

Body

Name	Data Type	Description
`Participant QOS`	object	Participant QOS

Properties

`version`	string	Participant version
`user_qos`
`user_name`	string	Participant display name
`user_id`	uuid	Participant ID
`pc_name`	string	Participant PC name
`mac_addr`	string	Participant MAC Address
`location`	string	Participant location
`leave_time`	dateTime	Participant leave time
`join_time`	dateTime	Participant join time
`ip_address`	string	Participant IP Address
`harddisk_id`	string	Participant hard disk id
`domain`	string	Participant domain
`device`	string	Participant device

GET

/metrics/webinars/{webinarId}/participants

Retrieve live or past webinar participants

Request

Path

Name	Data Type	Description
`webinarId`	integer	The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance.

Query

Name	Data Type	Description
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`type`	string Default value: `live` Allowed values: - `past` - `live`	The webinar type

Responses

200Webinar Participants Returned

Body

Name	Data Type	Description
`body`

Properties

`participants`	array []	Array of user objects
`total_records`	integer	The number of all records available across pages.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`page_count`	integer	The number of items returned on this page.
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.

Extends

PaginationToken

Pagination Object

Properties

Name	Data Type	Description
`total_records`	integer	The number of all records available across pages.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`page_count`	integer	The number of items returned on this page.
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.

GET

/metrics/webinars/{webinarId}

Retrieve live or past webinars detail

Request

Path

Name	Data Type	Description
`webinarId`	integer	The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance.

Query

Name	Data Type	Description
`type`	string Default value: `live` Allowed values: - `past` - `live`	The webinar type

Responses

200Webinar Returned

Body

Name	Data Type	Description
`Webinar Metrics`	object	Webinar metric details

Properties

`uuid`	uuid	Webinar UUID
`user_type`	string	User type
`topic`	string	Webinar topic
`start_time`	dateTime	Webinar start time
`participants`	integer	Webinar participant count
`id`	integer	Webinar ID
`host`	string	User display name
`has_voip`	boolean
`has_video`	boolean
`has_sip`	boolean
`has_screen_share`	boolean
`has_recording`	boolean
`has_pstn`	boolean
`has_3rd_party_audio`	boolean
`end_time`	dateTime	Webinar end time
`email`	string	User email
`duration`	string	Webinar duration

GET

/metrics/webinars

List live webinars or past webinars for a specified period

Request

Query

Name	Data Type	Description
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`to`	date	End Date
`from`	date	Start Date
`type`	string Default value: `live` Allowed values: - `past` - `live`	The webinar type

Responses

200Meetings Returned

Body

Name	Data Type	Description
`body`

Properties


                        webinars

array [WebinarMetric]

Array of webinar objects


                        Webinar Metrics

object

Webinar metric details

Properties

`uuid`	uuid	Webinar UUID
`user_type`	string	User type
`topic`	string	Webinar topic
`start_time`	dateTime	Webinar start time
`participants`	integer	Webinar participant count
`id`	integer	Webinar ID
`host`	string	User display name
`has_voip`	boolean
`has_video`	boolean
`has_sip`	boolean
`has_screen_share`	boolean
`has_recording`	boolean
`has_pstn`	boolean
`has_3rd_party_audio`	boolean
`end_time`	dateTime	Webinar end time
`email`	string	User email
`duration`	string	Webinar duration


                        total_records

integer

The number of all records available across pages.


                        page_size

integer
Default value: 30
Maximum: 300

The amount of records returns within a single API call.


                        page_count

integer

The number of items returned on this page.


                        next_page_token

string

Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.

to

date

End date for this report


                        from

date

Start date for this report

Extends

PaginationToken

Pagination Object

Properties

Name	Data Type	Description
`total_records`	integer	The number of all records available across pages.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`page_count`	integer	The number of items returned on this page.
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.

GET

/metrics/zoomrooms/{zoomroomId}

Retrieve zoom room on account

Request

Path

Name	Data Type	Description
`zoomroomId`	integer	The Zoom Room ID

Query

Name	Data Type	Description
`page_number`	integer Default value: `1`	Current page number of returned records.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`to`	date	End Date
`from`	date	Start Date

Responses

200Zoom Room returned

Body

Name	Data Type	Description
`body`

Properties

past_meetings object

live_meeting MeetingMetric


                        Meeting Metrics

object

Meeting metric details

Properties

`uuid`	uuid	Meeting UUID
`user_type`	string	User type
`topic`	string	Meeting topic
`start_time`	dateTime	Meeting start time
`participants`	integer	Meeting participant count
`id`	integer	Meeting ID
`host`	string	User display name
`has_voip`	boolean
`has_video`	boolean
`has_sip`	boolean
`has_screen_share`	boolean
`has_recording`	boolean
`has_pstn`	boolean
`has_3rd_party_audio`	boolean
`end_time`	dateTime	Meeting end time
`email`	string	User email
`duration`	string	Meeting duration


                        status

string

Zoom Room status


                        speaker

string

Zoom Room speaker


                        room_name

string

Zoom Room name


                        microphone

string

Zoom Room microphone


                        last_start_time

string

Zoom Room last start time

id

string

Zoom Room ID


                        email

string

Zoom Room email


                        device_ip

string

Zoom Room device IP


                        camera

string

Zoom Room camera


                        account_type

string

Zoom Room email type

Extends

Zoom Room

Properties

Name	Data Type	Description
`status`	string	Zoom Room status
`speaker`	string	Zoom Room speaker
`room_name`	string	Zoom Room name
`microphone`	string	Zoom Room microphone
`last_start_time`	string	Zoom Room last start time
`id`	string	Zoom Room ID
`email`	string	Zoom Room email
`device_ip`	string	Zoom Room device IP
`camera`	string	Zoom Room camera
`account_type`	string	Zoom Room email type

GET

/metrics/zoomrooms

List all zoom rooms on account

Request

Query

Name	Data Type	Description
`page_number`	integer Default value: `1`	Current page number of returned records.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.

Responses

200List of Zoom Rooms returned

Body

Name	Data Type	Description
`Zoom Room List`	object	Zoom Room List

Properties


                        zoom_rooms

array [ZoomRoom]

Array of Zoom Rooms


                        Zoom Room

object

Zoom Room

Properties

`status`	string	Zoom Room status
`speaker`	string	Zoom Room speaker
`room_name`	string	Zoom Room name
`microphone`	string	Zoom Room microphone
`last_start_time`	string	Zoom Room last start time
`id`	string	Zoom Room ID
`email`	string	Zoom Room email
`device_ip`	string	Zoom Room device IP
`camera`	string	Zoom Room camera
`account_type`	string	Zoom Room email type


                        total_records

integer

The number of all records available across pages.


                        page_size

integer
Default value: 30
Maximum: 300

The amount of records returns within a single API call.


                        page_number

integer
Default value: 1

The page number of current results.


                        page_count

integer

The number of items returned on this page.

Extends

Pagination

Pagination Object

Properties

Name	Data Type	Description
`total_records`	integer	The number of all records available across pages.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`page_number`	integer Default value: `1`	The page number of current results.
`page_count`	integer	The number of items returned on this page.

DELETE

/groups/{groupId}/members/{memberId}

GET

/groups/{groupId}/members

List a group's members under your account

Request

Path

Name	Data Type	Description
`groupId`	string	The group ID

Query

Name	Data Type	Description
`page_number`	integer Default value: `1`	Current page number of returned records.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.

Responses

200Group member list returned

Body

Name	Data Type	Description
`Group Member List`	object	List of Group Members

Properties


                        members

array [GroupMember]

List of Group member objects.


                        GroupMember

object

Group member object

Properties

`type`	integer	User type
`last_name`	string	User last name
`id`	string	User ID
`first_name`	string	User first name
`email`	string	User email


                        total_records

integer

The number of all records available across pages.


                        page_size

integer
Default value: 30
Maximum: 300

The amount of records returns within a single API call.


                        page_number

integer
Default value: 1

The page number of current results.


                        page_count

integer

The number of items returned on this page.

Extends

Pagination

Pagination Object

Properties

Name	Data Type	Description
`total_records`	integer	The number of all records available across pages.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`page_number`	integer Default value: `1`	The page number of current results.
`page_count`	integer	The number of items returned on this page.

404Group not found

POST

/groups/{groupId}/members

Add members to a group under your account

Request

Path

Name	Data Type	Description
`groupId`	string	The group ID

Body

Name	Data Type	Description
`body`

Properties


                        members

array []

List of Group members

Responses

201Member added.

Body

Name	Data Type	Description
`body`

Properties

`ids`	string
`added_at`	dateTime

404Group not found

DELETE

/groups/{groupId}

GET

/groups/{groupId}

Retrieve a group under your account

Request

Path

Name	Data Type	Description
`groupId`	string	The group ID

Responses

200Group object returned

Body

Name	Data Type	Description
`body`

Properties

`total_members`	integer	Total number of members in this group.
`name`	string	Group name
`id`	string	Group ID

Extends

Group

Group object

Properties

Name	Data Type	Description
`total_members`	integer	Total number of members in this group.
`name`	string	Group name

404Group not found

PATCH

/groups/{groupId}

Update a group under your account

Request

Path

Name	Data Type	Description
`groupId`	string	The group ID

Body

Name	Data Type	Description
`body`

Properties


                        name

string

Group name. Must be unique in one account. Character length is less than 128.

Responses

204Group updated.

404Group not found

GET

/groups

POST

/groups

Create a group under your account

Request

Body

Name	Data Type	Description
`body`

Properties


                        name

string

Group name.

Responses

201Group created.

Header

Name	Data Type	Description
`Content-Location`	string	Location of created group

Body

Name	Data Type	Description
`body`

Properties

`total_members`	integer	Group member count
`name`	string	Group name
`id`	string	Group ID

DELETE

/im/groups/{groupId}/members/{memberId}

Delete a member from an IM Group under your account

Request

Path

Name	Data Type	Description
`memberId`	string	The member ID
`groupId`	string	The group ID

Responses

204IM Group member deleted.

404IM Group or IM Group member not found

GET

/im/groups/{groupId}/members

List an IM Group's members under your account

Request

Path

Name	Data Type	Description
`groupId`	string	The group ID

Query

Name	Data Type	Description
`page_number`	integer Default value: `1`	Current page number of returned records.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.

Responses

200IM Group member list returned

Body

Name	Data Type	Description
`Group Member List`	object	List of Group Members

Properties


                        members

array [GroupMember]

List of Group member objects.


                        GroupMember

object

Group member object

Properties

`type`	integer	User type
`last_name`	string	User last name
`id`	string	User ID
`first_name`	string	User first name
`email`	string	User email


                        total_records

integer

The number of all records available across pages.


                        page_size

integer
Default value: 30
Maximum: 300

The amount of records returns within a single API call.


                        page_number

integer
Default value: 1

The page number of current results.


                        page_count

integer

The number of items returned on this page.

Extends

Pagination

Pagination Object

Properties

Name	Data Type	Description
`total_records`	integer	The number of all records available across pages.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`page_number`	integer Default value: `1`	The page number of current results.
`page_count`	integer	The number of items returned on this page.

404IM Group not found

POST

/im/groups/{groupId}/members

Add members to an IM Group under your account

Request

Path

Name	Data Type	Description
`groupId`	string	The group ID

Body

Name	Data Type	Description
`body`

Properties


                        members

array []

List of IM Group members

Responses

201Member added.

Body

Name	Data Type	Description
`body`

Properties

`ids`	string
`added_at`	dateTime

404IM Group not found

DELETE

/im/groups/{groupId}

GET

/im/groups/{groupId}

Retrieve an IM Group under your account

Request

Path

Name	Data Type	Description
`groupId`	string	The group ID

Responses

200IM Group object returned

Body

Name	Data Type	Description
`body`

Properties

id

string

Group ID

Extends

IMGroup

IM Group object

Properties

Name	Data Type	Description
`type`	string Default value: `normal` Allowed values: - `normal` - `shared` - `restricted`	IM Group type
`search_by_ma_account`	boolean	Members can search others under same master account, including all sub accounts
`search_by_domain`	boolean	Members can search others in the same email domain
`search_by_account`	boolean	Members can search others under same account
`total_members`	integer	Total number of members in this group.
`name`	string	Group name

Extends

404IM Group not found

PATCH

/im/groups/{groupId}

Update an IM Group under your account

Request

Path

Name	Data Type	Description
`groupId`	string	The group ID

Body

Name	Data Type	Description
`body`

Properties

`type`	string Allowed values: - `normal` - `shared` - `restricted`	IM Group type
`search_by_ma_account`	boolean	Members can search others under same master account, including all sub accounts
`search_by_domain`	boolean	Members can search others in the same email domain
`search_by_account`	boolean	Members can search others under same account
`name`	string Maximum: 128	Group name, must be unique in one account

Responses

204IM Group updated.

404IM Group not found

GET

/im/groups

List IM groups under your account

Responses

200List of IM Groups returned.

Body

Name	Data Type	Description
`IM Group List`	object	List of IM Groups

Properties

`groups`	array []	List of Group objects.
`total_records`	integer	The number of all records available across pages.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`page_number`	integer Default value: `1`	The page number of current results.
`page_count`	integer	The number of items returned on this page.

Extends

Pagination

Pagination Object

Properties

Name	Data Type	Description
`total_records`	integer	The number of all records available across pages.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`page_number`	integer Default value: `1`	The page number of current results.
`page_count`	integer	The number of items returned on this page.

POST

/im/groups

Create a IM Group under your account

Request

Body

Name	Data Type	Description
`body`

Properties

`type`	string Default value: `normal` Allowed values: - `normal` - `shared` - `restricted`	IM Group type
`search_by_ma_account`	boolean	Members can search others under same master account, including all sub accounts
`search_by_domain`	boolean	Members can search others in the same email domain
`search_by_account`	boolean	Members can search others under same account
`name`	string Maximum: 128	Group name, must be unique in one account

Responses

201IM Group created.

Header

Name	Data Type	Description
`Content-Location`	string	Location of created IM Group

Body

Name	Data Type	Description
`body`

Properties

`total_members`	integer	Group member count
`search_by_ma_account`	boolean	Members can search others under same master account, including all sub accounts.
`search_by_domain`	boolean	Members can search others in the same email domain.
`search_by_account`	boolean	Members can search others under same account.
`name`	string	Group name
`id`	string	Group ID

PUT

/meetings/{meetingId}/registrants/status

Update a meeting registrant's status

Request

Path

Name	Data Type	Description
`meetingId`	integer	The meeting ID

Query

Name	Data Type	Description
`occurrence_id`	string	The meeting occurrence ID

Body

Name	Data Type	Description
`RegistrantStatus`	object	Registrant Status

Properties

`registrants`	array []	List of registrants
`action`	string Allowed values: - `approve` - `cancel` - `deny`

Responses

204Registrant status updated

404Meeting or Registrant not found

GET

/meetings/{meetingId}/registrants

List registrants of a meeting

Request

Path

Name	Data Type	Description
`meetingId`	integer	The meeting ID

Query

Name	Data Type	Description
`page_number`	integer Default value: `1`	Current page number of returned records.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`status`	string Default value: `approved` Allowed values: - `pending` - `approved` - `denied`	The registrant status
`occurrence_id`	string	The meeting occurrence ID

Responses

200Success

Body

Name	Data Type	Description
`Registration List`	object	List of Users

Extends

Registration List

List of Users

Properties

Name	Data Type	Description
`registrants`	array []	List of Registrant objects.
`total_records`	integer	The number of all records available across pages.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`page_count`	integer	The number of items returned on this page.
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.

Extends

404Meeting not found

POST

/meetings/{meetingId}/registrants

Register a participant for a meeting

Request

Path

Name	Data Type	Description
`meetingId`	integer	The meeting ID

Query

Name	Data Type	Description
`occurrence_ids`	string	Occurrence IDs, could get this value from Meeting Get API. Multiple value separated by comma.

Body

Name	Data Type	Description
`MeetingRegistrant`	object	Meeting registrant

Properties

zip

string

Zip/Postal Code


                        state

string

State/Province


                        role_in_purchase_process

string
Allowed values:
- Decision Maker
- Evaluator/Recommender
- Influencer
- Not involved

Role in Purchase Process


                        purchasing_time_frame

string
Allowed values:
- Within a month
- 1-3 months
- 4-6 months
- More than 6 months
- No timeframe

Purchasing Time Frame


                        phone

string

Phone

org

string

Organization


                        no_of_employees

string
Allowed values:
- 1-20
- 21-50
- 51-100
- 101-500
- 500-1,000
- 1,001-5,000
- 5,001-10,000
- More than 10,000

Number of Employees


                        last_name

string

User’s last name


                        job_title

string

Job Title


                        industry

string

Industry


                        first_name

string

User’s first name


                        email

string

A valid email address


                        custom_questions

array [CustomQuestion]

Custom Questions


                        CustomQuestion

object

Custom Question

Properties

`value`	string
`title`	string


                        country

string

Country


                        comments

string

Questions & Comments


                        city

string

City


                        address

string

Address

Extends

Registrant

Registrant base object

Properties

Name Data Type Description

zip

string

Zip/Postal Code


                        state

string

State/Province


                        role_in_purchase_process

string
Allowed values:
- Decision Maker
- Evaluator/Recommender
- Influencer
- Not involved

Role in Purchase Process


                        purchasing_time_frame

string
Allowed values:
- Within a month
- 1-3 months
- 4-6 months
- More than 6 months
- No timeframe

Purchasing Time Frame


                        phone

string

Phone

org

string

Organization


                        no_of_employees

string
Allowed values:
- 1-20
- 21-50
- 51-100
- 101-500
- 500-1,000
- 1,001-5,000
- 5,001-10,000
- More than 10,000

Number of Employees


                        last_name

string

User’s last name


                        job_title

string

Job Title


                        industry

string

Industry


                        first_name

string

User’s first name


                        email

string

A valid email address


                        custom_questions

array [CustomQuestion]

Custom Questions


                        CustomQuestion

object

Custom Question

Properties

`value`	string
`title`	string


                        country

string

Country


                        comments

string

Questions & Comments


                        city

string

City


                        address

string

Address

Responses

201Registration created

Body

Name	Data Type	Description
`body`	object

Properties

`topic`	string	Topic
`start_time`	dateTime	Start time
`registrant_id`	string	Registrant ID
`join_url`	string	Join URL for this registrant
`id`	string	Registrant ID

404Meeting not found

PUT

/meetings/{meetingId}/status

Update a meeting's status

Request

Path

Name	Data Type	Description
`meetingId`	integer	The meeting ID

Body

Name	Data Type	Description
`body`

Properties

action string
Allowed values:
- end

Responses

204Meeting updated

404Meeting not found

DELETE

/meetings/{meetingId}

Delete a meeting

Request

Path

Name	Data Type	Description
`meetingId`	integer	The meeting ID

Query

Name	Data Type	Description
`occurrence_id`	string	The meeting occurrence ID

Responses

204Meeting deleted

404Meeting not found

GET

/meetings/{meetingId}

Retrieve a meeting's details

Request

Path

Name	Data Type	Description
`meetingId`	integer	The meeting ID

Responses

200Meeting object returned

Body

Name	Data Type	Description
`body`	object

Properties


                        type

integer
Default value: 2
Allowed values:
- 1
- 2
- 3
- 8

Meeting Type


                        topic

string

Meeting topic


                        timezone

string

Timezone to format start_time


                        start_url

string

Start url


                        start_time

dateTime

Meeting start time

settings MeetingSettings


                        MeetingSettings

object

Meeting Settings

Properties

`watermark`	boolean Default value: `false`	Enable watermark when viewing the shared screen
`use_pmi`	boolean Default value: `false`	Use Personal Meeting ID. Only used for scheduled meetings and recurring meetings with no fixed time
`registration_type`	integer Default value: `1` Allowed values: - `1` - `2` - `3`	Registration type. Used for recurring meeting with fixed time only.
`participant_video`	boolean	Start video when participants join meeting
`mute_upon_entry`	boolean Default value: `false`	Mute participants upon entry
`join_before_host`	boolean Default value: `false`	Join meeting before host start the meeting. Only used for scheduled or recurring meetings
`in_meeting`	boolean Default value: `false`	Host meeting in India
`host_video`	boolean	Start video when host join meeting
`enforce_login_domains`	string	Only signed-in users with specified domains can join meetings
`enforce_login`	boolean	Only signed-in users can join this meeting
`cn_meeting`	boolean Default value: `false`	Host meeting in China
`auto_recording`	string Default value: `none` Allowed values: - `local` - `cloud` - `none`
`audio`	string Default value: `both` Allowed values: - `both` - `telephony` - `voip`	Meeting audio options
`approval_type`	integer Default value: `2` Allowed values: - `0` - `1` - `2`
`alternative_hosts`	string	Alternative hosts emails or IDs. Multiple value separated by comma.


                        password

string

Meeting password

occurrences Occurrences


                        Occurrences

array [Occurrence]

Array of occurrence objects


                        Occurrence

object

Occurence object

Properties

`status`	string	Occurrence status
`start_time`	dateTime	Start time
`occurrence_id`	integer	Occurrence Id
`duration`	integer	Duration


                        join_url

string

Join url


                        h323_password

string

H.323/SIP room system password


                        duration

integer

Meeting duration


                        created_at

dateTime

Create time


                        agenda

string

Agenda


                        uuid

string

Meeting unique ID

id

string

Meeting ID, also know as meeting number


                        host_id

string

ID of the user set as host of meeting

Extends

MeetingInfo

Meeting object

Properties

Name Data Type Description


                        type

integer
Default value: 2
Allowed values:
- 1
- 2
- 3
- 8

Meeting Type


                        topic

string

Meeting topic


                        timezone

string

Timezone to format start_time


                        start_url

string

Start url


                        start_time

dateTime

Meeting start time

settings MeetingSettings


                        MeetingSettings

object

Meeting Settings

Properties

`watermark`	boolean Default value: `false`	Enable watermark when viewing the shared screen
`use_pmi`	boolean Default value: `false`	Use Personal Meeting ID. Only used for scheduled meetings and recurring meetings with no fixed time
`registration_type`	integer Default value: `1` Allowed values: - `1` - `2` - `3`	Registration type. Used for recurring meeting with fixed time only.
`participant_video`	boolean	Start video when participants join meeting
`mute_upon_entry`	boolean Default value: `false`	Mute participants upon entry
`join_before_host`	boolean Default value: `false`	Join meeting before host start the meeting. Only used for scheduled or recurring meetings
`in_meeting`	boolean Default value: `false`	Host meeting in India
`host_video`	boolean	Start video when host join meeting
`enforce_login_domains`	string	Only signed-in users with specified domains can join meetings
`enforce_login`	boolean	Only signed-in users can join this meeting
`cn_meeting`	boolean Default value: `false`	Host meeting in China
`auto_recording`	string Default value: `none` Allowed values: - `local` - `cloud` - `none`
`audio`	string Default value: `both` Allowed values: - `both` - `telephony` - `voip`	Meeting audio options
`approval_type`	integer Default value: `2` Allowed values: - `0` - `1` - `2`
`alternative_hosts`	string	Alternative hosts emails or IDs. Multiple value separated by comma.


                        password

string

Meeting password

occurrences Occurrences


                        Occurrences

array [Occurrence]

Array of occurrence objects


                        Occurrence

object

Occurence object

Properties

`status`	string	Occurrence status
`start_time`	dateTime	Start time
`occurrence_id`	integer	Occurrence Id
`duration`	integer	Duration


                        join_url

string

Join url


                        h323_password

string

H.323/SIP room system password


                        duration

integer

Meeting duration


                        created_at

dateTime

Create time


                        agenda

string

Agenda

404Meeting not found

PATCH

/meetings/{meetingId}

Update a meeting's details

Request

Path

Name	Data Type	Description
`meetingId`	integer	The meeting ID

Body

Name	Data Type	Description
`MeetingUpdate`	object	Meeting object

Properties


                        type

integer
Default value: 2
Allowed values:
- 1
- 2
- 3
- 8

Meeting Type


                        topic

string

Meeting topic


                        timezone

string

Timezone to format start_time, like "America/Los_Angeles". For scheduled meeting only. For this parameter value please refer to the id value in timezone list.


                        start_time

dateTime

Meeting start time, in the format "yyyy-MM-dd'T'HH:mm:ss'Z'", should be GMT time. In the format "yyyy-MM-dd'T'HH:mm:ss", should be local time, need to specify the time zone. Only used for scheduled meeting and recurring meeting with fixed time.

settings

recurrence Recurrence


                        Recurrence

object

Recurrence object

Properties

`weekly_days`	integer Allowed values: - `1` - `2` - `3` - `4` - `5` - `6` - `7`	Recurrence Meeting Occurs on week days, multiple value separated by comma
`type`	integer Allowed values: - `1` - `2` - `3`	Recurrence meeting type
`repeat_interval`	integer	Recurrence meeting repeat interval. For a Daily Meeting, max of 90. For a Weekly Meeting, max of 12. For a Monthly Meeting, max of 3.
`monthly_week_day`	integer Allowed values: - `1` - `2` - `3` - `4` - `5` - `6` - `7`	Recurrence Meeting Occurs on the week day of a month
`monthly_week`	integer Allowed values: - `-1` - `1` - `2` - `3` - `4`	Recurrence Meeting Occurs on the week of a month.
`monthly_day`	integer	Recurrence Meeting Occurs on a month day. The value range is from 1 to 31
`end_times`	integer Default value: `1` Maximum: 50	Recurrence Meeting End occurrences times
`end_date_time`	dateTime	Recurrence Meeting End Date. Should be UTC time, such as 2017-11-25T12:00:00Z.


                        password

string

Password to join the meeting. Password may only contain the following characters: [a-z A-Z 0-9 @ - _ *]. Max of 10 characters.


                        duration

integer

Meeting duration (minutes). Used for scheduled meeting only.


                        agenda

string

Meeting description

Extends

SessionUpdate

Base object for sessions

Properties

Name Data Type Description


                        type

integer
Default value: 2
Allowed values:
- 1
- 2
- 3
- 8

Meeting Type


                        topic

string

Meeting topic


                        timezone

string

Timezone to format start_time, like "America/Los_Angeles". For scheduled meeting only. For this parameter value please refer to the id value in timezone list.


                        start_time

dateTime

Meeting start time, in the format "yyyy-MM-dd'T'HH:mm:ss'Z'", should be GMT time. In the format "yyyy-MM-dd'T'HH:mm:ss", should be local time, need to specify the time zone. Only used for scheduled meeting and recurring meeting with fixed time.

settings

recurrence Recurrence


                        Recurrence

object

Recurrence object

Properties

`weekly_days`	integer Allowed values: - `1` - `2` - `3` - `4` - `5` - `6` - `7`	Recurrence Meeting Occurs on week days, multiple value separated by comma
`type`	integer Allowed values: - `1` - `2` - `3`	Recurrence meeting type
`repeat_interval`	integer	Recurrence meeting repeat interval. For a Daily Meeting, max of 90. For a Weekly Meeting, max of 12. For a Monthly Meeting, max of 3.
`monthly_week_day`	integer Allowed values: - `1` - `2` - `3` - `4` - `5` - `6` - `7`	Recurrence Meeting Occurs on the week day of a month
`monthly_week`	integer Allowed values: - `-1` - `1` - `2` - `3` - `4`	Recurrence Meeting Occurs on the week of a month.
`monthly_day`	integer	Recurrence Meeting Occurs on a month day. The value range is from 1 to 31
`end_times`	integer Default value: `1` Maximum: 50	Recurrence Meeting End occurrences times
`end_date_time`	dateTime	Recurrence Meeting End Date. Should be UTC time, such as 2017-11-25T12:00:00Z.


                        password

string

Password to join the meeting. Password may only contain the following characters: [a-z A-Z 0-9 @ - _ *]. Max of 10 characters.


                        duration

integer

Meeting duration (minutes). Used for scheduled meeting only.


                        agenda

string

Meeting description

Responses

204Meeting Updated

404Meeting not found

GET

/users/{userId}/meetings

List meetings for a user

Request

Path

Name	Data Type	Description
`userId`	string	The user ID or email address

Query

Name	Data Type	Description
`page_number`	integer Default value: `1`	Current page number of returned records.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`type`	string Default value: `live` Allowed values: - `scheduled` - `live`	The meeting type

Responses

200List of Meeting objects returned

Body

Name	Data Type	Description
`Group List`	object	List of Meetings

Properties

`meetings`	array []	List of Meeting objects.
`total_records`	integer	The number of all records available across pages.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`page_number`	integer Default value: `1`	The page number of current results.
`page_count`	integer	The number of items returned on this page.

Extends

Pagination

Pagination Object

Properties

Name	Data Type	Description
`total_records`	integer	The number of all records available across pages.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`page_number`	integer Default value: `1`	The page number of current results.
`page_count`	integer	The number of items returned on this page.

404User not found

POST

/users/{userId}/meetings

Create a meeting for a user

Request

Path

Name	Data Type	Description
`userId`	string	The user ID or email address

Body

Name	Data Type	Description
`Meeting`	object	Meeting object

Properties


                        type

integer
Default value: 2
Allowed values:
- 1
- 2
- 3
- 8

Meeting Type


                        topic

string

Meeting topic


                        timezone

string

Timezone to format start_time, like "America/Los_Angeles". For scheduled meeting only. For this parameter value please refer to the id value in timezone list.


                        start_time

dateTime

Meeting start time, in the format "yyyy-MM-dd'T'HH:mm:ss'Z'", should be GMT time. In the format "yyyy-MM-dd'T'HH:mm:ss", should be local time, need to specify the time zone. Only used for scheduled meeting and recurring meeting with fixed time.

settings MeetingSettings


                        MeetingSettings

object

Meeting Settings

Properties

`watermark`	boolean Default value: `false`	Enable watermark when viewing the shared screen
`use_pmi`	boolean Default value: `false`	Use Personal Meeting ID. Only used for scheduled meetings and recurring meetings with no fixed time
`registration_type`	integer Default value: `1` Allowed values: - `1` - `2` - `3`	Registration type. Used for recurring meeting with fixed time only.
`participant_video`	boolean	Start video when participants join meeting
`mute_upon_entry`	boolean Default value: `false`	Mute participants upon entry
`join_before_host`	boolean Default value: `false`	Join meeting before host start the meeting. Only used for scheduled or recurring meetings
`in_meeting`	boolean Default value: `false`	Host meeting in India
`host_video`	boolean	Start video when host join meeting
`enforce_login_domains`	string	Only signed-in users with specified domains can join meetings
`enforce_login`	boolean	Only signed-in users can join this meeting
`cn_meeting`	boolean Default value: `false`	Host meeting in China
`auto_recording`	string Default value: `none` Allowed values: - `local` - `cloud` - `none`
`audio`	string Default value: `both` Allowed values: - `both` - `telephony` - `voip`	Meeting audio options
`approval_type`	integer Default value: `2` Allowed values: - `0` - `1` - `2`
`alternative_hosts`	string	Alternative hosts emails or IDs. Multiple value separated by comma.

recurrence Recurrence


                        Recurrence

object

Recurrence object

Properties

`weekly_days`	integer Allowed values: - `1` - `2` - `3` - `4` - `5` - `6` - `7`	Recurrence Meeting Occurs on week days, multiple value separated by comma
`type`	integer Allowed values: - `1` - `2` - `3`	Recurrence meeting type
`repeat_interval`	integer	Recurrence meeting repeat interval. For a Daily Meeting, max of 90. For a Weekly Meeting, max of 12. For a Monthly Meeting, max of 3.
`monthly_week_day`	integer Allowed values: - `1` - `2` - `3` - `4` - `5` - `6` - `7`	Recurrence Meeting Occurs on the week day of a month
`monthly_week`	integer Allowed values: - `-1` - `1` - `2` - `3` - `4`	Recurrence Meeting Occurs on the week of a month.
`monthly_day`	integer	Recurrence Meeting Occurs on a month day. The value range is from 1 to 31
`end_times`	integer Default value: `1` Maximum: 50	Recurrence Meeting End occurrences times
`end_date_time`	dateTime	Recurrence Meeting End Date. Should be UTC time, such as 2017-11-25T12:00:00Z.


                        password

string

Password to join the meeting. Password may only contain the following characters: [a-z A-Z 0-9 @ - _ *]. Max of 10 characters.


                        duration

integer

Meeting duration (minutes). Used for scheduled meeting only.


                        agenda

string

Meeting description

Extends

Session

Base object for sessions

Properties

Name Data Type Description


                        type

integer
Default value: 2
Allowed values:
- 1
- 2
- 3
- 8

Meeting Type


                        topic

string

Meeting topic


                        timezone

string

Timezone to format start_time, like "America/Los_Angeles". For scheduled meeting only. For this parameter value please refer to the id value in timezone list.


                        start_time

dateTime

Meeting start time, in the format "yyyy-MM-dd'T'HH:mm:ss'Z'", should be GMT time. In the format "yyyy-MM-dd'T'HH:mm:ss", should be local time, need to specify the time zone. Only used for scheduled meeting and recurring meeting with fixed time.

settings MeetingSettings


                        MeetingSettings

object

Meeting Settings

Properties

`watermark`	boolean Default value: `false`	Enable watermark when viewing the shared screen
`use_pmi`	boolean Default value: `false`	Use Personal Meeting ID. Only used for scheduled meetings and recurring meetings with no fixed time
`registration_type`	integer Default value: `1` Allowed values: - `1` - `2` - `3`	Registration type. Used for recurring meeting with fixed time only.
`participant_video`	boolean	Start video when participants join meeting
`mute_upon_entry`	boolean Default value: `false`	Mute participants upon entry
`join_before_host`	boolean Default value: `false`	Join meeting before host start the meeting. Only used for scheduled or recurring meetings
`in_meeting`	boolean Default value: `false`	Host meeting in India
`host_video`	boolean	Start video when host join meeting
`enforce_login_domains`	string	Only signed-in users with specified domains can join meetings
`enforce_login`	boolean	Only signed-in users can join this meeting
`cn_meeting`	boolean Default value: `false`	Host meeting in China
`auto_recording`	string Default value: `none` Allowed values: - `local` - `cloud` - `none`
`audio`	string Default value: `both` Allowed values: - `both` - `telephony` - `voip`	Meeting audio options
`approval_type`	integer Default value: `2` Allowed values: - `0` - `1` - `2`
`alternative_hosts`	string	Alternative hosts emails or IDs. Multiple value separated by comma.

recurrence Recurrence


                        Recurrence

object

Recurrence object

Properties

`weekly_days`	integer Allowed values: - `1` - `2` - `3` - `4` - `5` - `6` - `7`	Recurrence Meeting Occurs on week days, multiple value separated by comma
`type`	integer Allowed values: - `1` - `2` - `3`	Recurrence meeting type
`repeat_interval`	integer	Recurrence meeting repeat interval. For a Daily Meeting, max of 90. For a Weekly Meeting, max of 12. For a Monthly Meeting, max of 3.
`monthly_week_day`	integer Allowed values: - `1` - `2` - `3` - `4` - `5` - `6` - `7`	Recurrence Meeting Occurs on the week day of a month
`monthly_week`	integer Allowed values: - `-1` - `1` - `2` - `3` - `4`	Recurrence Meeting Occurs on the week of a month.
`monthly_day`	integer	Recurrence Meeting Occurs on a month day. The value range is from 1 to 31
`end_times`	integer Default value: `1` Maximum: 50	Recurrence Meeting End occurrences times
`end_date_time`	dateTime	Recurrence Meeting End Date. Should be UTC time, such as 2017-11-25T12:00:00Z.


                        password

string

Password to join the meeting. Password may only contain the following characters: [a-z A-Z 0-9 @ - _ *]. Max of 10 characters.


                        duration

integer

Meeting duration (minutes). Used for scheduled meeting only.


                        agenda

string

Meeting description

Responses

201Meeting Created

Header

Name	Data Type	Description
`Content-Location`	string	Location of created Meeting

Body

Name	Data Type	Description
`body`	object

Properties


                        type

integer
Default value: 2
Allowed values:
- 1
- 2
- 3
- 8

Meeting Type


                        topic

string

Meeting topic


                        timezone

string

Timezone to format start_time


                        start_url

string

Start url


                        start_time

dateTime

Meeting start time

settings MeetingSettings


                        MeetingSettings

object

Meeting Settings

Properties

`watermark`	boolean Default value: `false`	Enable watermark when viewing the shared screen
`use_pmi`	boolean Default value: `false`	Use Personal Meeting ID. Only used for scheduled meetings and recurring meetings with no fixed time
`registration_type`	integer Default value: `1` Allowed values: - `1` - `2` - `3`	Registration type. Used for recurring meeting with fixed time only.
`participant_video`	boolean	Start video when participants join meeting
`mute_upon_entry`	boolean Default value: `false`	Mute participants upon entry
`join_before_host`	boolean Default value: `false`	Join meeting before host start the meeting. Only used for scheduled or recurring meetings
`in_meeting`	boolean Default value: `false`	Host meeting in India
`host_video`	boolean	Start video when host join meeting
`enforce_login_domains`	string	Only signed-in users with specified domains can join meetings
`enforce_login`	boolean	Only signed-in users can join this meeting
`cn_meeting`	boolean Default value: `false`	Host meeting in China
`auto_recording`	string Default value: `none` Allowed values: - `local` - `cloud` - `none`
`audio`	string Default value: `both` Allowed values: - `both` - `telephony` - `voip`	Meeting audio options
`approval_type`	integer Default value: `2` Allowed values: - `0` - `1` - `2`
`alternative_hosts`	string	Alternative hosts emails or IDs. Multiple value separated by comma.


                        password

string

Meeting password

occurrences Occurrences


                        Occurrences

array [Occurrence]

Array of occurrence objects


                        Occurrence

object

Occurence object

Properties

`status`	string	Occurrence status
`start_time`	dateTime	Start time
`occurrence_id`	integer	Occurrence Id
`duration`	integer	Duration


                        join_url

string

Join url


                        h323_password

string

H.323/SIP room system password


                        duration

integer

Meeting duration


                        created_at

dateTime

Create time


                        agenda

string

Agenda


                        uuid

string

Meeting unique ID

id

string

Meeting ID, also known as meeting number


                        host_id

string

ID of the user set as host of meeting

Extends

MeetingInfo

Meeting object

Properties

Name Data Type Description


                        type

integer
Default value: 2
Allowed values:
- 1
- 2
- 3
- 8

Meeting Type


                        topic

string

Meeting topic


                        timezone

string

Timezone to format start_time


                        start_url

string

Start url


                        start_time

dateTime

Meeting start time

settings MeetingSettings


                        MeetingSettings

object

Meeting Settings

Properties

`watermark`	boolean Default value: `false`	Enable watermark when viewing the shared screen
`use_pmi`	boolean Default value: `false`	Use Personal Meeting ID. Only used for scheduled meetings and recurring meetings with no fixed time
`registration_type`	integer Default value: `1` Allowed values: - `1` - `2` - `3`	Registration type. Used for recurring meeting with fixed time only.
`participant_video`	boolean	Start video when participants join meeting
`mute_upon_entry`	boolean Default value: `false`	Mute participants upon entry
`join_before_host`	boolean Default value: `false`	Join meeting before host start the meeting. Only used for scheduled or recurring meetings
`in_meeting`	boolean Default value: `false`	Host meeting in India
`host_video`	boolean	Start video when host join meeting
`enforce_login_domains`	string	Only signed-in users with specified domains can join meetings
`enforce_login`	boolean	Only signed-in users can join this meeting
`cn_meeting`	boolean Default value: `false`	Host meeting in China
`auto_recording`	string Default value: `none` Allowed values: - `local` - `cloud` - `none`
`audio`	string Default value: `both` Allowed values: - `both` - `telephony` - `voip`	Meeting audio options
`approval_type`	integer Default value: `2` Allowed values: - `0` - `1` - `2`
`alternative_hosts`	string	Alternative hosts emails or IDs. Multiple value separated by comma.


                        password

string

Meeting password

occurrences Occurrences


                        Occurrences

array [Occurrence]

Array of occurrence objects


                        Occurrence

object

Occurence object

Properties

`status`	string	Occurrence status
`start_time`	dateTime	Start time
`occurrence_id`	integer	Occurrence Id
`duration`	integer	Duration


                        join_url

string

Join url


                        h323_password

string

H.323/SIP room system password


                        duration

integer

Meeting duration


                        created_at

dateTime

Create time


                        agenda

string

Agenda

404User not found

GET

/report/daily

Retrieve daily report for one month, can only get daily report for recent 6 months.

Request

Query

Name	Data Type	Description
`month`	integer	Month for this report
`year`	integer	Year for this report

Responses

200Daily Report Returned

Body

Name	Data Type	Description
`body`

Properties

`year`	integer	Year for this report
`month`	integer	Month for this report
`dates`	array []	Array of date objects

GET

/report/meetings/{meetingId}/participants

Retrieve ended meeting participants report

Request

Path

Name	Data Type	Description
`meetingId`	integer	The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.

Query

Name	Data Type	Description
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.

Responses

200Meeting Participants Report Returned

Body

Name	Data Type	Description
`body`

Properties

`participants`	array []	Array of meeting participant objects
`total_records`	integer	The number of all records available across pages.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`page_count`	integer	The number of items returned on this page.
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.

Extends

PaginationToken

Pagination Object

Properties

Name	Data Type	Description
`total_records`	integer	The number of all records available across pages.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`page_count`	integer	The number of items returned on this page.
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.

404Meeting not found

GET

/report/meetings/{meetingId}

Retrieve ended meeting details report

Request

Path

Name	Data Type	Description
`meetingId`	integer	The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.

Responses

200Meeting detail Returned

Body

Name	Data Type	Description
`body`

Properties

`uuid`	uuid	Meeting UUID
`user_name`	string	User display name
`user_email`	string	User email
`type`	integer	Meeting type
`total_minutes`	integer	Number of meeting minutes
`topic`	string	Meeting topic
`start_time`	dateTime	Meeting start time
`participants_count`	integer	Number of meeting participants
`id`	integer	Meeting ID
`end_time`	dateTime	Meeting end time
`duration`	integer	Meeting duration

404Meeting not found

GET

/report/telephone

Retrieve telephone report for a specified period

Request

Query

Name	Data Type	Description
`page_number`	integer Default value: `1`	Current page number of returned records.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`to`	date	End Date
`from`	date	Start Date
`type`	string Allowed values: - `1` - `2`	Audio type

Responses

200Telephone Report Returned

Body

Name	Data Type	Description
`body`

Properties

`telephony_usage`	array []	Array of telephony objects
`total_records`	integer	The number of all records available across pages.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`page_number`	integer Default value: `1`	The page number of current results.
`page_count`	integer	The number of items returned on this page.
`to`	date	End date for this report
`from`	date	Start date for this report

Extends

Pagination

Pagination Object

Properties

Name	Data Type	Description
`total_records`	integer	The number of all records available across pages.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`page_number`	integer Default value: `1`	The page number of current results.
`page_count`	integer	The number of items returned on this page.

GET

/report/users/{userId}/meetings

Retrieve ended meetings report for a specified period

Request

Path

Name	Data Type	Description
`userId`	string	The user ID or email address

Query

Name	Data Type	Description
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`to`	date	End Date
`from`	date	Start Date

Responses

200Active/Inactive Hosts Report Returned

Body

Name	Data Type	Description
`body`

Properties

`meetings`	array []	Array of meeting objects
`total_records`	integer	The number of all records available across pages.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`page_count`	integer	The number of items returned on this page.
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.
`to`	date	End date for this report
`from`	date	Start date for this report

Extends

PaginationToken

Pagination Object

Properties

Name	Data Type	Description
`total_records`	integer	The number of all records available across pages.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`page_count`	integer	The number of items returned on this page.
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.

404User not found

GET

/report/users

Retrieve active or inactive hosts report for a specified period

Request

Query

Name	Data Type	Description
`page_number`	integer Default value: `1`	Current page number of returned records.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`to`	date	End Date
`from`	date	Start Date
`type`	string Allowed values: - `active` - `inactive`	Active hosts or inactive hosts

Responses

200Active/Inactive Hosts Report Returned

Body

Name	Data Type	Description
`body`

Properties

`users`	array []	Array of user objects
`total_participants`	integer	Number of participants for this range
`total_meetings`	integer	Number of meetings for this range
`total_meeting_minutes`	integer	Number of meeting minutes for this range
`total_records`	integer	The number of all records available across pages.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`page_number`	integer Default value: `1`	The page number of current results.
`page_count`	integer	The number of items returned on this page.
`to`	date	End date for this report
`from`	date	Start date for this report

Extends

Pagination

Pagination Object

Properties

Name	Data Type	Description
`total_records`	integer	The number of all records available across pages.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`page_number`	integer Default value: `1`	The page number of current results.
`page_count`	integer	The number of items returned on this page.

GET

/report/webinars/{webinarId}/participants

Retrieve ended webinar participants report

Request

Path

Name	Data Type	Description
`webinarId`	integer	The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance.

Query

Name	Data Type	Description
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.

Responses

200Meeting Participants Report Returned

Body

Name	Data Type	Description
`body`

Properties

`participants`	array []	Array of webinar participant objects
`total_records`	integer	The number of all records available across pages.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`page_count`	integer	The number of items returned on this page.
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.

Extends

PaginationToken

Pagination Object

Properties

Name	Data Type	Description
`total_records`	integer	The number of all records available across pages.
`page_size`	integer Default value: `30` Maximum: 300	The amount of records returns within a single API call.
`page_count`	integer	The number of items returned on this page.
`next_page_token`	string	Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.

404Webinar not found

GET

/report/webinars/{webinarId}/polls

Retrieve ended webinar polls report

Request

Path

Name	Data Type	Description
`webinarId`	integer	The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance.

Responses

200Webinar Polls Report Returned

Body

Name	Data Type	Description
`body`

Properties

`uuid`	uuid	Webinar UUID
`start_time`	dateTime	Webinar start time
`questions`	array []	Array of webinar question objects
`id`	integer	Webinar ID

404Webinar not found

GET

/report/webinars/{webinarId}/qa

Retrieve ended webinar Q&A report

Request

Path

Name	Data Type	Description
`webinarId`	integer	The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance.

Responses

200Webinar Q&A Report Returned

Body

Name	Data Type	Description
`body`

Properties

`uuid`	uuid	Webinar UUID
`start_time`	dateTime	Webinar start time
`questions`	array []	Array of webinar question objects
`id`	integer	Webinar ID

404Webinar not found

GET

/report/webinars/{webinarId}

Retrieve ended webinar details report

Request

Path

Name	Data Type	Description
`webinarId`	integer	The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance.

Responses

200Webinar detail Returned

Body

Name	Data Type	Description
`body`

Properties

`uuid`	uuid	Meeting UUID
`user_name`	string	User display name
`user_email`	string	User email
`type`	integer	Meeting type
`total_minutes`	integer	Number of meeting minutes
`topic`	string	Meeting topic
`start_time`	dateTime	Meeting start time
`participants_count`	integer	Number of meeting participants
`id`	integer	Meeting ID
`end_time`	dateTime	Meeting end time
`duration`	integer	Meeting duration

404Webinar not found

GET

/tsp

DELETE

/users/{userId}/tsp/{tspId}

GET

/users/{userId}/tsp/{tspId}

Retrieve a user's TSP account

Request

Path

Name	Data Type	Description
`tspId`	string	TSP account index
`userId`	string	The user ID or email address

Responses

200TSP Account returned

Body

Name	Data Type	Description
`TSP`	object	TSP Account object

Properties

`leader_pin`	string	Leader PIN, numeric value, length is less than 16.
`dial_in_numbers`
`conference_code`	string	Conference code, numeric value, length is less than 16.

<

Resources

Accounts

Request

Path

Body

Properties

Responses

Request

Path

Responses

Body

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Request

Path

Body

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Responses

Request

Path

Responses

Request

Path

Responses

Body

Properties

Properties

Request

Query

Responses

Body

Properties

Extends

Properties

Properties

Request

Body

Properties

Properties

Responses

Header

Body

Properties

Billing

Request

Path

Responses

Body

Properties

Request

Path

Body

Properties

Responses

Request

Path

Body

Properties

Responses

Request

Path

Body