5.0.0 • Published 3 years ago

@datafire/zoom_us v5.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
3 years ago

@datafire/zoom_us

Client library for Zoom API

Installation and Usage

npm install --save @datafire/zoom_us
let zoom_us = require('@datafire/zoom_us').create({
  global: ""
});

.then(data => {
  console.log(data);
});

Description

API Description

Actions

accounts

List all the sub accounts under the master account

zoom_us.accounts({}, context)

Input

  • input object
    • page_size integer: The number of records returned within a single API call
    • page_number integer: Current page number of returned records

Output

accountCreate

Create a sub account under the master account. Your account must be a master account and have this privilege to create sub account. Zoom only assigns this privilege to trusted partners. The created user will not receive a confirmation email..

zoom_us.accountCreate({
  "body": {
    "email": "",
    "first_name": "",
    "last_name": "",
    "password": ""
  }
}, context)

Input

Output

  • output object
    • created_at string: Account created date time
    • id string: Account ID
    • owner_email string: Account owner email
    • owner_id string: Account Owner ID

accountDisassociate

Disassociate a sub account from the master account. This will leave the account intact but the sub account will not longer be associated with the master account.

zoom_us.accountDisassociate({
  "accountId": ""
}, context)

Input

  • input object
    • accountId required string: The account ID

Output

Output schema unknown

account

Retrieve a sub account under the master account. Your account must be a master account and have this privilege to read sub accounts. Zoom only assigns this privilege to trusted partners.

zoom_us.account({
  "accountId": ""
}, context)

Input

  • input object
    • accountId required string: The account ID

Output

  • output object
    • created_at string: Account creation date/time
    • id string: Account ID
    • options AccountOptions
    • owner_email string: Account Owner email
    • owner_id string: Account Owner ID
    • vanity_url string: Account Vanity URL

accountBilling

Retrieve billing information for a sub account under the master account

zoom_us.accountBilling({
  "accountId": ""
}, context)

Input

  • input object
    • accountId required string: The account ID

Output

accountBillingUpdate

Update billing information for a sub account under the master account Only for the sub account which is a paid account and paid by master account

zoom_us.accountBillingUpdate({
  "accountId": "",
  "body": {}
}, context)

Input

  • input object

Output

Output schema unknown

accountManagedDomain

Retrieve a sub account's managed domains under the master account

zoom_us.accountManagedDomain({
  "accountId": ""
}, context)

Input

  • input object
    • accountId required string: The account ID

Output

accountOptionsUpdate

Update a sub account's options under the master account

zoom_us.accountOptionsUpdate({
  "accountId": "",
  "body": {}
}, context)

Input

  • input object

Output

Output schema unknown

accountPlans

Retrieve plan information for a sub account under the master account Only for the sub account which is paid by master account

zoom_us.accountPlans({
  "accountId": ""
}, context)

Input

  • input object
    • accountId required string: The account ID

Output

accountPlanCreate

Subscribe plans for a sub account of the master account Can only subscribe plans for the sub account which is a free account and paid by master account

zoom_us.accountPlanCreate({
  "accountId": "",
  "body": null
}, context)

Input

  • input object
    • accountId required string: The account ID
    • body required
      • contact BillingContactRequired
      • plan_audio object: Additional Audio Conferencing plan type
        • callout_countries string: Call-out countries, multiple value separated by comma
        • ddi_numbers integer: Dedicated Dial-In Numbers
        • premium_countries string: Premium countries, multiple value separated by comma
        • tollfree_countries string: Toll-free countries, multiple value separated by comma
        • type string: Additional Audio Conferencing plan type
      • plan_base AccountPlanBaseRequired
      • plan_large_meeting array: Additional Large Meeting Plans
      • plan_recording string: Additional Cloud Recording Plan
      • plan_room_connector AccountPlan
      • plan_webinar array: Additional Webinar Plans
      • plan_zoom_rooms AccountPlan

Output

accountPlanAddonCreate

Add an additional plan for sub account Can only add an Additional plan for the sub account which is a paid account and paid by master account

zoom_us.accountPlanAddonCreate({
  "accountId": "",
  "body": {
    "type": "",
    "hosts": 0
  }
}, context)

Input

Output

Output schema unknown

accountPlanAddonUpdate

Update an additional plan for sub accountCan only update an Additional plan for the sub account which is a paid account and paid by master account

zoom_us.accountPlanAddonUpdate({
  "accountId": "",
  "body": {
    "type": "",
    "hosts": 0
  }
}, context)

Input

Output

Output schema unknown

accountPlanBaseUpdate

Update a base plan for a sub account Can only update a base plan for the sub account which is a paid account and paid by master account

zoom_us.accountPlanBaseUpdate({
  "accountId": "",
  "body": {
    "type": "",
    "hosts": 0
  }
}, context)

Input

Output

Output schema unknown

accountSettings

Retrieve a sub account's settings under the master account

zoom_us.accountSettings({
  "accountId": ""
}, context)

Input

  • input object
    • accountId required string: The account ID

Output

accountSettingsUpdate

Update a sub account's settings under the master account

zoom_us.accountSettingsUpdate({
  "accountId": "",
  "body": {}
}, context)

Input

  • input object

Output

Output schema unknown

groups

List groups under your account

zoom_us.groups(null, context)

Input

This action has no parameters

Output

groupCreate

Create a group under your account

zoom_us.groupCreate({
  "body": null
}, context)

Input

  • input object
    • body required object
      • name string: Group name

