Module zoom_api::types

source ·
Expand description

The data types sent to and returned from the API client.

Structs

Enums

  • AccountPlanAddonCancelRequestAction
    The action that needs to be taken for this sub account. Value must be set to “cancel”.
  • AccountPlanAddonCreateRequestOneOf
    All of the following types:
  • AccountPlansResponsePlanBaseStatus
    Status of the plan.
  • AccountSettingsRecordingAuthenticationUpdateOptionAction
  • AccountSettingsRecordingAuthenticationUpdateOptionType
  • AccountSettingsResponseOneOf
    All of the following types:
  • AccountSettingsUpdateOption
  • AccountSettingsUpdateRequestOneOf
    All of the following types:
  • Action
    Update the status of a livestream.
  • AddSettingTemplateRequestType
    The type of template. Values include user, group, autoReceptionist, commonarea, or interop.
  • AnswerQuestions
    Indicate whether you want attendees to be able to view answered questions only or view all questions.
  • Audio
    Determine how participants can join the audio portion of the meeting.
    both - Both Telephony and VoIP.
    telephony - Telephony only.
    voip - VoIP only.
  • AudioQuality
    Audio quality of the participant.
  • AudioType
    Determine how participants can join the audio portion of the meeting.
    both - Telephony and VoIP.
    telephony - Audio PSTN telephony only.
    voip - VoIP only.
    thirdParty - 3rd party audio conference.
  • AutoRecording
    Automatic recording:
    local - Record on local.
    cloud - Record on cloud.
    none - Disabled.
  • CallType
    The type of call: *voip (Voice over IP) *pstn (Public Switched Telephone Network) *tollfree *international *contactCenter
  • CategoryType
    Optional
    Filter your response by a category type to see reports for a specific category. The value for this field can be one of the following:
    all
    user
    user_settings
    account
    billing
    im
    recording
    phone_contacts
    webinar
    sub_account
    role
    zoom_rooms
  • ChangeZoomRoomsAppVersionRequestAction
    Specify one of the following values for this field:
  • DashboardMeetingParticipantsIncludeFields
    Provide registrant_id as the value for this field if you would like to see the registrant ID attribute in the response of this API call. A registrant ID is a unique identifier of a meeting registrant. This is not supported for live meeting types.
  • DashboardMeetingParticipantsResponseDevice
    The type of device the participant used to join the meeting:
  • DashboardMeetingParticipantsResponseStatus
    Indicates whether the participant is in the waiting room or in the meeting.
  • DashboardMeetingsType
    Specify a value to get the response for the corresponding meeting type. The value of this field can be one of the following:

    past - Meeting that already occurred in the specified date range.
    pastOne - Past meetings that were attended by only one user.
    live - Live meetings.

  • DashboardWebinarsType
    The webinar type.
  • DeviceType
    Type of the device. The value of this field can be one of the following:
    Zoom Rooms Computer,
    Controller, Scheduling Display, Zoom Rooms Control System, Companion Whiteboard
  • Direction
    The direction of the call. Values: inbound or outbound.
  • Encryption
    Device encryption:
    auto - auto.
    yes - yes.
    no - no.
  • EncryptionType
    Choose between enhanced encryption and end-to-end encryption when starting or a meeting. When using end-to-end encryption, several features (e.g. cloud recording, phone/SIP/H.323 dial-in) will be automatically disabled.

    The value of this field can be one of the following:
    enhanced_encryption: Enhanced encryption. Encryption is stored in the cloud if you enable this option.
  • EntryExitChime
    Play sound when participants join or leave.
    host - Heard by host only.
    all - Heard by host and all attendees.
    none - Disable.
  • ExtensionType
    The type of assignee to whom the number is assigned. The value can be one of the following:
    user
    callQueue
    autoReceptionist
    commonAreaPhone
  • FieldName
    Field name of the question.
  • FileType
    The archived file’s file type:
  • GetAccountCloudRecordingResponseMeetingsFilesFileType
    The recording file type. The value of this field could be one of the following:
  • GetAccountCloudRecordingResponseMeetingsFilesStatus
    The status of the recording, either completed or processing.
  • GetAccountCloudRecordingResponseMeetingsFilesType
    The recording type. The value of this field can be one of the following:
  • GetChatMessagesResponseStatus
    This field indicates whether a message is an original message(unedited), an edited message or a deleted message.
  • GetCommonAreaPhoneResponsePolicyHotDeskingStatus
    Allow Hot Desking feature to current device.
  • GetDeviceResponseProvisionType
    Provisioning type. The value can be one of the following:
  • GetGroupLockSettingsResponseOneOf
    All of the following types:
  • GetGroupSettingsResponseOneOf
    All of the following types:
  • GetPhoneRecordingsResponseOwnerType
    The owner type: user or call queue.
  • GetSettingTemplateResponseType
    The type of template being queried. Values: user, group, auto receptionist common area,zr, interop.
  • GetSettingTemplateResponseUserSettingsCallHandlingBusinessHoursConnectOperatorType
    Values:
    1-user,
    2-callQueue,
    3-autoReceptionist,
    4-commonAreaPhone,
    5-zoomRoom,
    7-sharedLineGroup
  • GroupLockedSettingsRequestOneOf
    All of the following types:
  • HoldMusic
    The value of this field can be either default or disable.
  • ImChatSessionsResponseType
    IM chat session type.
  • ImGroupCreateRequestType
    IM Group types:
    normal - Only members can see automatically see the other members of this group. Other people can search for members within this group.
    shared - Everyone under an account can see the group members automatically.
    restricted - Nobody can see the group or search for members except the members in the group.
  • IncludeFields
    Set the value of this field to “tracking_fields” if you would like to include tracking fields of each meeting in the response.
  • Label
    The label to add to the user’s phone number. You can only add one label to the user’s phone number:
  • Languages
    Specify the language in which this phone number should be displayed. Currently, the only supported languages are en-GB, en-US, de-DE.
  • Level
    Level of the user. The value can be one of the following:
    manager: A call queue manager has the privilege to change call queue settings, policy settings and manage recordings and voicemail inbox. There can only be one manager for each call queue.

    user: Regular user without the privileges of a manager.
  • ListAccountPhoneNumbersResponseStatus
    Status of the number.
  • ListAccountPhoneNumbersType
    Query response by number assignment. The value can be one of the following:
    assigned: The number has been assigned to either a user, a call queue, an auto-receptionist or a common area phone in an account.
    unassigned: The number is not assigned to anyone.
    all: Include both assigned and unassigned numbers in the response.
    byoc: Include Bring Your Own Carrier (BYOC) numbers only in the response.
  • ListArchivedFilesQueryDateType
    The query date type for the from and to parameters.
  • ListPhoneDevicesResponseStatus
    Status of the device. The value is either online or offline.
  • ListPhoneDevicesType
    State of the device. The value should be either assigned to list devices that have been assigned to user(s) or unassigned to list devices that have not yet been assigned to any user in the Zoom account.
  • ListSettingTemplatesResponseType
    Template type.
    The value of this field can be one of the following:
  • ListZoomRoomsStatus
    The status of the Zoom Room.
  • ListZoomRoomsType
    Type of the Zoom Rooms.
  • ListZrDevicesResponseStatus
    Status of the device. The value can be either Online or Offline.
  • ListZrLocationsResponseType
    The type of location. The value can be one of the following: country, states, city, campus, building, floor.
  • LoginType
    The user’s login method:
  • MatchType
    Indicates the match type for the blocked list. The values can be one of the following:
    phoneNumber: Indicates that only a specific phone number that is shown in the phone_number field is blocked.

    prefix: Indicates that all numbers starting with prefix that is shown in the phone_number field are blocked.
  • MeetingPollCreateResponseStatus
    Status of the Meeting Poll:
    notstart - Poll not started
    started - Poll started
    ended - Poll ended
    sharing - Sharing poll results
  • MeetingRegistrantQuestionsCustomType
    Type of the question being asked.
  • MeetingRegistrantsStatus
    The registrant status:
    pending - Registrant’s status is pending.
    approved - Registrant’s status is approved.
    denied - Registrant’s status is denied.
  • MeetingStatusRequestAction
    end - End a meeting.
    recover - Recover a deleted meeting.
  • MeetingsType
    The meeting types:
    scheduled - This includes all valid past meetings (unexpired), live meetings and upcoming scheduled meetings. It is equivalent to the combined list of “Previous Meetings” and “Upcoming Meetings” displayed in the user’s Meetings page on the Zoom Web Portal.
    live - All the ongoing meetings.
    upcoming - All upcoming meetings including live meetings.
  • Method
    Specify whether to allow users from specific regions to join this meeting; or block users from specific regions from joining this meeting.

    approve: Allow users from specific regions/countries to join this meeting. If this setting is selected, the approved regions/countries must be included in the approved_list.

    deny: Block users from specific regions/countries from joining this meeting. If this setting is selected, the approved regions/countries must be included in the denied_list
  • NetworkType
    The participant’s network type:
  • OptionData
    Use the following options to filter the results of the account’s information:
  • PayMode
    Payee:
    master - master account holder pays.
    sub - Sub account holder pays.
  • PhoneUserCallLogsResponseForwardedByExtensionType
  • PhoneUserCallLogsType
  • PhoneUserVoiceMailsResponseStatus
    Status of the voice mail. Can be either ‘read’ or ‘unread’
  • PhoneUserVoiceMailsStatus
    Status of the voice mail
  • PlanRecordingStatus
    Status of additional Cloud Recording plan.
  • PollQuestionsType
    Poll Question & Answer type:
    single - Single choice
    mutliple - Multiple choice
  • PresenceStatus
    Presence status of the contact in Zoom Client. The value of this field can be one of the following: Do_Not_Disturb
    away
    Available
    Offline
  • Protocol
    Device protocol:
    H.323 - H.323.
    SIP - SIP.
  • Quality
    Feedback submitted by the participant.
  • QueryDateType
    Date types:
    start_time - Query by call start time.
    end_time - Query by call end time.
  • ReactMessageRequestAction
    The action to perform with the message:
  • RecordingCalls
    Values: inbound, outbound, both.
  • RecordingDeleteAction
    The recording delete actions:
    trash - Move recording to trash.
    delete - Delete recording permanently.
  • RecordingRegistrantQuestionsCustomType
    The type of registration question and answers.
  • RecordingRegistrantQuestionsFieldName
    Field name.
  • RecordingStatus
    The recording status.
  • RecordingStatusUpdateBodyRequestAction
  • RecordingType
    The archived file’s recording type:
  • RegistrantStatusAction
    Registrant Status:
    approve - Approve registrant.
    cancel - Cancel previously approved registrant’s registration.
    deny - Deny registrant.
  • ReportMeetingsType
    The meeting types:
    past - Past meetings.
    pastOne - Past one user meetings.
  • ReportUsersType
    Active or inactive hosts.
    active - Active hosts.
    inactive - Inactive hosts.
  • RequirePasswordPmiMeetings
    Require a password for a meeting held using Personal Meeting ID (PMI) This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts.
  • Result
    Result of the call: call_connected | recorded | no_answer.
  • Role
    The role of the member. The value can be one of these: owner, admin, member.
  • SettingType
    The type of setting that you would like to retrieve.
    alert: Alert Settings applied on the Zoom Rooms Account.
    meeting: Meeting settings of the Zoom Rooms Account.
    signage: View digital signage settings of the Zoom Rooms Account.
  • ShareRecording
    Determine how the meeting recording is shared.
  • SignInWithTwoFactorAuth
    Settings for 2FA( two factor authentication ). The value can be one of the following: all: Two factor authentication will be enabled for all users in the account.
    none: Two factor authentication is disabled.
    group: Two factor authentication will be enabled for users belonging to specific groups. If 2FA is enabled for certain groups, the group IDs of the group(s) will be provided in the sign_in_with_two_factor_auth_groups field.
    role: Two factor authentication will be enabled only for users assigned with specific roles in the account. If 2FA is enabled for specific roles, the role IDs will be provided in the sign_in_with_two_factor_auth_roles field.
  • Source
    Source of phone number.
  • Status
    Meeting status
  • TimeType
    Enables you to sort call logs by start or end time. Choose the sort time value. Values include startTime or endTime.
  • TransportProtocol
    Protocols supported by the SIP provider.
    The value must be either UDP, TCP, TLS, AUTO.
  • TspAccountsListDialInNumbersType
    Dial-in number types:
    toll - Toll number.
    tollfree -Toll free number.
    media_link - Media link.
  • TspBridge
    Telephony bridge
  • Type
    Type of number.
  • UpdateGroupMemberRequestAction
    The action to perform:
  • UpdateGroupSettingsOption
  • UpdateGroupSettingsRequestOneOf
    All of the following types:
  • UpdatePresenceStatusRequest
    Presence status of the user. The value can be set to one of the following:
  • UserCreateRequestAction
    Specify how to create the new user:
    create - User will get an email sent from Zoom. There is a confirmation link in this email. The user will then need to use the link to activate their Zoom account. The user can then set or change their password.
    autoCreate - This action is provided for the enterprise customer who has a managed domain. This feature is disabled by default because of the security risk involved in creating a user who does not belong to your domain.
    custCreate - Users created via this option do not have passwords and will not have the ability to log into the Zoom Web Portal or the Zoom Client. These users can still host and join meetings using the start_url and join_url respectively. To use this option, you must contact the ISV Platform Sales team at isv@zoom.us.
    ssoCreate - This action is provided for the enabled “Pre-provisioning SSO User” option. A user created in this way has no password. If not a basic user, a personal vanity URL using the user name (no domain) of the provisioning email will be generated. If the user name or PMI is invalid or occupied, it will use a random number or random personal vanity URL.
  • UserDeleteAction
    Delete action options:
    disassociate - Disassociate a user.
    delete- Permanently delete a user.
    Note: To delete pending user in the account, use disassociate
  • UserSettingsResponseOneOf
    All of the following types:
  • UserSettingsUpdateOption
  • UserSettingsUpdateRequestOneOf
    All of the following types:
  • UserStatusRequestAction
    The action types:
    activate - Activate a deactivated user.
    deactivate - Deactivate a user.
  • UserTokenType
    User token types:
    token - Used for starting meetings with the client SDK. This token expires in 14 days and a new token will be returned after the expiry.
    zak - Used for generating the start meeting URL. The token expiration time is two hours. For API users, the expiration time is 90 days.
  • UsersIncludeFields
    Use this parameter to display one of the following attributes in the API call’s response:
  • UsersStatus
    The user’s status:
  • WebinarStatusRequestAction
  • WeeklyDays
    This field is required if you’re scheduling a recurring meeting of type 2 to state which day(s) of the week the meeting should repeat.

    The value for this field could be a number between 1 to 7 in string format. For instance, if the meeting should recur on Sunday, provide "1" as the value of this field.

    Note: If you would like the meeting to occur on multiple days of a week, you should provide comma separated values for this field. For instance, if the meeting should recur on Sundays and Tuesdays provide "1,3" as the value of this field.
  • WhoCanShareScreen
    Indicates who can share their screen or content during meetings. The value can be one of the following:
    host: Only host can share the screen.
    all: Both hosts and attendees can share their screen during meetings. For Webinar, the hosts and panelists can start screen sharing, but not the attendees.