Output

  • output object
    • id string: Group ID
    • name string: Group name
    • total_members integer: Group member count

groupDelete

Delete a group under your account

zoom_us.groupDelete({
  "groupId": ""
}, context)

Input

  • input object
    • groupId required string: The group ID

Output

Output schema unknown

group

Retrieve a group under your account

zoom_us.group({
  "groupId": ""
}, context)

Input

  • input object
    • groupId required string: The group ID

Output

  • output
    • id string: Group ID
    • name string: Group name
    • total_members integer: Total number of members in this group

groupUpdate

Update a group under your account

zoom_us.groupUpdate({
  "groupId": "",
  "body": null
}, context)

Input

  • input object
    • groupId required string: The group ID
    • body required object
      • name string: Group name. Must be unique in one account. Character length is less than 128.

Output

Output schema unknown

groupMembers

List a group's members under your account

zoom_us.groupMembers({
  "groupId": ""
}, context)

Input

  • input object
    • groupId required string: The group ID
    • page_size integer: The number of records returned within a single API call
    • page_number integer: Current page number of returned records

Output

groupMembersCreate

Add members to a group under your account

zoom_us.groupMembersCreate({
  "groupId": "",
  "body": null
}, context)

Input

  • input object
    • groupId required string: The group ID
    • body required object
      • members array: List of Group members
        • items object
          • email string: User email. If ID given, email is ignored.
          • id string: User ID

Output

  • output object
    • added_at string
    • ids string

groupMembersDelete

Delete a member from a group under your account

zoom_us.groupMembersDelete({
  "groupId": "",
  "memberId": ""
}, context)

Input

  • input object
    • groupId required string: The group ID
    • memberId required string: The member ID

Output

Output schema unknown

deviceList

List H.323/SIP Devices on your Zoom account.

zoom_us.deviceList(null, context)

Input

This action has no parameters

Output

deviceCreate

Create a H.323/SIP Device on your Zoom account

zoom_us.deviceCreate({
  "body": {
    "name": "",
    "protocol": "",
    "ip": "",
    "encryption": ""
  }
}, context)

Input

  • input object

Output

  • output
    • id string: Device ID
    • encryption required string (values: auto, yes, no): Device encryption
    • ip required string: Device Ip
    • name required string: Device name
    • protocol required string (values: H.323, SIP): Device protocol

deviceDelete

Delete a H.323/SIP Device on your Zoom account

zoom_us.deviceDelete({
  "deviceId": ""
}, context)

Input

  • input object
    • deviceId required string: The device ID

Output

Output schema unknown

deviceUpdate

Update a H.323/SIP Device on your Zoom account

zoom_us.deviceUpdate({
  "deviceId": "",
  "body": {
    "name": "",
    "protocol": "",
    "ip": "",
    "encryption": ""
  }
}, context)

Input

  • input object
    • deviceId required string: The device ID
    • body required Device

Output

Output schema unknown

imChatSessions

Retrieve IM Chat sessions for a specified period This API only supports oauth2.

zoom_us.imChatSessions({
  "from": "",
  "to": ""
}, context)

Input

  • input object
    • from required string: Start Date
    • to required string: End Date
    • page_size integer: The number of records returned within a single API call
    • next_page_token string: Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.

Output

  • output
    • from string: Start date
    • to string: End date
    • 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: The amount of records returns within a single API call.
    • sessions array: Array of session objects
      • items object
        • last_message_sent_time string: Last message sent time
        • name string: Meeting topic
        • session_id string: IM Chat session ID
        • type string: IM Chat session type

imChatMessages

Retrieve IM Chat messages for a specified period This API only supports oauth2.

zoom_us.imChatMessages({
  "sessionId": "",
  "from": "",
  "to": ""
}, context)

Input

  • input object
    • sessionId required string: IM Chat Session ID
    • from required string: Start Date
    • to required string: End Date
    • page_size integer: The number of records returned within a single API call
    • next_page_token string: Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.

Output

  • output
    • from string: Start date
    • session_id string: IM Chat session ID
    • to string: End date
    • 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: The amount of records returns within a single API call.
    • messages array: Array of session objects
      • items object
        • action string: IM Chat message action
        • action_time string: Action time
        • date_time string: IM Chat message sent time
        • message string: IM Chat message content
        • sender string: IM Chat message sender

imGroups

List IM groups under your account

zoom_us.imGroups(null, context)

Input

This action has no parameters

Output

imGroupCreate

Create a IM Group under your account

zoom_us.imGroupCreate({
  "body": null
}, context)

Input

  • input object
    • body required object
      • name string: Group name, must be unique in one account
      • search_by_account boolean: Members can search others under same account
      • search_by_domain boolean: Members can search others in the same email domain
      • search_by_ma_account boolean: Members can search others under same master account, including all sub accounts
      • type string (values: normal, shared, restricted): IM Group type

Output

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

imGroupDelete

Delete an IM Group under your account

zoom_us.imGroupDelete({
  "groupId": ""
}, context)

Input

  • input object
    • groupId required string: The group ID

Output

Output schema unknown

imGroup

Retrieve an IM Group under your account

zoom_us.imGroup({
  "groupId": ""
}, context)

Input

  • input object
    • groupId required string: The group ID

Output

  • output
    • id string: Group ID
    • name string: Group name
    • total_members integer: Total number of members in this group
    • search_by_account boolean: Members can search others under same account
    • search_by_domain boolean: Members can search others in the same email domain
    • search_by_ma_account boolean: Members can search others under same master account, including all sub accounts
    • type string (values: normal, shared, restricted): IM Group type

imGroupUpdate

Update an IM Group under your account

zoom_us.imGroupUpdate({
  "groupId": "",
  "body": null
}, context)

Input

  • input object
    • groupId required string: The group ID
    • body required object
      • name string: Group name, must be unique in one account
      • search_by_account boolean: Members can search others under same account
      • search_by_domain boolean: Members can search others in the same email domain
      • search_by_ma_account boolean: Members can search others under same master account, including all sub accounts
      • type string (values: normal, shared, restricted): IM Group type

Output

Output schema unknown

imGroupMembers

List an IM Group's members under your account

zoom_us.imGroupMembers({
  "groupId": ""
}, context)

Input

  • input object
    • groupId required string: The group ID
    • page_size integer: The number of records returned within a single API call
    • page_number integer: Current page number of returned records

Output

imGroupMembersCreate

Add members to an IM Group under your account

zoom_us.imGroupMembersCreate({
  "groupId": "",
  "body": null
}, context)

Input

  • input object
    • groupId required string: The group ID
    • body required object
      • members array: List of IM Group members
        • items object
          • email string: User email. If ID given, email is ignored.
          • id string: User ID

Output

  • output object
    • added_at string
    • ids string

imGroupMembersDelete

Delete a member from an IM Group under your account

zoom_us.imGroupMembersDelete({
  "groupId": "",
  "memberId": ""
}, context)

Input

  • input object
    • groupId required string: The group ID
    • memberId required string: The member ID

Output

Output schema unknown

meetingDelete

Delete a meeting

zoom_us.meetingDelete({
  "meetingId": 0
}, context)

Input

  • input object
    • meetingId required integer: The meeting ID
    • occurrence_id string: The meeting occurrence ID

Output

Output schema unknown

meeting

Retrieve a meeting's details

zoom_us.meeting({
  "meetingId": 0
}, context)

Input

  • input object
    • meetingId required integer: The meeting ID

Output

  • output
    • host_id string: ID of the user set as host of meeting
    • id string: Meeting ID, also know as meeting number
    • uuid string: Meeting unique ID
    • agenda string: Agenda
    • created_at string: Create time
    • duration integer: Meeting duration
    • h323_password string: H.323/SIP room system password
    • join_url string: Join url
    • occurrences Occurrences
    • password string: Meeting password
    • settings MeetingSettings
    • start_time string: Meeting start time
    • start_url string: Start url
    • timezone string: Timezone to format start_time
    • topic string: Meeting topic
    • tracking_fields array: Tracking fields
      • items object
        • field string: Tracking fields type
        • value string: Tracking fields value
    • type integer (values: 1, 2, 3, 8): Meeting Type

meetingUpdate

Update a meeting's details

zoom_us.meetingUpdate({
  "meetingId": 0,
  "body": null
}, context)

Input

  • input object
    • meetingId required integer: The meeting ID
    • body required
      • schedule_for string: Email or userId if you want to schedule meeting for another user.
      • agenda string: Meeting description
      • duration integer: Meeting duration (minutes). Used for scheduled meetings only
      • password string: Password to join the meeting. Password may only contain the following characters: a-z A-Z 0-9 @ - _ *. Max of 10 characters.
      • recurrence Recurrence
      • settings
        • alternative_hosts string: Alternative hosts emails or IDs. Multiple value separated by comma.
        • approval_type integer (values: 0, 1, 2)
        • audio string (values: both, telephony, voip): Determine how participants can join the audio portion of the meeting
        • auto_recording string (values: local, cloud, none)
        • close_registration boolean: Close registration after event date
        • cn_meeting boolean: Host meeting in China
        • enforce_login boolean: Only signed-in users can join this meeting
        • enforce_login_domains string: Only signed-in users with specified domains can join meetings
        • host_video boolean: Start video when host joins meeting
        • in_meeting boolean: Host meeting in India
        • join_before_host boolean: Allow participants to join the meeting before the host starts the meeting. Only used for scheduled or recurring meetings.
        • mute_upon_entry boolean: Mute participants upon entry
        • participant_video boolean: Start video when participants join meeting
        • registration_type integer (values: 1, 2, 3): Registration type. Used for recurring meeting with fixed time only.
        • use_pmi boolean: Use Personal Meeting ID. Only used for scheduled meetings and recurring meetings with no fixed time.
        • waiting_room boolean: Enable waiting room
        • watermark boolean: Add watermark when viewing shared screen
        • registrants_confirmation_email boolean: Send confirmation Email to Registrants
      • start_time string: Meeting start time. When using a format like "yyyy-MM-dd'T'HH:mm:ss'Z'", always use GMT time. When using a format like "yyyy-MM-dd'T'HH:mm:ss", you should use local time and you will need to specify the time zone. Only used for scheduled meetings and recurring meetings with fixed time.
      • timezone string: Timezone to format start_time. For example, "America/Los_Angeles". For scheduled meetings only. Please reference our timezone list for supported timezones and their formats.
      • topic string: Meeting topic
      • tracking_fields array: Tracking fields
        • items object
          • field string: Tracking fields type
          • value string: Tracking fields value
      • type integer (values: 1, 2, 3, 8): Meeting Type

Output

Output schema unknown

meetingInvitation

Retrieve a meeting invitation

zoom_us.meetingInvitation({
  "meetingId": 0
}, context)

Input

  • input object
    • meetingId required integer: The meeting ID

Output

meetingLiveStreamUpdate

Update a meeting's live stream

zoom_us.meetingLiveStreamUpdate({
  "meetingId": 0,
  "body": {
    "stream_url": "",
    "stream_key": ""
  }
}, context)

Input

  • input object

Output

Output schema unknown

meetingLiveStreamStatusUpdate

Update a meeting's live stream status

zoom_us.meetingLiveStreamStatusUpdate({
  "meetingId": 0,
  "body": {}
}, context)

Input

Output

Output schema unknown

meetingPolls

List polls of a meeting

zoom_us.meetingPolls({
  "meetingId": 0
}, context)

Input

  • input object
    • meetingId required integer: The meeting ID

Output

meetingPollCreate

Create a poll for a meeting

zoom_us.meetingPollCreate({
  "meetingId": 0,
  "body": null
}, context)

Input

  • input object
    • meetingId required integer: The meeting ID
    • body required
      • questions array: Array of Polls
        • items object
          • answers array: Question answers
            • items string
          • name string: Question name
          • type string (values: single, multiple): Question type
      • title string: Poll Title

Output

  • output
    • id string: Meeting Poll ID
    • status string (values: notstart, started, ended, sharing): Status of the Meeting Poll
    • questions array: Array of Polls
      • items object
        • answers array: Question answers
          • items string
        • name string: Question name
        • type string (values: single, multiple): Question type
    • title string: Poll Title

meetingPollDelete

Delete a meeting's Poll

zoom_us.meetingPollDelete({
  "meetingId": 0,
  "pollId": ""
}, context)

Input

  • input object
    • meetingId required integer: The meeting ID
    • pollId required string: The poll ID

Output

Output schema unknown

meetingPollGet

Retrieve a meeting's poll

zoom_us.meetingPollGet({
  "meetingId": 0,
  "pollId": ""
}, context)

Input

  • input object
    • meetingId required integer: The meeting ID
    • pollId required string: The poll ID

Output

  • output
    • id string: Meeting Poll ID
    • status string (values: notstart, started, ended, sharing): Status of the Meeting Poll
    • questions array: Array of Polls
      • items object
        • answers array: Question answers
          • items string
        • name string: Question name
        • type string (values: single, multiple): Question type
    • title string: Poll Title

meetingPollUpdate

Update a meeting's poll

zoom_us.meetingPollUpdate({
  "meetingId": 0,
  "pollId": "",
  "body": null
}, context)

Input

  • input object
    • meetingId required integer: The meeting ID
    • pollId required string: The poll ID
    • body required
      • questions array: Array of Polls
        • items object
          • answers array: Question answers
            • items string
          • name string: Question name
          • type string (values: single, multiple): Question type
      • title string: Poll Title

Output

Output schema unknown

recordingDelete

Delete a meeting's recordings

zoom_us.recordingDelete({
  "meetingId": ""
}, context)

Input

  • input object
    • meetingId required string: The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.
    • action string (values: trash, delete): The recording delete action

Output

Output schema unknown

recordingGet

Retrieve a meeting’s all recordings

zoom_us.recordingGet({
  "meetingId": ""
}, context)

Input

  • input object
    • meetingId required string: The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.

Output

  • output
    • account_id string: ID of the user account
    • duration integer: Meeting duration
    • host_id string: ID of the user set as host of meeting
    • id string: Meeting ID, also know as meeting number
    • recording_count string: Recording count
    • start_time string: Meeting start time
    • topic string: Meeting topic
    • total_size string: Total size
    • uuid string: Meeting unique ID
    • recording_files array: List of Recording file
      • items
        • deleted_time string: The recording delete time. Response in trash query.
        • download_url string: The recording download url. Response in general query.
        • file_size number: The recording file size.
        • file_type string: The recording file type.
        • id string: The recording file ID.Response in general query.
        • meeting_id string: The meeting ID.
        • play_url string: The recording file play url. Response in general query.
        • recording_end string: The recording end time. Response in general query.
        • recording_start string: The recording start time.
        • recording_type string: The recording file type.
        • status string: The recording status. Response in general query.

recordingSettingUpdate

Retrieve a meeting recording's settings

zoom_us.recordingSettingUpdate({
  "meetingId": ""
}, context)

Input

  • input object
    • meetingId required string: The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.

Output

recordingSettingsUpdate

Update a meeting recording's settings

zoom_us.recordingSettingsUpdate({
  "meetingId": "",
  "body": {}
}, context)

Input

  • input object
    • meetingId required string: The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.
    • body required RecordingSettings

Output

Output schema unknown

recordingStatusUpdate

Recover a meeting's recordings

zoom_us.recordingStatusUpdate({
  "meetingId": "",
  "body": null
}, context)

Input

  • input object
    • meetingId required string: The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.
    • body required object
      • action string (values: recover)

Output

Output schema unknown

recordingDeleteOne

Delete one meeting recording file

zoom_us.recordingDeleteOne({
  "meetingId": "",
  "recordingId": ""
}, context)

Input

  • input object
    • meetingId required string: The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.
    • recordingId required string: The recording ID
    • action string (values: trash, delete): The recording delete action

Output

Output schema unknown

recordingStatusUpdateOne

Recover a single recording

zoom_us.recordingStatusUpdateOne({
  "meetingId": "",
  "recordingId": "",
  "body": null
}, context)

Input

  • input object
    • meetingId required string: The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.
    • recordingId required string: The recording ID
    • body required object
      • action string (values: recover)

Output

Output schema unknown

meetingRegistrants

List registrants of a meeting

zoom_us.meetingRegistrants({
  "meetingId": 0
}, context)

Input

  • input object
    • meetingId required integer: The meeting ID
    • occurrence_id string: The meeting occurrence ID
    • status string (values: pending, approved, denied): The registrant status
    • page_size integer: The number of records returned within a single API call
    • page_number integer: Current page number of returned records

Output

meetingRegistrantCreate

Register a participant for a meeting

zoom_us.meetingRegistrantCreate({
  "meetingId": 0,
  "body": {
    "email": "",
    "first_name": "",
    "last_name": ""
  }
}, context)

Input

  • input object
    • meetingId required integer: The meeting ID
    • occurrence_ids string: Occurrence IDs. You can find these with the meeting get API. Multiple values separated by comma.
    • body required MeetingRegistrant

Output

  • output object
    • id string: Registrant ID
    • join_url string: Join URL for this registrant
    • registrant_id string: Registrant ID
    • start_time string: Start time
    • topic string: Topic

meetingRegistrantStatus

Update a meeting registrant's status

zoom_us.meetingRegistrantStatus({
  "meetingId": 0,
  "body": {
    "action": ""
  }
}, context)

Input

  • input object
    • meetingId required integer: The meeting ID
    • occurrence_id string: The meeting occurrence ID
    • body required RegistrantStatus

Output

Output schema unknown

meetingStatus

Update a meeting's status

zoom_us.meetingStatus({
  "meetingId": 0,
  "body": null
}, context)

Input

  • input object
    • meetingId required integer: The meeting ID
    • body required object
      • action string (values: end)

Output

Output schema unknown

dashboardCRC

Get CRC Port usage hour by hour for a specified time period We will report a maximum of one month. For example, if "from" is set to "2017-08-05" and "to" is "2017-10-10" we will adjust "from" to "2017-09-10".

zoom_us.dashboardCRC({
  "from": "",
  "to": ""
}, context)

Input

  • input object
    • from required string: Start Date
    • to required string: End Date

Output

  • output
    • from string: Start date for this report
    • to string: End date for this report
    • crc_ports_usage array
      • items object
        • crc_ports_hour_usage array
          • items object
            • hour string
            • max_usage integer
            • total_usage integer
        • date_time string: Date and time

dashboardIM

Retrieve metrics of Zoom IM

zoom_us.dashboardIM({
  "from": "",
  "to": ""
}, context)

Input

  • input object
    • from required string: Start Date
    • to required string: End Date
    • page_size integer: The number of records returned within a single API call
    • next_page_token string: Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.

Output

  • output
    • from string: Start date for this report
    • to string: End date for this report
    • next_page_token string: Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.
    • page_count integer: The number of items returned on this page
    • page_size integer: The number of records returned within a single API call.
    • total_records integer: The number of all records available across pages
    • users array
      • items object
        • calls_receive integer
        • calls_send integer
        • email string: User email
        • emoji_receive integer
        • emoji_send integer
        • files_receive integer
        • files_send integer
        • group_receive integer
        • group_send integer
        • images_receive integer
        • images_send integer
        • total_receive integer
        • total_send integer
        • user_id string: User ID
        • user_name string: User display name
        • videos_receive integer
        • videos_send integer
        • voice_receive integer
        • voice_send integer

dashboardMeetings

List live meetings or past meetings for a specified period

zoom_us.dashboardMeetings({
  "from": "",
  "to": ""
}, context)

Input

  • input object
    • type string (values: past, pastOne, live): The meeting type
    • from required string: Start Date
    • to required string: End Date
    • page_size integer: The number of records returned within a single API call
    • next_page_token string: Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.

Output

  • output
    • from string: Start date for this report
    • to string: End date for this report
    • next_page_token string: Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.
    • page_count integer: The number of items returned on this page
    • page_size integer: The number of records returned within a single API call.
    • total_records integer: The number of all records available across pages
    • meetings array: Array of meeting objects

dashboardMeetingDetail

Retrieve live or past meetings detail

zoom_us.dashboardMeetingDetail({
  "meetingId": ""
}, context)

Input

  • input object
    • meetingId required string: The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.
    • type string (values: past, pastOne, live): The meeting type

Output

dashboardMeetingParticipants

Retrieve live or past meetings participants

zoom_us.dashboardMeetingParticipants({
  "meetingId": ""
}, context)

Input

  • input object
    • meetingId required string: The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.
    • type string (values: past, pastOne, live): The meeting type
    • page_size integer: The number of records returned within a single API call
    • next_page_token string: Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.

Output

  • output
    • next_page_token string: Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.
    • page_count integer: The number of items returned on this page
    • page_size integer: The number of records returned within a single API call.
    • total_records integer: The number of all records available across pages
    • participants array: Array of user objects
      • items object
        • connection_type string: Participant connection type
        • data_center string: Participant data center
        • device string: Participant device
        • domain string: Participant domain
        • harddisk_id string: Participant hard disk id
        • id string: Participant UUID
        • ip_address string: Participant IP Address
        • join_time string: Participant join time
        • leave_time string: Participant leave time
        • location string: Participant location
        • mac_addr string: Participant MAC Address
        • microphone string: Participant microphone
        • network_type string: Participant network type
        • pc_name string: Participant PC name
        • recording boolean: Participant record
        • share_application boolean: Did participant share application
        • share_desktop boolean: Did participant share desktop
        • share_whiteboard boolean: Did participant share whiteboard
        • speaker string: Participant speaker
        • user_id string: Participant ID
        • user_name string: Participant display name
        • version string: Participant version

dashboardMeetingParticipantsQOS

Retrieve list of live or past meetings participants quality of service

zoom_us.dashboardMeetingParticipantsQOS({
  "meetingId": ""
}, context)

Input

  • input object
    • meetingId required string: The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.
    • type string (values: past, live): The meeting type
    • page_size integer: Number of items returned per page
    • next_page_token string: Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.

Output

dashboardMeetingParticipantShare

Retrieve sharing/recording details of live or past meetings participant

zoom_us.dashboardMeetingParticipantShare({
  "meetingId": ""
}, context)

Input

  • input object
    • meetingId required string: The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.
    • type string (values: past, live): The meeting type
    • page_size integer: The number of records returned within a single API call
    • next_page_token string: Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.

Output

  • output
    • next_page_token string: Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.
    • page_count integer: The number of items returned on this page
    • page_size integer: The number of records returned within a single API call.
    • total_records integer: The number of all records available across pages
    • participants array: Array of participants
      • items object
        • details array: Array of sharing and recording details
          • items object
            • content string: Type of content shared
            • end_time string: End time of sharing
            • start_time string: Start time of sharing
        • id string: Participant UUID
        • user_id string: Participant ID
        • user_name string: Participant display name

dashboardMeetingParticipantQOS

Retrieve live or past meetings participant quality of service

zoom_us.dashboardMeetingParticipantQOS({
  "meetingId": "",
  "participantId": ""
}, context)

Input

  • input object
    • meetingId required string: The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.
    • participantId required string: Participant ID
    • type string (values: past, live): The meeting type

Output

dashboardWebinars

List live webinars or past webinars for a specified period

zoom_us.dashboardWebinars({
  "from": "",
  "to": ""
}, context)

Input

  • input object
    • type string (values: past, pastOne, live): The webinar type
    • from required string: Start Date
    • to required string: End Date
    • page_size integer: The number of records returned within a single API call
    • next_page_token string: Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.

Output

  • output
    • from string: Start date for this report
    • to string: End date for this report
    • next_page_token string: Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.
    • page_count integer: The number of items returned on this page
    • page_size integer: The number of records returned within a single API call.
    • total_records integer: The number of all records available across pages
    • webinars array: Array of webinar objects

dashboardWebinarDetail

Retrieve live or past webinars detail

zoom_us.dashboardWebinarDetail({
  "webinarId": ""
}, context)

Input

  • input object
    • webinarId required string: The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance.
    • type string (values: past, live): The webinar type

Output

dashboardWebinarParticipants

Retrieve live or past webinar participants

zoom_us.dashboardWebinarParticipants({
  "webinarId": ""
}, context)

Input

  • input object
    • webinarId required string: The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance.
    • type string (values: past, live): The webinar type
    • page_size integer: The number of records returned within a single API call
    • next_page_token string: Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.

Output

  • output
    • next_page_token string: Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.
    • page_count integer: The number of items returned on this page
    • page_size integer: The number of records returned within a single API call.
    • total_records integer: The number of all records available across pages
    • participants array: Array of user objects
      • items object
        • connection_type string: Participant connection type
        • data_center string: Participant data center
        • device string: Participant device
        • domain string: Participant domain
        • harddisk_id string: Participant hard disk id
        • id string: Participant UUID
        • ip_address string: Participant IP Address
        • join_time string: Participant join time
        • leave_time string: Participant leave time
        • location string: Participant location
        • mac_addr string: Participant MAC Address
        • microphone string: Participant microphone
        • network_type string: Participant network type
        • pc_name string: Participant PC name
        • recording boolean: Participant record
        • share_application boolean: Did participant share application
        • share_desktop boolean: Did participant share desktop
        • share_whiteboard boolean: Did participant share whiteboard
        • speaker string: Participant speaker
        • user_id string: Participant ID
        • user_name string: Participant display name
        • version string: Participant version

dashboardWebinarParticipantsQOS

Retrieve list of live or past webinar participants quality of service

zoom_us.dashboardWebinarParticipantsQOS({
  "webinarId": ""
}, context)

Input

  • input object
    • webinarId required string: The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance.
    • type string (values: past, live): The webinar type
    • page_size integer: Number of items returned per page
    • next_page_token string: Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.

Output

dashboardWebinarParticipantShare

Retrieve sharing/recording details of live or past webinar participant

zoom_us.dashboardWebinarParticipantShare({
  "webinarId": ""
}, context)

Input

  • input object
    • webinarId required string: The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance.
    • type string (values: past, live): The webinar type
    • page_size integer: The number of records returned within a single API call
    • next_page_token string: Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.

Output

  • output
    • next_page_token string: Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.
    • page_count integer: The number of items returned on this page
    • page_size integer: The number of records returned within a single API call.
    • total_records integer: The number of all records available across pages
    • participants array: Array of participants
      • items object
        • details array: Array of sharing and recording details
          • items object
            • content string: Type of content shared
            • end_time string: End time of sharing
            • start_time string: Start time of sharing
        • id string: Participant UUID
        • user_id string: Participant ID
        • user_name string: Participant display name

dashboardWebinarParticipantQOS

Retrieve live or past webinar participant quality of service

zoom_us.dashboardWebinarParticipantQOS({
  "webinarId": "",
  "participantId": ""
}, context)

Input

  • input object
    • webinarId required string: The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance.
    • participantId required string: Participant ID
    • type string (values: past, live): The webinar type

Output

dashboardZoomRooms

List all zoom rooms on account

zoom_us.dashboardZoomRooms({}, context)

Input

  • input object
    • page_size integer: The number of records returned within a single API call
    • page_number integer: Current page number of returned records

Output

dashboardZoomRoom

Retrieve zoom room on account

zoom_us.dashboardZoomRoom({
  "zoomroomId": "",
  "from": "",
  "to": ""
}, context)

Input

  • input object
    • zoomroomId required string: The Zoom Room ID
    • from required string: Start Date
    • to required string: End Date
    • page_size integer: The number of records returned within a single API call
    • page_number integer: Current page number of returned records

Output

  • output
    • account_type string: Zoom Room email type
    • calender_name string: Zoom Calendar name
    • camera string: Zoom Room camera
    • device_ip string: Zoom Room device IP
    • email string: Zoom Room email
    • id string: Zoom Room ID
    • last_start_time string: Zoom Room last start time
    • microphone string: Zoom Room microphone
    • room_name string: Zoom Room name
    • speaker string: Zoom Room speaker
    • status string: Zoom Room status
    • live_meeting MeetingMetric
    • past_meetings object
      • from string: Start date for this report
      • to string: End date for this report
      • next_page_token string: Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.
      • page_count integer: The number of items returned on this page
      • page_size integer: The number of records returned within a single API call.
      • total_records integer: The number of all records available across pages
      • meetings array: Array of meeting objects

pastMeetings

List of ended meeting instances

zoom_us.pastMeetings({
  "meetingId": 0
}, context)

Input

  • input object
    • meetingId required integer: The meeting ID

Output

pastMeetingDetails

Retrieve ended meeting details

zoom_us.pastMeetingDetails({
  "meetingUUID": ""
}, context)

Input

  • input object
    • meetingUUID required string: The meeting UUID.

Output

  • output object
    • duration integer: Meeting duration
    • end_time string: Meeting end time
    • host_id integer: Host ID
    • id integer: Meeting ID
    • participants_count integer: Number of meeting participants
    • start_time string: Meeting start time
    • topic string: Meeting topic
    • total_minutes integer: Number of meeting minutes
    • type integer: Meeting type
    • user_email string: User email
    • user_name string: User display name
    • uuid string: Meeting UUID

pastMeetingParticipants

Retrieve ended meeting participants

zoom_us.pastMeetingParticipants({
  "meetingUUID": ""
}, context)

Input

  • input object
    • meetingUUID required string: The meeting UUID.
    • page_size integer: The number of records returned within a single API call
    • next_page_token string: Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.

Output

  • output
    • next_page_token string: Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.
    • page_count integer: The number of items returned on this page
    • page_size integer: The number of records returned within a single API call.
    • total_records integer: The number of all records available across pages
    • participants array: Array of meeting participant objects
      • items object
        • id string: Participant UUID
        • name string: Participant display name

pastWebinars

List of ended webinar instances

zoom_us.pastWebinars({
  "webinarId": 0
}, context)

Input

  • input object
    • webinarId required integer: The webinar ID

Output

reportCloudRecording

Retrieve cloud recording usage report for a specified period. You can only get cloud recording reports for the most recent period of 6 months. The date gap between from and to dates should be smaller or equal to 30 days.

zoom_us.reportCloudRecording({
  "from": "",
  "to": ""
}, context)

Input

  • input object
    • from required string: Start Date
    • to required string: End Date

Output

  • output
    • from string: Start date for this report
    • to string: End date for this report
    • cloud_recording_storage array: Array of cloud usage objects
      • items object
        • date string
        • free_usage string
        • plan_usage string
        • usage string

reportDaily

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

zoom_us.reportDaily({}, context)

Input

  • input object
    • year integer: Year for this report
    • month integer: Month for this report

Output

  • output object
    • dates array: Array of date objects
      • items object
        • date string: Date for this object
        • meeting_minutes integer: Number of meeting minutes on this date
        • meetings integer: Number of meetings on this date
        • new_users integer: Number of new users on this date
        • participants integer: Number of participants on this date
    • month integer: Month for this report
    • year integer: Year for this report

reportMeetingDetails

Retrieve ended meeting details report

zoom_us.reportMeetingDetails({
  "meetingId": ""
}, context)

Input

  • input object
    • meetingId required string: The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.

Output

  • output object
    • duration integer: Meeting duration
    • end_time string: Meeting end time
    • id integer: Meeting ID
    • participants_count integer: Number of meeting participants
    • start_time string: Meeting start time
    • topic string: Meeting topic
    • total_minutes integer: Number of meeting minutes
    • tracking_fields array: Tracking fields
      • items object
        • field string: Tracking fields type
        • value string: Tracking fields value
    • type integer: Meeting type
    • user_email string: User email
    • user_name string: User display name
    • uuid string: Meeting UUID

reportMeetingParticipants

Retrieve ended meeting participants report

zoom_us.reportMeetingParticipants({
  "meetingId": ""
}, context)

Input

  • input object
    • meetingId required string: The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.
    • page_size integer: The number of records returned within a single API call
    • next_page_token string: Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.

Output

  • output
    • next_page_token string: Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.
    • page_count integer: The number of items returned on this page
    • page_size integer: The number of records returned within a single API call.
    • total_records integer: The number of all records available across pages
    • participants array: Array of meeting participant objects
      • items object
        • attentiveness_score integer: Participant attentiveness score
        • duration integer: Participant duration
        • id string: Participant UUID
        • join_time string: Participant join time
        • leave_time string: Participant leave time
        • name string: Participant display name
        • user_email string: Participant email
        • user_id string: Participant ID

reportMeetingPolls

Retrieve ended meeting polls report

zoom_us.reportMeetingPolls({
  "meetingId": ""
}, context)

Input

  • input object
    • meetingId required string: The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.

Output

  • output object
    • id integer: Meeting ID
    • questions array: Array of Meeting question objects
      • items object
        • email string: Participant email
        • name string: Participant display name
        • question_details array: Array of questions from user
          • items object
            • answer string: Given answer
            • question string: Asked question
    • start_time string: Meeting start time
    • uuid string: Meeting UUID

reportTelephone

Retrieve telephone report for a specified period Toll Report option would be removed..

zoom_us.reportTelephone({
  "from": "",
  "to": ""
}, context)

Input

  • input object
    • type string (values: 1): Audio type
    • from required string: Start Date
    • to required string: End Date
    • page_size integer: The number of records returned within a single API call
    • page_number integer: Current page number of returned records

Output

  • output
    • from string: Start date for this report
    • to string: End date for this report
    • page_count integer: The number of items returned on this page
    • page_number integer: The page number of current results
    • page_size integer: The number of records returned within a single API call
    • total_records integer: The number of all records available across pages
    • telephony_usage array: Array of telephony objects
      • items object
        • call_in_number string: Call in number
        • country_name string: Country Name
        • dept string: User department
        • duration integer: Meeting duration
        • end_time string: Meeting end time
        • host_email string: User email
        • host_name string: User display name
        • meeting_id integer: Meeting ID
        • meeting_type string: Meeting Type
        • phone_number string: Telephone Number
        • start_time string: Meeting start time
        • total number: Total

reportUsers

Retrieve active or inactive hosts report for a specified period

zoom_us.reportUsers({
  "from": "",
  "to": ""
}, context)

Input

  • input object
    • type string (values: active, inactive): Active hosts or inactive hosts
    • from required string: Start Date
    • to required string: End Date
    • page_size integer: The number of records returned within a single API call
    • page_number integer: Current page number of returned records

Output

  • output
    • from string: Start date for this report
    • to string: End date for this report
    • page_count integer: The number of items returned on this page
    • page_number integer: The page number of current results
    • page_size integer: The number of records returned within a single API call
    • total_records integer: The number of all records available across pages
    • total_meeting_minutes integer: Number of meeting minutes for this range
    • total_meetings integer: Number of meetings for this range
    • total_participants integer: Number of participants for this range
    • users array: Array of user objects
      • items object
        • dept string: User department
        • email string: User email
        • id string: User ID
        • meeting_minutes integer: Number of meeting minutes for user
        • meetings integer: Number of meetings for user
        • participants integer: Number of participants in meetings for user
        • type integer: User type
        • user_name string: User display name

reportMeetings

Retrieve ended meetings report for a specified period

zoom_us.reportMeetings({
  "userId": "",
  "from": "",
  "to": ""
}, context)

Input

  • input object
    • userId required string: The user ID or email address
    • from required string: Start Date
    • to required string: End Date
    • page_size integer: The number of records returned within a single API call
    • next_page_token string: Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.

Output

  • output
    • from string: Start date for this report
    • to string: End date for this report
    • next_page_token string: Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.
    • page_count integer: The number of items returned on this page
    • page_size integer: The number of records returned within a single API call.
    • total_records integer: The number of all records available across pages
    • meetings array: Array of meeting objects
      • items object
        • duration integer: Meeting duration
        • end_time string: Meeting end time
        • id integer: Meeting ID
        • participants_count integer: Number of meeting participants
        • start_time string: Meeting start time
        • topic string: Meeting topic
        • total_minutes integer: Number of meeting minutes
        • type integer: Meeting type
        • user_email string: User email
        • user_name string: User display name
        • uuid string: Meeting UUID

reportWebinarDetails

Retrieve ended webinar details report

zoom_us.reportWebinarDetails({
  "webinarId": ""
}, context)

Input

  • input object
    • webinarId required string: The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance.

Output

  • output object
    • duration integer: Meeting duration
    • end_time string: Meeting end time
    • id integer: Meeting ID
    • participants_count integer: Number of meeting participants
    • start_time string: Meeting start time
    • topic string: Meeting topic
    • total_minutes integer: Number of meeting minutes
    • tracking_fields array: Tracking fields
      • items object
        • field string: Tracking fields type
        • value string: Tracking fields value
    • type integer: Meeting type
    • user_email string: User email
    • user_name string: User display name
    • uuid string: Meeting UUID

reportWebinarParticipants

Retrieve ended webinar participants report

zoom_us.reportWebinarParticipants({
  "webinarId": ""
}, context)

Input

  • input object
    • webinarId required string: The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance.
    • page_size integer: The number of records returned within a single API call
    • next_page_token string: Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.

Output

  • output
    • next_page_token string: Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.
    • page_count integer: The number of items returned on this page
    • page_size integer: The number of re
datafire
@everything-registry/sub-chunk-223@infinitebrahmanuniverse/nolb-_datafire_z@zalastax/nolb-_datafire_z
5.0.0

3 years ago

4.0.0

6 years ago

3.0.0

6 years ago