Zoom


API Description

HOST
api.zoom.us

Accounts


Account operations

List sub accounts


List all the sub accounts under the master account.

Parameters

  • page_size integer

    The amount of records returns within a single API call.

  • page_number integer

    Current page number of returned records.

get - /accounts
200 - Account list returned
{
  "page_count": 123,
  "page_number": 123,
  "page_size": 123,
  "total_records": 123,
  "accounts": [
    {
      "account_name": "string",
      "account_type": "string",
      "created_at": "string",
      "id": "string",
      "owner_email": "string",
      "seats": 123,
      "subscription_end_time": "string",
      "subscription_start_time": "string"
    },
    {
      "account_name": "string",
      "account_type": "string",
      "created_at": "string",
      "id": "string",
      "owner_email": "string",
      "seats": 123,
      "subscription_end_time": "string",
      "subscription_start_time": "string"
    },
    {
      "account_name": "string",
      "account_type": "string",
      "created_at": "string",
      "id": "string",
      "owner_email": "string",
      "seats": 123,
      "subscription_end_time": "string",
      "subscription_start_time": "string"
    }
  ]
}

Create a sub account


Create a sub account under the master account

Parameters

  • email string Required

    User's email address.

  • first_name string Required

    User's first name.

  • last_name string Required

    User's last name.

  • password string Required

    User's password.

  • object

    Account options object

    • meeting_connectors string

      Meeting Connector, multiple value separated by comma.

    • pay_mode string

      Payee

    • room_connectors string

      Virtual Room Connector, multiple value separated by comma.

    • share_mc boolean

      Enable Share Meeting Connector.

    • share_rc boolean

      Enable Share Virtual Room Connector.

post - /accounts
201 - Account Created
{
  "created_at": "string",
  "id": "string",
  "owner_email": "string",
  "owner_id": "string"
}
409 - Account with that email already exists

Disassociate an account


Disassociate a sub account from the master account

Parameters

  • accountId string Required

    The account ID

delete - /accounts/{accountId}
204 - Account deleted
404 - Account not found

Retrieve a sub account


Retrieve a sub account under the master account

Parameters

  • accountId string Required

    The account ID

get - /accounts/{accountId}
200 - Account object returned
{
  "created_at": "string",
  "id": "string",
  "options": {
    "meeting_connectors": "string",
    "pay_mode": "string",
    "room_connectors": "string",
    "share_mc": true,
    "share_rc": true
  },
  "owner_email": "string",
  "owner_id": "string"
}
404 - User not found

Update a sub account's options


Update a sub account's options under the master account

Parameters

  • meeting_connectors string

    Meeting Connector, multiple value separated by comma.

  • pay_mode string

    Payee

  • room_connectors string

    Virtual Room Connector, multiple value separated by comma.

  • share_mc boolean

    Enable Share Meeting Connector.

  • share_rc boolean

    Enable Share Virtual Room Connector.

patch - /accounts/{accountId}/options
204 - Account options updated
404 - Account not found

Retrieve a sub account's settings


Retrieve a sub account's settings under the master account

Parameters

  • accountId string Required

    The account ID

get - /accounts/{accountId}/settings
200 - Account settings returned
{
  "email_notification": {
    "alternative_host_reminder": true,
    "cancel_meeting_reminder": true,
    "cloud_recording_avaliable_reminder": true,
    "jbh_reminder": true,
    "low_host_count_reminder": true
  },
  "feature": {
    "meeting_capacity": 123
  },
  "in_meeting": {
    "alert_guest_join": true,
    "allow_show_zoom_windows": true,
    "annotation": true,
    "anonymous_question_answer": true,
    "attendee_on_hold": true,
    "attention_tracking": true,
    "auto_answer": true,
    "auto_saving_chat": true,
    "breakout_room": true,
    "chat": true,
    "closed_caption": true,
    "co_host": true,
    "dscp_audio": 123,
    "dscp_marking": true,
    "dscp_video": 123,
    "e2e_encryption": true,
    "far_end_camera_control": true,
    "feedback": true,
    "file_transfer": true,
    "group_hd": true,
    "original_audio": true,
    "p2p_connetion": true,
    "p2p_ports": true,
    "polling": true,
    "ports_range": "string",
    "post_meeting_feedback": true,
    "private_chat": true,
    "remote_control": true,
    "screen_sharing": true,
    "sending_default_email_invites": true,
    "show_meeting_control_toolbar": true,
    "stereo_audio": true,
    "use_html_format_email": true,
    "virtual_background": true,
    "watermark": true,
    "webinar_question_answer": true,
    "whiteboard": true
  },
  "integration": {
    "box": true,
    "dropbox": true,
    "google_calendar": true,
    "google_drive": true,
    "kubi": true,
    "microsoft_one_drive": true
  },
  "recording": {
    "account_user_access_recording": true,
    "auto_delete_cmr": true,
    "auto_delete_cmr_days": 123,
    "auto_recording": "string",
    "cloud_recording": true,
    "cloud_recording_download": true,
    "cloud_recording_download_host": true,
    "local_recording": true,
    "record_audio_file": true,
    "record_gallery_view": true,
    "record_speaker_view": true,
    "recording_audio_transcript": true,
    "save_chat_text": true,
    "show_timestamp": true
  },
  "schedule_meting": {
    "audio_type": "string",
    "enforce_login": true,
    "enforce_login_domains": "string",
    "enforce_login_with_domains": true,
    "force_pmi_jbh_password": true,
    "host_video": true,
    "join_before_host": true,
    "not_store_meeting_topic": true,
    "participant_video": true
  },
  "security": {
    "admin_change_name_pic": true,
    "hide_billing_info": true,
    "import_photos_from_devices": true
  },
  "telephony": {
    "audio_conference_info": "string",
    "third_party_audio": true
  },
  "zoom_rooms": {
    "auto_start_stop_scheduled_meetings": true,
    "cmr_for_instant_meeting": true,
    "force_private_meeting": true,
    "hide_host_information": true,
    "list_meetings_with_calendar": true,
    "start_airplay_manually": true,
    "ultrasonic": true,
    "upcoming_meeting_alert": true,
    "weekly_system_restart": true,
    "zr_post_meeting_feedback": true
  }
}
404 - Account not found

Update a sub account's settings


Update a sub account's settings under the master account

Parameters

  • object

    Account Settings: Notification

    • alternative_host_reminder boolean

      When an alternative host is set or removed from a meeting

    • cancel_meeting_reminder boolean

      When a meeting is cancelled

    • cloud_recording_avaliable_reminder boolean

      Allow keep recording from being automatically deleted

    • jbh_reminder boolean

      When attendees join meeting before host

    • low_host_count_reminder boolean

      When host licenses are running low

  • object

    Account Settings: Feature

    • meeting_capacity integer

      Meeting capacity

  • object

    Account Settings: In Meeting

    • alert_guest_join boolean

      Identify guest participants in the meeting/webinar

    • allow_show_zoom_windows boolean

      Allow to share Zoom windows in desktop sharing

    • annotation boolean

      Annotation

    • anonymous_question_answer boolean

      Allow Anonymous Q&A in Webinar

    • attendee_on_hold boolean

      Allow host to put attendee on hold

    • attention_tracking boolean

      Attention tracking

    • auto_answer boolean

      Enable Auto Answer Group

    • auto_saving_chat boolean

      Auto Saving Chats

    • breakout_room boolean

      Breakout room

    • chat boolean

      Chat

    • closed_caption boolean

      Closed caption

    • co_host boolean

      Co-Host

    • dscp_audio integer

      DSCP Audio

    • dscp_marking boolean

      DSCP marking

    • dscp_video integer

      DSCP Video

    • e2e_encryption boolean

      End-to-End Encryption

    • far_end_camera_control boolean

      Far end camera control

    • feedback boolean

      Feedback to Zoom

    • file_transfer boolean

      File transfer

    • group_hd boolean

      Group HD video

    • original_audio boolean

      Allow users to select original sound in their client settings

    • p2p_connetion boolean

      Peer to Peer connection while only 2 people in a meeting

    • p2p_ports boolean

      Listening ports range

    • polling boolean

      Polling

    • ports_range string

      Listening ports range, separated by comma (ex 55,56). The ports range is between 1 to 65535

    • post_meeting_feedback boolean

      Display end-of-meeting experience feedback survey

    • private_chat boolean

      Private Chat

    • remote_control boolean

      Remote control

    • screen_sharing boolean

      Screen sharing

    • sending_default_email_invites boolean

      Only show default email when sending email invites

    • show_meeting_control_toolbar boolean

      Always show meeting control toolbar

    • stereo_audio boolean

      Allow users to select stereo audio in their client settings

    • use_html_format_email boolean

      Use HTML format email for Outlook plugin

    • virtual_background boolean

      Virtual background

    • watermark boolean

      Add watermark when viewing shared screen

    • webinar_question_answer boolean

      Q&A in webinar

    • whiteboard boolean

      Whiteboard

  • object

    Account Settings: Integration

    • box boolean

      Box

    • dropbox boolean

      Dropbox

    • google_calendar boolean

      Google Calendar

    • google_drive boolean

      Google Drive

    • kubi boolean

      Kubi

    • microsoft_one_drive boolean

      Microsoft OneDrive

  • object

    Account Settings: Recording

    • account_user_access_recording boolean

      Only users on my account can access cloud recordings

    • auto_delete_cmr boolean

      Auto delete cloud recordings after days

    • auto_delete_cmr_days integer

      A specified number of days of auto delete cloud recordings

    • auto_recording string

      Automatic recording

    • cloud_recording boolean

      Cloud recording

    • cloud_recording_download boolean

      Cloud Recording Downloads

    • cloud_recording_download_host boolean

      Only the host can download cloud recordings

    • local_recording boolean

      Local recording

    • record_audio_file boolean

      Record an audio only file

    • record_gallery_view boolean

      Record the gallery view

    • record_speaker_view boolean

      Record the active speaker view

    • recording_audio_transcript boolean

      Audio transcript

    • save_chat_text boolean

      Save chat text from the meeting

    • show_timestamp boolean

      Show timestamp on video

  • object

    Account Settings: Schedule Meeting

    • audio_type string

      Audio Type

    • enforce_login boolean

      Only signed-in users can join meetings

    • enforce_login_domains string

      Only signed-in users with a specified domains

    • enforce_login_with_domains boolean

      Only signed-in users with a specified domains can join meetings

    • force_pmi_jbh_password boolean

      Require a password for Personal Meetings if attendees can join before host

    • host_video boolean

      Host Video

    • join_before_host boolean

      Join Before Host

    • not_store_meeting_topic boolean

      Always display "Zoom Meeting" as the meeting topic

    • participant_video boolean

      Participants Video

  • object

    Account Settings: Security

    • admin_change_name_pic boolean

      Only account administrators can change user's username and picture

    • hide_billing_info boolean

      Hide billing information

    • import_photos_from_devices boolean

      Allow importing of photos from photo library on the user's device

  • object

    Account Settings: Telephony

    • audio_conference_info string

      3rd party audio conference info

    • third_party_audio boolean

      3rd party audio conference

  • object

    Account Settings: Zoom Rooms

    • auto_start_stop_scheduled_meetings boolean

      Automatic start/stop scheduled meetings

    • cmr_for_instant_meeting boolean

      Cloud recording for instant meetings

    • force_private_meeting boolean

      Transform all meetings to private

    • hide_host_information boolean

      Hide host and meeting ID from private meetings

    • list_meetings_with_calendar boolean

      Display meeting list with calendar integration

    • start_airplay_manually boolean

      Start AirPlay service manually

    • ultrasonic boolean

      Automatic direct sharing using ultrasonic proximity signal

    • upcoming_meeting_alert boolean

      Upcoming meeting alert

    • weekly_system_restart boolean

      Weekly system restart

    • zr_post_meeting_feedback boolean

      Zoom Room post meeting feedback

patch - /accounts/{accountId}/settings
204 - Account settings updated
404 - Account not found

Billing


Billing operations

Retrieve billing information for a sub account


Retrieve billing information for a sub account under the master account

Parameters

  • accountId string Required

    The account ID

get - /accounts/{accountId}/billing
200 - Account billing contact information returned
{
  "address": "string",
  "apt": "string",
  "city": "string",
  "country": "string",
  "email": "string",
  "first_name": "string",
  "last_name": "string",
  "phone_number": "string",
  "state": "string",
  "zip": "string"
}
404 - Account not found

Update billing information for a sub account


Update billing information for a sub account under the master account

Parameters

  • address string

    Billing Contact's address.

  • apt string

    Billing Contact's apartment/suite.

  • city string

    Billing Contact's city.

  • country string

    Billing Contact's country.

  • email string

    Billing Contact's email address.

  • first_name string

    Billing Contact's first name.

  • last_name string

    Billing Contact's last name.

  • phone_number string

    Billing Contact's phone number.

  • state string

    Billing Contact's state.

  • zip string

    Billing Contact's zip/postal code.

patch - /accounts/{accountId}/billing
204 - Account billing contact information updated
404 - Account not found

Retrieve plan information for a sub account


Retrieve plan information for a sub account under the master account

Parameters

  • accountId string Required

    The account ID

get - /accounts/{accountId}/plans
200 - Account plans returned
{
  "plan_audio": {
    "callout_countries": "string",
    "ddi_numbers": 123,
    "premium_countries": "string",
    "tollfree_countries": "string",
    "type": "string"
  },
  "plan_base": {
    "hosts": 123,
    "type": "string"
  },
  "plan_large_meeting": [
    {
      "hosts": 123,
      "type": "string"
    },
    {
      "hosts": 123,
      "type": "string"
    },
    {
      "hosts": 123,
      "type": "string"
    }
  ],
  "plan_recording": "string",
  "plan_room_connector": {
    "hosts": 123,
    "type": "string"
  },
  "plan_webinar": [
    {
      "hosts": 123,
      "type": "string"
    },
    {
      "hosts": 123,
      "type": "string"
    },
    {
      "hosts": 123,
      "type": "string"
    }
  ],
  "plan_zoom_rooms": {
    "hosts": 123,
    "type": "string"
  }
}
404 - Account not fond

Subscribe plans for a sub account


Subscribe plans for a sub account of the master account

Parameters

  • object

    Billing Contact object

    • address string Required

      Billing Contact's address.

    • apt string

      Billing Contact's apartment/suite.

    • city string Required

      Billing Contact's city.

    • country string Required

      Billing Contact's country.

    • email string Required

      Billing Contact's email address.

    • first_name string Required

      Billing Contact's first name.

    • last_name string Required

      Billing Contact's last name.

    • phone_number string Required

      Billing Contact's phone number.

    • state string Required

      Billing Contact's state.

    • zip string Required

      Billing Contact's zip/postal code.

  • 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

  • object

    Account base plan object

    • hosts integer Required

      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.

    • type string Required

      Account base plan type

  • plan_large_meeting array

    Account plan object

  • plan_recording string

    Additional Cloud Recording Plan

  • object

    Account plan object

    • hosts integer

      Account plan number of hosts

    • type string

      Account plan type

  • plan_webinar array

    Account plan object

  • object

    Account plan object

    • hosts integer

      Account plan number of hosts

    • type string

      Account plan type

post - /accounts/{accountId}/plans
201 - Account plans updated
{
  "plan_audio": {
    "callout_countries": "string",
    "ddi_numbers": 123,
    "premium_countries": "string",
    "tollfree_countries": "string",
    "type": "string"
  },
  "plan_base": {
    "hosts": 123,
    "type": "string"
  },
  "plan_large_meeting": [
    {
      "hosts": 123,
      "type": "string"
    },
    {
      "hosts": 123,
      "type": "string"
    },
    {
      "hosts": 123,
      "type": "string"
    }
  ],
  "plan_recording": "string",
  "plan_room_connector": {
    "hosts": 123,
    "type": "string"
  },
  "plan_webinar": [
    {
      "hosts": 123,
      "type": "string"
    },
    {
      "hosts": 123,
      "type": "string"
    },
    {
      "hosts": 123,
      "type": "string"
    }
  ],
  "plan_zoom_rooms": {
    "hosts": 123,
    "type": "string"
  }
}

Add an additional plan for sub account


Add an additional plan for sub account

Parameters

  • hosts integer Required

    Account plan number of hosts.

  • type string Required

    Account plan type

post - /accounts/{accountId}/plans/addons
201 - Account plans updated

Update an additional plan for sub account


Update an additional plan for sub account

Parameters

  • hosts integer Required

    Account plan number of hosts.

  • type string Required

    Account plan type

put - /accounts/{accountId}/plans/addons
204 - Account plans updated

Update a base plan for a sub account


Update a base plan for a sub account

Parameters

  • hosts integer Required

    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.

  • type string Required

    Account base plan type

put - /accounts/{accountId}/plans/base
204 - Account plans updated

Groups


Group operations

List groups


List groups under your account

get - /groups
200 - List of groups returned.
{
  "groups": [
    {
      "id": "string",
      "name": "string",
      "total_members": 123
    },
    {
      "id": "string",
      "name": "string",
      "total_members": 123
    },
    {
      "id": "string",
      "name": "string",
      "total_members": 123
    }
  ],
  "total_records": 123
}

Create a group


Create a group under your account

Parameters

  • name string

    Group name.

post - /groups
201 - Group created.
{
  "id": "string",
  "name": "string",
  "total_members": 123
}

Delete a group


Delete a group under your account

Parameters

  • groupId string Required

    The group ID

delete - /groups/{groupId}
204 - Group deleted.
404 - Group not found

Retrieve a group


Retrieve a group under your account

Parameters

  • groupId string Required

    The group ID

get - /groups/{groupId}
200 - Group object returned
{
  "id": "string",
  "name": "string",
  "total_members": 123
}
404 - Group not found

Update a group


Update a group under your account

Parameters

  • name string

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

patch - /groups/{groupId}
204 - Group updated.
404 - Group not found

List a group's members


List a group's members under your account

Parameters

  • groupId string Required

    The group ID

  • page_size integer

    The amount of records returns within a single API call.

  • page_number integer

    Current page number of returned records.

get - /groups/{groupId}/members
200 - Group member list returned
{
  "page_count": 123,
  "page_number": 123,
  "page_size": 123,
  "total_records": 123,
  "members": [
    {
      "email": "string",
      "first_name": "string",
      "id": "string",
      "last_name": "string",
      "type": 123
    },
    {
      "email": "string",
      "first_name": "string",
      "id": "string",
      "last_name": "string",
      "type": 123
    },
    {
      "email": "string",
      "first_name": "string",
      "id": "string",
      "last_name": "string",
      "type": 123
    }
  ]
}
404 - Group not found

Add group members


Add members to a group under your account

Parameters

  • members array
post - /groups/{groupId}/members
201 - Member added.
{
  "added_at": "string",
  "ids": "string"
}
404 - Group not found

Delete a group member


Delete a member from a group under your account

Parameters

  • groupId string Required

    The group ID

  • memberId string Required

    The member ID

delete - /groups/{groupId}/members/{memberId}
204 - Group member deleted.
404 - Group or Group member not found

IM Groups


IM Group operations

List IM Groups


List IM groups under your account

get - /im/groups
200 - List of IM Groups returned.
{
  "page_count": 123,
  "page_number": 123,
  "page_size": 123,
  "total_records": 123,
  "groups": [
    {
      "id": "string"
    },
    {
      "id": "string"
    },
    {
      "id": "string"
    }
  ]
}

Create an IM Group


Create a IM Group under your account

Parameters

  • 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

    IM Group type

post - /im/groups
201 - IM Group created.
{
  "id": "string",
  "name": "string",
  "search_by_account": true,
  "search_by_domain": true,
  "search_by_ma_account": true,
  "total_members": 123
}

Delete an IM Group


Delete an IM Group under your account

Parameters

  • groupId string Required

    The group ID

delete - /im/groups/{groupId}
204 - IM Group deleted.
404 - IM Group not found

Retrieve an IM Group


Retrieve an IM Group under your account

Parameters

  • groupId string Required

    The group ID

get - /im/groups/{groupId}
200 - IM Group object returned
{
  "id": "string"
}
404 - IM Group not found

Update an IM Group


Update an IM Group under your account

Parameters

  • 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

    IM Group type

patch - /im/groups/{groupId}
204 - IM Group updated.
404 - IM Group not found

List an IM Group's members


List an IM Group's members under your account

Parameters

  • groupId string Required

    The group ID

  • page_size integer

    The amount of records returns within a single API call.

  • page_number integer

    Current page number of returned records.

get - /im/groups/{groupId}/members
200 - IM Group member list returned
{
  "page_count": 123,
  "page_number": 123,
  "page_size": 123,
  "total_records": 123,
  "members": [
    {
      "email": "string",
      "first_name": "string",
      "id": "string",
      "last_name": "string",
      "type": 123
    },
    {
      "email": "string",
      "first_name": "string",
      "id": "string",
      "last_name": "string",
      "type": 123
    },
    {
      "email": "string",
      "first_name": "string",
      "id": "string",
      "last_name": "string",
      "type": 123
    }
  ]
}
404 - IM Group not found

Add IM Group members


Add members to an IM Group under your account

Parameters

  • members array
post - /im/groups/{groupId}/members
201 - Member added.
{
  "added_at": "string",
  "ids": "string"
}
404 - IM Group not found

Delete an IM Group member


Delete a member from an IM Group under your account

Parameters

  • groupId string Required

    The group ID

  • memberId string Required

    The member ID

delete - /im/groups/{groupId}/members/{memberId}
204 - IM Group member deleted.
404 - IM Group or IM Group member not found

Meetings


Meeting operations

Delete a meeting


Delete a meeting

Parameters

  • meetingId integer Required

    The meeting ID

  • occurrence_id string

    The meeting occurrence ID

delete - /meetings/{meetingId}
204 - Meeting deleted
404 - Meeting not found

Retrieve a meeting


Retrieve a meeting's details

Parameters

  • meetingId integer Required

    The meeting ID

get - /meetings/{meetingId}
200 - Meeting object returned
{
  "host_id": "string",
  "id": "string",
  "uuid": "string",
  "agenda": "string",
  "created_at": "string",
  "duration": 123,
  "h323_password": "string",
  "join_url": "string",
  "occurrences": [
    {
      "duration": 123,
      "occurrence_id": 123,
      "start_time": "string",
      "status": "string"
    },
    {
      "duration": 123,
      "occurrence_id": 123,
      "start_time": "string",
      "status": "string"
    },
    {
      "duration": 123,
      "occurrence_id": 123,
      "start_time": "string",
      "status": "string"
    }
  ],
  "password": "string",
  "settings": {
    "alternative_hosts": "string",
    "approval_type": 123,
    "audio": "string",
    "auto_recording": "string",
    "cn_meeting": true,
    "enforce_login": true,
    "enforce_login_domains": "string",
    "host_video": true,
    "in_meeting": true,
    "join_before_host": true,
    "mute_upon_entry": true,
    "participant_video": true,
    "registration_type": 123,
    "use_pmi": true,
    "watermark": true
  },
  "start_time": "string",
  "start_url": "string",
  "timezone": "string",
  "topic": "string",
  "type": 123
}
404 - Meeting not found

Update a meeting


Update a meeting's details

Parameters

  • agenda string

    Meeting description

  • duration integer

    Meeting duration (minutes). Used for scheduled meeting 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.

  • object

    Recurrence object

    • end_date_time string

      Recurrence Meeting End Date. Should be UTC time, such as 2017-11-25T12:00:00Z.

    • end_times integer

      Recurrence Meeting End occurrences times

    • monthly_day integer

      Recurrence Meeting Occurs on a month day. The value range is from 1 to 31

    • monthly_week integer

      Recurrence Meeting Occurs on the week of a month.

    • monthly_week_day integer

      Recurrence Meeting Occurs on the week day of a month

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

    • type integer

      Recurrence meeting type

    • weekly_days integer

      Recurrence Meeting Occurs on week days, multiple value separated by comma

  • settings
  • start_time string

    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.

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

  • topic string

    Meeting topic

  • type integer

    Meeting Type

patch - /meetings/{meetingId}
204 - Meeting Updated
404 - Meeting not found

List a meeting's registrants


List registrants of a meeting

Parameters

  • meetingId integer Required

    The meeting ID

  • occurrence_id string

    The meeting occurrence ID

  • status string

    The registrant status

  • page_size integer

    The amount of records returns within a single API call.

  • page_number integer

    Current page number of returned records.

get - /meetings/{meetingId}/registrants
200 - Success
{}
404 - Meeting not found

Add a meeting registrant


Register a participant for a meeting

Parameters

  • email string Required

    A valid email address

  • first_name string Required

    User’s first name

  • last_name string Required

    User’s last name

  • address string

    Address

  • city string

    City

  • comments string

    Questions & Comments

  • country string

    Country

  • custom_questions array

    Custom Question

  • industry string

    Industry

  • job_title string

    Job Title

  • no_of_employees string

    Number of Employees

  • org string

    Organization

  • phone string

    Phone

  • purchasing_time_frame string

    Purchasing Time Frame

  • role_in_purchase_process string

    Role in Purchase Process

  • state string

    State/Province

  • zip string

    Zip/Postal Code

post - /meetings/{meetingId}/registrants
201 - Registration created
{
  "id": "string",
  "join_url": "string",
  "registrant_id": "string",
  "start_time": "string",
  "topic": "string"
}
404 - Meeting not found

Update a meeting registrant's status


Update a meeting registrant's status

Parameters

  • action string Required
  • registrants array
put - /meetings/{meetingId}/registrants/status
204 - Registrant status updated
404 - Meeting or Registrant not found

Update a meeting's status


Update a meeting's status

Parameters

  • action string
put - /meetings/{meetingId}/status
204 - Meeting updated
404 - Meeting not found

List meetings


List meetings for a user

Parameters

  • userId string Required

    The user ID or email address

  • type string

    The meeting type

  • page_size integer

    The amount of records returns within a single API call.

  • page_number integer

    Current page number of returned records.

get - /users/{userId}/meetings
200 - List of Meeting objects returned
{
  "page_count": 123,
  "page_number": 123,
  "page_size": 123,
  "total_records": 123,
  "meetings": [
    {
      "created_at": "string",
      "duration": 123,
      "host_id": "string",
      "id": "string",
      "join_url": "string",
      "start_time": "string",
      "timezone": "string",
      "topic": "string",
      "type": 123,
      "uuid": "string"
    },
    {
      "created_at": "string",
      "duration": 123,
      "host_id": "string",
      "id": "string",
      "join_url": "string",
      "start_time": "string",
      "timezone": "string",
      "topic": "string",
      "type": 123,
      "uuid": "string"
    },
    {
      "created_at": "string",
      "duration": 123,
      "host_id": "string",
      "id": "string",
      "join_url": "string",
      "start_time": "string",
      "timezone": "string",
      "topic": "string",
      "type": 123,
      "uuid": "string"
    }
  ]
}
404 - User not found

Create a meeting


Create a meeting for a user

Parameters

  • agenda string

    Meeting description

  • duration integer

    Meeting duration (minutes). Used for scheduled meeting 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.

  • object

    Recurrence object

    • end_date_time string

      Recurrence Meeting End Date. Should be UTC time, such as 2017-11-25T12:00:00Z.

    • end_times integer

      Recurrence Meeting End occurrences times

    • monthly_day integer

      Recurrence Meeting Occurs on a month day. The value range is from 1 to 31

    • monthly_week integer

      Recurrence Meeting Occurs on the week of a month.

    • monthly_week_day integer

      Recurrence Meeting Occurs on the week day of a month

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

    • type integer

      Recurrence meeting type

    • weekly_days integer

      Recurrence Meeting Occurs on week days, multiple value separated by comma

  • object

    Meeting Settings

    • alternative_hosts string

      Alternative hosts emails or IDs. Multiple value separated by comma.

    • approval_type integer
    • audio string

      Meeting audio options

    • auto_recording string
    • 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 join meeting

    • in_meeting boolean

      Host meeting in India

    • join_before_host boolean

      Join meeting before host start 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

      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

    • watermark boolean

      Enable watermark when viewing the shared screen

  • start_time string

    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.

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

  • topic string

    Meeting topic

  • type integer

    Meeting Type

post - /users/{userId}/meetings
201 - Meeting Created
{
  "host_id": "string",
  "id": "string",
  "uuid": "string",
  "agenda": "string",
  "created_at": "string",
  "duration": 123,
  "h323_password": "string",
  "join_url": "string",
  "occurrences": [
    {
      "duration": 123,
      "occurrence_id": 123,
      "start_time": "string",
      "status": "string"
    },
    {
      "duration": 123,
      "occurrence_id": 123,
      "start_time": "string",
      "status": "string"
    },
    {
      "duration": 123,
      "occurrence_id": 123,
      "start_time": "string",
      "status": "string"
    }
  ],
  "password": "string",
  "settings": {
    "alternative_hosts": "string",
    "approval_type": 123,
    "audio": "string",
    "auto_recording": "string",
    "cn_meeting": true,
    "enforce_login": true,
    "enforce_login_domains": "string",
    "host_video": true,
    "in_meeting": true,
    "join_before_host": true,
    "mute_upon_entry": true,
    "participant_video": true,
    "registration_type": 123,
    "use_pmi": true,
    "watermark": true
  },
  "start_time": "string",
  "start_url": "string",
  "timezone": "string",
  "topic": "string",
  "type": 123
}
404 - User not found

Cloud Recording


Cloud Recording operations

Delete a meeting's recordings


Delete a meeting's recordings

Parameters

  • meetingId integer Required

    The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.

  • action string

    The recording delete action

delete - /meetings/{meetingId}/recordings
204 - Meeting recording deleted
404 - Meeting recording not found

Retrieve a meeting’s all recordings


Retrieve a meeting’s all recordings

Parameters

  • meetingId integer Required

    The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.

get - /meetings/{meetingId}/recordings
200 - Recording object returned
{}
404 - Meeting recording not found

Recover a meeting's recordings


Recover a meeting's recordings

Parameters

  • action string
put - /meetings/{meetingId}/recordings/status
204 - Meeting recording recover
404 - Meeting recording not found

Delete one meeting recording file


Delete one meeting recording file

Parameters

  • meetingId integer Required

    The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.

  • recordingId string Required

    The recording ID

  • action string

    The recording delete action

delete - /meetings/{meetingId}/recordings/{recordingId}
204 - Meeting recording file deleted
404 - Meeting recording file not found

Recover a meeting one recording


Recover a meeting one recording

Parameters

  • action string
put - /meetings/{meetingId}/recordings/{recordingId}/status
204 - Meeting recording recover
404 - Meeting recording not found

List all the recordings


List all the recordings

Parameters

  • userId string Required

    The user ID or email address

  • from string Required

    Start Date

  • to string Required

    End Date

  • page_size integer

    The amount of records returns within a single API call.

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

  • mc string

    Query mc

  • trash boolean

    Query trash

get - /users/{userId}/recordings
200 - List of Recording objects returned
{
  "from": "string",
  "to": "string",
  "next_page_token": "string",
  "page_count": 123,
  "page_size": 123,
  "total_records": 123,
  "meetings": [
    {},
    {},
    {}
  ]
}
404 - User not found

Dashboards


Dashboard operations

Retrieve CRC Port Usage


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

Parameters

  • from string Required

    Start Date

  • to string Required

    End Date

get - /metrics/crc
200 - CRC Usage returned
{
  "from": "string",
  "to": "string",
  "crc_ports_usage": [
    {
      "crc_ports_hour_usage": [
        {
          "hour": "string",
          "max_usage": 123,
          "total_usage": 123
        },
        {
          "hour": "string",
          "max_usage": 123,
          "total_usage": 123
        },
        {
          "hour": "string",
          "max_usage": 123,
          "total_usage": 123
        }
      ],
      "date_time": "string"
    },
    {
      "crc_ports_hour_usage": [
        {
          "hour": "string",
          "max_usage": 123,
          "total_usage": 123
        },
        {
          "hour": "string",
          "max_usage": 123,
          "total_usage": 123
        },
        {
          "hour": "string",
          "max_usage": 123,
          "total_usage": 123
        }
      ],
      "date_time": "string"
    },
    {
      "crc_ports_hour_usage": [
        {
          "hour": "string",
          "max_usage": 123,
          "total_usage": 123
        },
        {
          "hour": "string",
          "max_usage": 123,
          "total_usage": 123
        },
        {
          "hour": "string",
          "max_usage": 123,
          "total_usage": 123
        }
      ],
      "date_time": "string"
    }
  ]
}

Retrieve IM


Retrieve metrics of Zoom IM

Parameters

  • from string Required

    Start Date

  • to string Required

    End Date

  • page_size integer

    The amount of records returns within a single API call.

  • 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/im
200 - IM setails returned
{
  "from": "string",
  "to": "string",
  "next_page_token": "string",
  "page_count": 123,
  "page_size": 123,
  "total_records": 123,
  "users": [
    {
      "calls_receive": 123,
      "calls_send": 123,
      "email": "string",
      "emoji_receive": 123,
      "emoji_send": 123,
      "files_receive": 123,
      "files_send": 123,
      "group_receive": 123,
      "group_send": 123,
      "images_receive": 123,
      "images_send": 123,
      "total_receive": 123,
      "total_send": 123,
      "user_id": "string",
      "user_name": "string",
      "videos_receive": 123,
      "videos_send": 123,
      "voice_receive": 123,
      "voice_send": 123
    },
    {
      "calls_receive": 123,
      "calls_send": 123,
      "email": "string",
      "emoji_receive": 123,
      "emoji_send": 123,
      "files_receive": 123,
      "files_send": 123,
      "group_receive": 123,
      "group_send": 123,
      "images_receive": 123,
      "images_send": 123,
      "total_receive": 123,
      "total_send": 123,
      "user_id": "string",
      "user_name": "string",
      "videos_receive": 123,
      "videos_send": 123,
      "voice_receive": 123,
      "voice_send": 123
    },
    {
      "calls_receive": 123,
      "calls_send": 123,
      "email": "string",
      "emoji_receive": 123,
      "emoji_send": 123,
      "files_receive": 123,
      "files_send": 123,
      "group_receive": 123,
      "group_send": 123,
      "images_receive": 123,
      "images_send": 123,
      "total_receive": 123,
      "total_send": 123,
      "user_id": "string",
      "user_name": "string",
      "videos_receive": 123,
      "videos_send": 123,
      "voice_receive": 123,
      "voice_send": 123
    }
  ]
}

List meetings


List live meetings or past meetings for a specified period

Parameters

  • from string Required

    Start Date

  • to string Required

    End Date

  • type string

    The meeting type

  • page_size integer

    The amount of records returns within a single API call.

  • 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
200 - Meetings Returned
{
  "from": "string",
  "to": "string",
  "next_page_token": "string",
  "page_count": 123,
  "page_size": 123,
  "total_records": 123,
  "meetings": [
    {
      "duration": "string",
      "email": "string",
      "end_time": "string",
      "has_3rd_party_audio": true,
      "has_pstn": true,
      "has_recording": true,
      "has_screen_share": true,
      "has_sip": true,
      "has_video": true,
      "has_voip": true,
      "host": "string",
      "id": 123,
      "participants": 123,
      "start_time": "string",
      "topic": "string",
      "user_type": "string",
      "uuid": "string"
    },
    {
      "duration": "string",
      "email": "string",
      "end_time": "string",
      "has_3rd_party_audio": true,
      "has_pstn": true,
      "has_recording": true,
      "has_screen_share": true,
      "has_sip": true,
      "has_video": true,
      "has_voip": true,
      "host": "string",
      "id": 123,
      "participants": 123,
      "start_time": "string",
      "topic": "string",
      "user_type": "string",
      "uuid": "string"
    },
    {
      "duration": "string",
      "email": "string",
      "end_time": "string",
      "has_3rd_party_audio": true,
      "has_pstn": true,
      "has_recording": true,
      "has_screen_share": true,
      "has_sip": true,
      "has_video": true,
      "has_voip": true,
      "host": "string",
      "id": 123,
      "participants": 123,
      "start_time": "string",
      "topic": "string",
      "user_type": "string",
      "uuid": "string"
    }
  ]
}

Retrieve meeting detail


Retrieve live or past meetings detail

Parameters

  • meetingId integer Required

    The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.

  • type string

    The meeting type

get - /metrics/meetings/{meetingId}
200 - Meeting Returned
{
  "duration": "string",
  "email": "string",
  "end_time": "string",
  "has_3rd_party_audio": true,
  "has_pstn": true,
  "has_recording": true,
  "has_screen_share": true,
  "has_sip": true,
  "has_video": true,
  "has_voip": true,
  "host": "string",
  "id": 123,
  "participants": 123,
  "start_time": "string",
  "topic": "string",
  "user_type": "string",
  "uuid": "string"
}

Retrieve meeting participants


Retrieve live or past meetings participants

Parameters

  • meetingId integer Required

    The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.

  • type string

    The meeting type

  • page_size integer

    The amount of records returns within a single API call.

  • 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
200 - Meeting Participants Returned
{
  "next_page_token": "string",
  "page_count": 123,
  "page_size": 123,
  "total_records": 123,
  "participants": [
    {
      "device": "string",
      "domain": "string",
      "harddisk_id": "string",
      "id": "string",
      "ip_address": "string",
      "join_time": "string",
      "leave_time": "string",
      "location": "string",
      "mac_addr": "string",
      "network_type": "string",
      "pc_name": "string",
      "recording": true,
      "share_application": true,
      "share_desktop": true,
      "share_whiteboard": true,
      "user_id": "string",
      "user_name": "string",
      "version": "string"
    },
    {
      "device": "string",
      "domain": "string",
      "harddisk_id": "string",
      "id": "string",
      "ip_address": "string",
      "join_time": "string",
      "leave_time": "string",
      "location": "string",
      "mac_addr": "string",
      "network_type": "string",
      "pc_name": "string",
      "recording": true,
      "share_application": true,
      "share_desktop": true,
      "share_whiteboard": true,
      "user_id": "string",
      "user_name": "string",
      "version": "string"
    },
    {
      "device": "string",
      "domain": "string",
      "harddisk_id": "string",
      "id": "string",
      "ip_address": "string",
      "join_time": "string",
      "leave_time": "string",
      "location": "string",
      "mac_addr": "string",
      "network_type": "string",
      "pc_name": "string",
      "recording": true,
      "share_application": true,
      "share_desktop": true,
      "share_whiteboard": true,
      "user_id": "string",
      "user_name": "string",
      "version": "string"
    }
  ]
}

List meeting participants QOS


Retrieve list of live or past meetings participants quality of service

Parameters

  • meetingId integer Required

    The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.

  • type string

    The meeting type

  • page_size integer

    Number of items returned per 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
200 - Meeting Participants Returned
{
  "next_page_token": "string",
  "page_count": 123,
  "page_size": 123,
  "total_records": 123,
  "participants": [
    {
      "device": "string",
      "domain": "string",
      "harddisk_id": "string",
      "ip_address": "string",
      "join_time": "string",
      "leave_time": "string",
      "location": "string",
      "mac_addr": "string",
      "pc_name": "string",
      "user_id": "string",
      "user_name": "string",
      "user_qos": {
        "as_input": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string",
          "frame_rate": "string",
          "resolution": "string"
        },
        "as_output": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string",
          "frame_rate": "string",
          "resolution": "string"
        },
        "audio_input": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string"
        },
        "audio_output": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string"
        },
        "cpu_usage": "",
        "date_time": "string",
        "video_input": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string",
          "frame_rate": "string",
          "resolution": "string"
        },
        "video_output": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string",
          "frame_rate": "string",
          "resolution": "string"
        }
      },
      "version": "string"
    },
    {
      "device": "string",
      "domain": "string",
      "harddisk_id": "string",
      "ip_address": "string",
      "join_time": "string",
      "leave_time": "string",
      "location": "string",
      "mac_addr": "string",
      "pc_name": "string",
      "user_id": "string",
      "user_name": "string",
      "user_qos": {
        "as_input": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string",
          "frame_rate": "string",
          "resolution": "string"
        },
        "as_output": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string",
          "frame_rate": "string",
          "resolution": "string"
        },
        "audio_input": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string"
        },
        "audio_output": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string"
        },
        "cpu_usage": "",
        "date_time": "string",
        "video_input": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string",
          "frame_rate": "string",
          "resolution": "string"
        },
        "video_output": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string",
          "frame_rate": "string",
          "resolution": "string"
        }
      },
      "version": "string"
    },
    {
      "device": "string",
      "domain": "string",
      "harddisk_id": "string",
      "ip_address": "string",
      "join_time": "string",
      "leave_time": "string",
      "location": "string",
      "mac_addr": "string",
      "pc_name": "string",
      "user_id": "string",
      "user_name": "string",
      "user_qos": {
        "as_input": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string",
          "frame_rate": "string",
          "resolution": "string"
        },
        "as_output": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string",
          "frame_rate": "string",
          "resolution": "string"
        },
        "audio_input": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string"
        },
        "audio_output": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string"
        },
        "cpu_usage": "",
        "date_time": "string",
        "video_input": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string",
          "frame_rate": "string",
          "resolution": "string"
        },
        "video_output": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string",
          "frame_rate": "string",
          "resolution": "string"
        }
      },
      "version": "string"
    }
  ]
}

Retrieve sharing/recording details of meeting participant


Retrieve sharing/recording details of live or past meetings participant

Parameters

  • meetingId integer Required

    The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.

  • type string

    The meeting type

  • page_size integer

    The amount of records returns within a single API call.

  • 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
200 - Meeting Participants Returned
{
  "next_page_token": "string",
  "page_count": 123,
  "page_size": 123,
  "total_records": 123,
  "participants": [
    {
      "details": [
        {
          "content": "string",
          "end_time": "string",
          "start_time": "string"
        },
        {
          "content": "string",
          "end_time": "string",
          "start_time": "string"
        },
        {
          "content": "string",
          "end_time": "string",
          "start_time": "string"
        }
      ],
      "id": "string",
      "user_id": "string",
      "user_name": "string"
    },
    {
      "details": [
        {
          "content": "string",
          "end_time": "string",
          "start_time": "string"
        },
        {
          "content": "string",
          "end_time": "string",
          "start_time": "string"
        },
        {
          "content": "string",
          "end_time": "string",
          "start_time": "string"
        }
      ],
      "id": "string",
      "user_id": "string",
      "user_name": "string"
    },
    {
      "details": [
        {
          "content": "string",
          "end_time": "string",
          "start_time": "string"
        },
        {
          "content": "string",
          "end_time": "string",
          "start_time": "string"
        },
        {
          "content": "string",
          "end_time": "string",
          "start_time": "string"
        }
      ],
      "id": "string",
      "user_id": "string",
      "user_name": "string"
    }
  ]
}

Retrieve meeting participant QOS


Retrieve live or past meetings participant quality of service

Parameters

  • meetingId integer Required

    The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.

  • participantId string Required

    The participant ID, such as 16778240

  • type string

    The meeting type

get - /metrics/meetings/{meetingId}/participants/{participantId}/qos
200 - Meeting Participant QOS Returned
{
  "device": "string",
  "domain": "string",
  "harddisk_id": "string",
  "ip_address": "string",
  "join_time": "string",
  "leave_time": "string",
  "location": "string",
  "mac_addr": "string",
  "pc_name": "string",
  "user_id": "string",
  "user_name": "string",
  "user_qos": {
    "as_input": {
      "avg_loss": "string",
      "bitrate": "string",
      "jitter": "string",
      "latency": "string",
      "max_loss": "string",
      "frame_rate": "string",
      "resolution": "string"
    },
    "as_output": {
      "avg_loss": "string",
      "bitrate": "string",
      "jitter": "string",
      "latency": "string",
      "max_loss": "string",
      "frame_rate": "string",
      "resolution": "string"
    },
    "audio_input": {
      "avg_loss": "string",
      "bitrate": "string",
      "jitter": "string",
      "latency": "string",
      "max_loss": "string"
    },
    "audio_output": {
      "avg_loss": "string",
      "bitrate": "string",
      "jitter": "string",
      "latency": "string",
      "max_loss": "string"
    },
    "cpu_usage": "",
    "date_time": "string",
    "video_input": {
      "avg_loss": "string",
      "bitrate": "string",
      "jitter": "string",
      "latency": "string",
      "max_loss": "string",
      "frame_rate": "string",
      "resolution": "string"
    },
    "video_output": {
      "avg_loss": "string",
      "bitrate": "string",
      "jitter": "string",
      "latency": "string",
      "max_loss": "string",
      "frame_rate": "string",
      "resolution": "string"
    }
  },
  "version": "string"
}

List webinars


List live webinars or past webinars for a specified period

Parameters

  • from string Required

    Start Date

  • to string Required

    End Date

  • type string

    The webinar type

  • page_size integer

    The amount of records returns within a single API call.

  • 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
200 - Meetings Returned
{
  "from": "string",
  "to": "string",
  "next_page_token": "string",
  "page_count": 123,
  "page_size": 123,
  "total_records": 123,
  "webinars": [
    {
      "duration": "string",
      "email": "string",
      "end_time": "string",
      "has_3rd_party_audio": true,
      "has_pstn": true,
      "has_recording": true,
      "has_screen_share": true,
      "has_sip": true,
      "has_video": true,
      "has_voip": true,
      "host": "string",
      "id": 123,
      "participants": 123,
      "start_time": "string",
      "topic": "string",
      "user_type": "string",
      "uuid": "string"
    },
    {
      "duration": "string",
      "email": "string",
      "end_time": "string",
      "has_3rd_party_audio": true,
      "has_pstn": true,
      "has_recording": true,
      "has_screen_share": true,
      "has_sip": true,
      "has_video": true,
      "has_voip": true,
      "host": "string",
      "id": 123,
      "participants": 123,
      "start_time": "string",
      "topic": "string",
      "user_type": "string",
      "uuid": "string"
    },
    {
      "duration": "string",
      "email": "string",
      "end_time": "string",
      "has_3rd_party_audio": true,
      "has_pstn": true,
      "has_recording": true,
      "has_screen_share": true,
      "has_sip": true,
      "has_video": true,
      "has_voip": true,
      "host": "string",
      "id": 123,
      "participants": 123,
      "start_time": "string",
      "topic": "string",
      "user_type": "string",
      "uuid": "string"
    }
  ]
}

Retrieve webinar detail


Retrieve live or past webinars detail

Parameters

  • webinarId integer Required

    The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance.

  • type string

    The webinar type

get - /metrics/webinars/{webinarId}
200 - Webinar Returned
{
  "duration": "string",
  "email": "string",
  "end_time": "string",
  "has_3rd_party_audio": true,
  "has_pstn": true,
  "has_recording": true,
  "has_screen_share": true,
  "has_sip": true,
  "has_video": true,
  "has_voip": true,
  "host": "string",
  "id": 123,
  "participants": 123,
  "start_time": "string",
  "topic": "string",
  "user_type": "string",
  "uuid": "string"
}

Retrieve webinar participants


Retrieve live or past webinar participants

Parameters

  • webinarId integer Required

    The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance.

  • type string

    The webinar type

  • page_size integer

    The amount of records returns within a single API call.

  • 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
200 - Webinar Participants Returned
{
  "next_page_token": "string",
  "page_count": 123,
  "page_size": 123,
  "total_records": 123,
  "participants": [
    {
      "device": "string",
      "domain": "string",
      "harddisk_id": "string",
      "id": "string",
      "ip_address": "string",
      "join_time": "string",
      "leave_time": "string",
      "location": "string",
      "mac_addr": "string",
      "network_type": "string",
      "pc_name": "string",
      "recording": true,
      "share_application": true,
      "share_desktop": true,
      "share_whiteboard": true,
      "user_id": "string",
      "user_name": "string",
      "version": "string"
    },
    {
      "device": "string",
      "domain": "string",
      "harddisk_id": "string",
      "id": "string",
      "ip_address": "string",
      "join_time": "string",
      "leave_time": "string",
      "location": "string",
      "mac_addr": "string",
      "network_type": "string",
      "pc_name": "string",
      "recording": true,
      "share_application": true,
      "share_desktop": true,
      "share_whiteboard": true,
      "user_id": "string",
      "user_name": "string",
      "version": "string"
    },
    {
      "device": "string",
      "domain": "string",
      "harddisk_id": "string",
      "id": "string",
      "ip_address": "string",
      "join_time": "string",
      "leave_time": "string",
      "location": "string",
      "mac_addr": "string",
      "network_type": "string",
      "pc_name": "string",
      "recording": true,
      "share_application": true,
      "share_desktop": true,
      "share_whiteboard": true,
      "user_id": "string",
      "user_name": "string",
      "version": "string"
    }
  ]
}

List webinar participant QOS


Retrieve list of live or past webinar participants quality of service

Parameters

  • webinarId integer Required

    The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance.

  • type string

    The webinar type

  • page_size integer

    Number of items returned per 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
200 - Webinar Participants Returned
{
  "next_page_token": "string",
  "page_count": 123,
  "page_size": 123,
  "total_records": 123,
  "participants": [
    {
      "device": "string",
      "domain": "string",
      "harddisk_id": "string",
      "ip_address": "string",
      "join_time": "string",
      "leave_time": "string",
      "location": "string",
      "mac_addr": "string",
      "pc_name": "string",
      "user_id": "string",
      "user_name": "string",
      "user_qos": {
        "as_input": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string",
          "frame_rate": "string",
          "resolution": "string"
        },
        "as_output": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string",
          "frame_rate": "string",
          "resolution": "string"
        },
        "audio_input": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string"
        },
        "audio_output": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string"
        },
        "cpu_usage": "",
        "date_time": "string",
        "video_input": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string",
          "frame_rate": "string",
          "resolution": "string"
        },
        "video_output": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string",
          "frame_rate": "string",
          "resolution": "string"
        }
      },
      "version": "string"
    },
    {
      "device": "string",
      "domain": "string",
      "harddisk_id": "string",
      "ip_address": "string",
      "join_time": "string",
      "leave_time": "string",
      "location": "string",
      "mac_addr": "string",
      "pc_name": "string",
      "user_id": "string",
      "user_name": "string",
      "user_qos": {
        "as_input": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string",
          "frame_rate": "string",
          "resolution": "string"
        },
        "as_output": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string",
          "frame_rate": "string",
          "resolution": "string"
        },
        "audio_input": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string"
        },
        "audio_output": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string"
        },
        "cpu_usage": "",
        "date_time": "string",
        "video_input": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string",
          "frame_rate": "string",
          "resolution": "string"
        },
        "video_output": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string",
          "frame_rate": "string",
          "resolution": "string"
        }
      },
      "version": "string"
    },
    {
      "device": "string",
      "domain": "string",
      "harddisk_id": "string",
      "ip_address": "string",
      "join_time": "string",
      "leave_time": "string",
      "location": "string",
      "mac_addr": "string",
      "pc_name": "string",
      "user_id": "string",
      "user_name": "string",
      "user_qos": {
        "as_input": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string",
          "frame_rate": "string",
          "resolution": "string"
        },
        "as_output": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string",
          "frame_rate": "string",
          "resolution": "string"
        },
        "audio_input": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string"
        },
        "audio_output": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string"
        },
        "cpu_usage": "",
        "date_time": "string",
        "video_input": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string",
          "frame_rate": "string",
          "resolution": "string"
        },
        "video_output": {
          "avg_loss": "string",
          "bitrate": "string",
          "jitter": "string",
          "latency": "string",
          "max_loss": "string",
          "frame_rate": "string",
          "resolution": "string"
        }
      },
      "version": "string"
    }
  ]
}

Retrieve sharing/recording details of webinar participant


Retrieve sharing/recording details of live or past webinar participant

Parameters

  • webinarId integer Required

    The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance.

  • type string

    The webinar type

  • page_size integer

    The amount of records returns within a single API call.

  • 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
200 - Webinar Participants Returned
{
  "next_page_token": "string",
  "page_count": 123,
  "page_size": 123,
  "total_records": 123,
  "participants": [
    {
      "details": [
        {
          "content": "string",
          "end_time": "string",
          "start_time": "string"
        },
        {
          "content": "string",
          "end_time": "string",
          "start_time": "string"
        },
        {
          "content": "string",
          "end_time": "string",
          "start_time": "string"
        }
      ],
      "id": "string",
      "user_id": "string",
      "user_name": "string"
    },
    {
      "details": [
        {
          "content": "string",
          "end_time": "string",
          "start_time": "string"
        },
        {
          "content": "string",
          "end_time": "string",
          "start_time": "string"
        },
        {
          "content": "string",
          "end_time": "string",
          "start_time": "string"
        }
      ],
      "id": "string",
      "user_id": "string",
      "user_name": "string"
    },
    {
      "details": [
        {
          "content": "string",
          "end_time": "string",
          "start_time": "string"
        },
        {
          "content": "string",
          "end_time": "string",
          "start_time": "string"
        },
        {
          "content": "string",
          "end_time": "string",
          "start_time": "string"
        }
      ],
      "id": "string",
      "user_id": "string",
      "user_name": "string"
    }
  ]
}

Retrieve webinar participant QOS


Retrieve live or past webinar participant quality of service

Parameters

  • webinarId integer Required

    The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance.

  • participantId string Required

    The participant ID, such as 16778240

  • type string

    The webinar type

get - /metrics/webinars/{webinarId}/participants/{participantId}/qos
200 - Webinar Participant QOS Returned
{
  "device": "string",
  "domain": "string",
  "harddisk_id": "string",
  "ip_address": "string",
  "join_time": "string",
  "leave_time": "string",
  "location": "string",
  "mac_addr": "string",
  "pc_name": "string",
  "user_id": "string",
  "user_name": "string",
  "user_qos": {
    "as_input": {
      "avg_loss": "string",
      "bitrate": "string",
      "jitter": "string",
      "latency": "string",
      "max_loss": "string",
      "frame_rate": "string",
      "resolution": "string"
    },
    "as_output": {
      "avg_loss": "string",
      "bitrate": "string",
      "jitter": "string",
      "latency": "string",
      "max_loss": "string",
      "frame_rate": "string",
      "resolution": "string"
    },
    "audio_input": {
      "avg_loss": "string",
      "bitrate": "string",
      "jitter": "string",
      "latency": "string",
      "max_loss": "string"
    },
    "audio_output": {
      "avg_loss": "string",
      "bitrate": "string",
      "jitter": "string",
      "latency": "string",
      "max_loss": "string"
    },
    "cpu_usage": "",
    "date_time": "string",
    "video_input": {
      "avg_loss": "string",
      "bitrate": "string",
      "jitter": "string",
      "latency": "string",
      "max_loss": "string",
      "frame_rate": "string",
      "resolution": "string"
    },
    "video_output": {
      "avg_loss": "string",
      "bitrate": "string",
      "jitter": "string",
      "latency": "string",
      "max_loss": "string",
      "frame_rate": "string",
      "resolution": "string"
    }
  },
  "version": "string"
}

List Zoom Rooms


List all zoom rooms on account

Parameters

  • page_size integer

    The amount of records returns within a single API call.

  • page_number integer

    Current page number of returned records.

get - /metrics/zoomrooms
200 - List of Zoom Rooms returned
{
  "page_count": 123,
  "page_number": 123,
  "page_size": 123,
  "total_records": 123,
  "zoom_rooms": [
    {
      "account_type": "string",
      "camera": "string",
      "device_ip": "string",
      "email": "string",
      "id": "string",
      "last_start_time": "string",
      "microphone": "string",
      "room_name": "string",
      "speaker": "string",
      "status": "string"
    },
    {
      "account_type": "string",
      "camera": "string",
      "device_ip": "string",
      "email": "string",
      "id": "string",
      "last_start_time": "string",
      "microphone": "string",
      "room_name": "string",
      "speaker": "string",
      "status": "string"
    },
    {
      "account_type": "string",
      "camera": "string",
      "device_ip": "string",
      "email": "string",
      "id": "string",
      "last_start_time": "string",
      "microphone": "string",
      "room_name": "string",
      "speaker": "string",
      "status": "string"
    }
  ]
}

Retrieve Zoom Room


Retrieve zoom room on account

Parameters

  • zoomroomId integer Required

    The Zoom Room ID

  • from string Required

    Start Date

  • to string Required

    End Date

  • page_size integer

    The amount of records returns within a single API call.

  • page_number integer

    Current page number of returned records.

get - /metrics/zoomrooms/{zoomroomId}
200 - Zoom Room returned
{
  "account_type": "string",
  "camera": "string",
  "device_ip": "string",
  "email": "string",
  "id": "string",
  "last_start_time": "string",
  "microphone": "string",
  "room_name": "string",
  "speaker": "string",
  "status": "string",
  "live_meeting": {
    "duration": "string",
    "email": "string",
    "end_time": "string",
    "has_3rd_party_audio": true,
    "has_pstn": true,
    "has_recording": true,
    "has_screen_share": true,
    "has_sip": true,
    "has_video": true,
    "has_voip": true,
    "host": "string",
    "id": 123,
    "participants": 123,
    "start_time": "string",
    "topic": "string",
    "user_type": "string",
    "uuid": "string"
  },
  "past_meetings": {
    "from": "string",
    "to": "string",
    "next_page_token": "string",
    "page_count": 123,
    "page_size": 123,
    "total_records": 123,
    "meetings": [
      {
        "duration": "string",
        "email": "string",
        "end_time": "string",
        "has_3rd_party_audio": true,
        "has_pstn": true,
        "has_recording": true,
        "has_screen_share": true,
        "has_sip": true,
        "has_video": true,
        "has_voip": true,
        "host": "string",
        "id": 123,
        "participants": 123,
        "start_time": "string",
        "topic": "string",
        "user_type": "string",
        "uuid": "string"
      },
      {
        "duration": "string",
        "email": "string",
        "end_time": "string",
        "has_3rd_party_audio": true,
        "has_pstn": true,
        "has_recording": true,
        "has_screen_share": true,
        "has_sip": true,
        "has_video": true,
        "has_voip": true,
        "host": "string",
        "id": 123,
        "participants": 123,
        "start_time": "string",
        "topic": "string",
        "user_type": "string",
        "uuid": "string"
      },
      {
        "duration": "string",
        "email": "string",
        "end_time": "string",
        "has_3rd_party_audio": true,
        "has_pstn": true,
        "has_recording": true,
        "has_screen_share": true,
        "has_sip": true,
        "has_video": true,
        "has_voip": true,
        "host": "string",
        "id": 123,
        "participants": 123,
        "start_time": "string",
        "topic": "string",
        "user_type": "string",
        "uuid": "string"
      }
    ]
  }
}

Reports


Report operations

Retrieve daily report


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

Parameters

  • year integer

    Year for this report

  • month integer

    Month for this report

get - /report/daily
200 - Daily Report Returned
{
  "dates": [
    {
      "date": "string",
      "meeting_minutes": 123,
      "meetings": 123,
      "new_users": 123,
      "participants": 123
    },
    {
      "date": "string",
      "meeting_minutes": 123,
      "meetings": 123,
      "new_users": 123,
      "participants": 123
    },
    {
      "date": "string",
      "meeting_minutes": 123,
      "meetings": 123,
      "new_users": 123,
      "participants": 123
    }
  ],
  "month": 123,
  "year": 123
}

Retrieve meeting details report


Retrieve ended meeting details report

Parameters

  • meetingId integer Required

    The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.

get - /report/meetings/{meetingId}
200 - Meeting detail Returned
{
  "duration": 123,
  "end_time": "string",
  "id": 123,
  "participants_count": 123,
  "start_time": "string",
  "topic": "string",
  "total_minutes": 123,
  "type": 123,
  "user_email": "string",
  "user_name": "string",
  "uuid": "string"
}
404 - Meeting not found

Retrieve meeting participants report


Retrieve ended meeting participants report

Parameters

  • meetingId integer Required

    The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.

  • page_size integer

    The amount of records returns within a single API call.

  • 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 - /report/meetings/{meetingId}/participants
200 - Meeting Participants Report Returned
{
  "next_page_token": "string",
  "page_count": 123,
  "page_size": 123,
  "total_records": 123,
  "participants": [
    {
      "attentiveness_score": 123,
      "duration": 123,
      "join_time": "string",
      "leave_time": "string",
      "name": "string",
      "user_email": "string"
    },
    {
      "attentiveness_score": 123,
      "duration": 123,
      "join_time": "string",
      "leave_time": "string",
      "name": "string",
      "user_email": "string"
    },
    {
      "attentiveness_score": 123,
      "duration": 123,
      "join_time": "string",
      "leave_time": "string",
      "name": "string",
      "user_email": "string"
    }
  ]
}
404 - Meeting not found

Retrieve telephone report


Retrieve telephone report for a specified period

Parameters

  • from string Required

    Start Date

  • to string Required

    End Date

  • type string

    Audio type

  • page_size integer

    The amount of records returns within a single API call.

  • page_number integer

    Current page number of returned records.

get - /report/telephone
200 - Telephone Report Returned
{
  "from": "string",
  "to": "string",
  "page_count": 123,
  "page_number": 123,
  "page_size": 123,
  "total_records": 123,
  "telephony_usage": [
    {
      "dept": "string",
      "duration": 123,
      "end_time": "string",
      "host_email": "string",
      "host_name": "string",
      "meeting_id": 123,
      "phone_number": "string",
      "start_time": "string",
      "total": ""
    },
    {
      "dept": "string",
      "duration": 123,
      "end_time": "string",
      "host_email": "string",
      "host_name": "string",
      "meeting_id": 123,
      "phone_number": "string",
      "start_time": "string",
      "total": ""
    },
    {
      "dept": "string",
      "duration": 123,
      "end_time": "string",
      "host_email": "string",
      "host_name": "string",
      "meeting_id": 123,
      "phone_number": "string",
      "start_time": "string",
      "total": ""
    }
  ]
}

Retrieve hosts report


Retrieve active or inactive hosts report for a specified period

Parameters

  • from string Required

    Start Date

  • to string Required

    End Date

  • type string

    Active hosts or inactive hosts

  • page_size integer

    The amount of records returns within a single API call.

  • page_number integer

    Current page number of returned records.

get - /report/users
200 - Active/Inactive Hosts Report Returned
{
  "from": "string",
  "to": "string",
  "page_count": 123,
  "page_number": 123,
  "page_size": 123,
  "total_records": 123,
  "total_meeting_minutes": 123,
  "total_meetings": 123,
  "total_participants": 123,
  "users": [
    {
      "dept": "string",
      "email": "string",
      "id": "string",
      "meeting_minutes": 123,
      "meetings": 123,
      "participants": 123,
      "type": 123,
      "user_name": "string"
    },
    {
      "dept": "string",
      "email": "string",
      "id": "string",
      "meeting_minutes": 123,
      "meetings": 123,
      "participants": 123,
      "type": 123,
      "user_name": "string"
    },
    {
      "dept": "string",
      "email": "string",
      "id": "string",
      "meeting_minutes": 123,
      "meetings": 123,
      "participants": 123,
      "type": 123,
      "user_name": "string"
    }
  ]
}

Retrieve meetings report


Retrieve ended meetings report for a specified period

Parameters

  • userId string Required

    The user ID or email address

  • from string Required

    Start Date

  • to string Required

    End Date

  • page_size integer

    The amount of records returns within a single API call.

  • 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 - /report/users/{userId}/meetings
200 - Active/Inactive Hosts Report Returned
{
  "from": "string",
  "to": "string",
  "next_page_token": "string",
  "page_count": 123,
  "page_size": 123,
  "total_records": 123,
  "meetings": [
    {
      "duration": 123,
      "end_time": "string",
      "id": 123,
      "participants_count": 123,
      "start_time": "string",
      "topic": "string",
      "total_minutes": 123,
      "type": 123,
      "user_email": "string",
      "user_name": "string",
      "uuid": "string"
    },
    {
      "duration": 123,
      "end_time": "string",
      "id": 123,
      "participants_count": 123,
      "start_time": "string",
      "topic": "string",
      "total_minutes": 123,
      "type": 123,
      "user_email": "string",
      "user_name": "string",
      "uuid": "string"
    },
    {
      "duration": 123,
      "end_time": "string",
      "id": 123,
      "participants_count": 123,
      "start_time": "string",
      "topic": "string",
      "total_minutes": 123,
      "type": 123,
      "user_email": "string",
      "user_name": "string",
      "uuid": "string"
    }
  ]
}
404 - User not found

Retrieve webinar details report


Retrieve ended webinar details report

Parameters

  • webinarId integer Required

    The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance.

get - /report/webinars/{webinarId}
200 - Webinar detail Returned
{
  "duration": 123,
  "end_time": "string",
  "id": 123,
  "participants_count": 123,
  "start_time": "string",
  "topic": "string",
  "total_minutes": 123,
  "type": 123,
  "user_email": "string",
  "user_name": "string",
  "uuid": "string"
}
404 - Webinar not found

Retrieve webinar participants report


Retrieve ended webinar participants report

Parameters

  • webinarId integer Required

    The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance.

  • page_size integer

    The amount of records returns within a single API call.

  • 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 - /report/webinars/{webinarId}/participants
200 - Meeting Participants Report Returned
{
  "next_page_token": "string",
  "page_count": 123,
  "page_size": 123,
  "total_records": 123,
  "participants": [
    {
      "attentiveness_score": "string",
      "duration": 123,
      "join_time": "string",
      "leave_time": "string",
      "name": "string",
      "user_email": "string"
    },
    {
      "attentiveness_score": "string",
      "duration": 123,
      "join_time": "string",
      "leave_time": "string",
      "name": "string",
      "user_email": "string"
    },
    {
      "attentiveness_score": "string",
      "duration": 123,
      "join_time": "string",
      "leave_time": "string",
      "name": "string",
      "user_email": "string"
    }
  ]
}
404 - Webinar not found

Retrieve webinar polls report


Retrieve ended webinar polls report

Parameters

  • webinarId integer Required

    The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance.

get - /report/webinars/{webinarId}/polls
200 - Webinar Polls Report Returned
{
  "id": 123,
  "questions": [
    {
      "email": "string",
      "name": "string",
      "question_details": [
        {
          "answer": "string",
          "question": "string"
        },
        {
          "answer": "string",
          "question": "string"
        },
        {
          "answer": "string",
          "question": "string"
        }
      ]
    },
    {
      "email": "string",
      "name": "string",
      "question_details": [
        {
          "answer": "string",
          "question": "string"
        },
        {
          "answer": "string",
          "question": "string"
        },
        {
          "answer": "string",
          "question": "string"
        }
      ]
    },
    {
      "email": "string",
      "name": "string",
      "question_details": [
        {
          "answer": "string",
          "question": "string"
        },
        {
          "answer": "string",
          "question": "string"
        },
        {
          "answer": "string",
          "question": "string"
        }
      ]
    }
  ],
  "start_time": "string",
  "uuid": "string"
}
404 - Webinar not found

Retrieve webinar Q&A report


Retrieve ended webinar Q&A report

Parameters

  • webinarId integer Required

    The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance.

get - /report/webinars/{webinarId}/qa
200 - Webinar Q&A Report Returned
{
  "id": 123,
  "questions": [
    {
      "email": "string",
      "name": "string",
      "question_details": [
        {
          "answer": "string",
          "question": "string"
        },
        {
          "answer": "string",
          "question": "string"
        },
        {
          "answer": "string",
          "question": "string"
        }
      ]
    },
    {
      "email": "string",
      "name": "string",
      "question_details": [
        {
          "answer": "string",
          "question": "string"
        },
        {
          "answer": "string",
          "question": "string"
        },
        {
          "answer": "string",
          "question": "string"
        }
      ]
    },
    {
      "email": "string",
      "name": "string",
      "question_details": [
        {
          "answer": "string",
          "question": "string"
        },
        {
          "answer": "string",
          "question": "string"
        },
        {
          "answer": "string",
          "question": "string"
        }
      ]
    }
  ],
  "start_time": "string",
  "uuid": "string"
}
404 - Webinar not found

TSP


TSP operations

List TSP dial-in numbers


List TSP dial-in numbers under account

get - /tsp
200 - TSP dial-in numbers returned
{
  "dial_in_numbers": [
    {
      "code": "string",
      "number": "string",
      "type": "string"
    },
    {
      "code": "string",
      "number": "string",
      "type": "string"
    },
    {
      "code": "string",
      "number": "string",
      "type": "string"
    }
  ],
  "tsp_provider": "string"
}

List user's TSP accounts


List user's TSP accounts

Parameters

  • userId string Required

    The user ID or email address

get - /users/{userId}/tsp
200 - TSP Account list returned
{
  "tsp_accounts": [
    {
      "conference_code": "string",
      "dial_in_numbers": {
        "code": "string",
        "number": "string"
      },
      "leader_pin": "string"
    },
    {
      "conference_code": "string",
      "dial_in_numbers": {
        "code": "string",
        "number": "string"
      },
      "leader_pin": "string"
    },
    {
      "conference_code": "string",
      "dial_in_numbers": {
        "code": "string",
        "number": "string"
      },
      "leader_pin": "string"
    }
  ]
}
404 - User not found

Add a user's TSP account


Add a user's TSP account

Parameters

  • conference_code string Required

    Conference code, numeric value, length is less than 16.

  • leader_pin string Required

    Leader PIN, numeric value, length is less than 16.

  • object

    Dial In Numbers object

    • code string Required

      Country Code

    • number string Required

      Dial-in number, length is less than 16.

post - /users/{userId}/tsp
201 - TSP Account added
{
  "conference_code": "string",
  "dial_in_numbers": {
    "code": "string",
    "number": "string"
  },
  "leader_pin": "string"
}

Delete a user's TSP account


Delete a user's TSP account

Parameters

  • userId string Required

    The user ID or email address

  • tspId string Required

    TSP account index

delete - /users/{userId}/tsp/{tspId}
204 - TSP Account deleted

Retrieve a user's TSP account


Retrieve a user's TSP account

Parameters

  • userId string Required

    The user ID or email address

  • tspId string Required

    TSP account index

get - /users/{userId}/tsp/{tspId}
200 - TSP Account returned
{
  "conference_code": "string",
  "dial_in_numbers": {
    "code": "string",
    "number": "string"
  },
  "leader_pin": "string"
}

Update a TSP account


Update a user's TSP account

Parameters

  • conference_code string Required

    Conference code, numeric value, length is less than 16.

  • leader_pin string Required

    Leader PIN, numeric value, length is less than 16.

  • object

    Dial In Numbers object

    • code string Required

      Country Code

    • number string Required

      Dial-in number, length is less than 16.

patch - /users/{userId}/tsp/{tspId}
204 - TSP Account updated

Users


User operations

List Users


List users on your account

Parameters

  • status string

    User status

  • page_size integer

    The amount of records returns within a single API call.

  • page_number integer

    Current page number of returned records.

get - /users
200 - User list returned
{
  "page_count": 123,
  "page_number": 123,
  "page_size": 123,
  "total_records": 123,
  "users": [
    {
      "id": "string",
      "created_at": "string",
      "dept": "string",
      "email": "string",
      "first_name": "string",
      "last_client_version": "string",
      "last_login_time": "string",
      "last_name": "string",
      "pmi": "string",
      "timezone": "string",
      "type": 123
    },
    {
      "id": "string",
      "created_at": "string",
      "dept": "string",
      "email": "string",
      "first_name": "string",
      "last_client_version": "string",
      "last_login_time": "string",
      "last_name": "string",
      "pmi": "string",
      "timezone": "string",
      "type": 123
    },
    {
      "id": "string",
      "created_at": "string",
      "dept": "string",
      "email": "string",
      "first_name": "string",
      "last_client_version": "string",
      "last_login_time": "string",
      "last_name": "string",
      "pmi": "string",
      "timezone": "string",
      "type": 123
    }
  ]
}

Create a user


Create a user on your account

Parameters

  • action string Required

    Action to take for user creation

  • user_info
post - /users
201 - User Created
{
  "email": "string",
  "first_name": "string",
  "id": "string",
  "last_name": "string",
  "type": 123
}
409 - User with that email already exists

Check a user's email


Check if the user email exists.

Parameters

  • email string Required

    User email

get - /users/email
200 - Success
{
  "existed_email": true
}

Verify a user's zpk


Check if the zpk is expired. The zpk is used to authenticate a user.

Parameters

  • zpk string Required

    User zpk

get - /users/zpk
200 - Success
{
  "expire_in": 123
}

Delete a user


Delete a user on your account

Parameters

  • userId string Required

    The user ID or email address

  • action string

    Delete action type

delete - /users/{userId}
204 - User deleted
404 - User not found

Retrieve a user


Retrieve a user on your account

Parameters

  • userId string Required

    The user ID or email address

  • login_type string
get - /users/{userId}
200 - User object returned
{
  "id": "string",
  "created_at": "string",
  "dept": "string",
  "email": "string",
  "first_name": "string",
  "last_client_version": "string",
  "last_login_time": "string",
  "last_name": "string",
  "pmi": "string",
  "timezone": "string",
  "type": 123,
  "pic_url": "string",
  "vanity_url": "string",
  "verified": 123
}
404 - User not found

Update a user


Update a user on your account

Parameters

  • cms_user_id string

    Kaltura User Id.

  • dept string

    Department for user profile, use for report.

  • first_name string

    User's first name. Cannot contain more than 5 Chinese words.

  • host_key string

    Host Key, should be 6-digit number.

  • last_name string

    User's last name. Cannot contain more than 5 Chinese words.

  • pmi string

    Personal Meeting ID,length must be 10.

  • timezone string

    The time zone id for user profile. For this parameter value please refer to the id value in timezone list.

  • type integer

    User's type

  • vanity_name string

    Personal meeting room name.

patch - /users/{userId}
204 - User updated
404 - User not found

Delete a user's assistants


Delete all of a user'sassitants

Parameters

  • userId string Required

    The user ID or email address

delete - /users/{userId}/assistants
204 - Assitants deleted.
404 - User not found

List a user's assistants


List a user's assistants

Parameters

  • userId string Required

    The user ID or email address

get - /users/{userId}/assistants
200 - Success
{
  "assistants": [
    {
      "email": "string",
      "id": "string"
    },
    {
      "email": "string",
      "id": "string"
    },
    {
      "email": "string",
      "id": "string"
    }
  ]
}
404 - User not found

Add assistants


Add assistants to a user

Parameters

  • assistants array
post - /users/{userId}/assistants
201 - Assitant Added
{
  "add_at": "string",
  "ids": "string"
}
404 - User not found

Delete a user's assistant


Delete one of a user's assistants

Parameters

  • userId string Required

    The user ID or email address

  • assistantId string Required

    Assistant's ID

delete - /users/{userId}/assistants/{assistantId}
204 - Assitant deleted.
404 - User or Assistant not found

Update a user's password


Update a user's password

Parameters

  • password string Required

    User’s password. Character length is less than 32.

put - /users/{userId}/password
204 - Password updated
404 - User not found

Upload a user's picture


Upload a user's profile picture

Parameters

  • userId string Required

    The user ID or email address

  • pic_file file Required

    User picture file, must be a jpg/jpeg file

post - /users/{userId}/picture
201 - Picture Uploaded
404 - User not found

Retrieve a user's settings


Retrieve a user's settings

Parameters

  • userId string Required

    The user ID or email address

  • login_type string
get - /users/{userId}/settings
200 - User settings returned
{
  "email_notification": {
    "alternative_host_reminder": true,
    "cancel_meeting_reminder": true,
    "jbh_reminder": true
  },
  "feature": {
    "large_meeting": true,
    "large_meeting_capacity": 123,
    "meeting_capacity": 123,
    "webinar": true,
    "webinar_capacity": 123
  },
  "in_meeting": {
    "annotation": true,
    "attendee_on_hold": true,
    "attention_tracking": true,
    "auto_saving_chat": true,
    "breakout_room": true,
    "chat": true,
    "closed_caption": true,
    "co_host": true,
    "e2e_encryption": true,
    "entry_exit_chime": "string",
    "far_end_camera_control": true,
    "feedback": true,
    "file_transfer": true,
    "group_hd": true,
    "non_verbal_feedback": true,
    "polling": true,
    "private_chat": true,
    "record_play_voice": true,
    "remote_control": true,
    "remote_support": true,
    "share_dual_camera": true,
    "virtual_background": true,
    "waiting_room": true
  },
  "recording": {
    "auto_delete_cmr": true,
    "auto_delete_cmr_days": 123,
    "auto_recording": "string",
    "cloud_recording": true,
    "local_recording": true,
    "record_audio_file": true,
    "record_gallery_view": true,
    "record_speaker_view": true,
    "recording_audio_transcript": true,
    "save_chat_text": true,
    "show_timestamp": true
  },
  "scheduled_meeting": {
    "audio_type": "string",
    "force_pmi_jbh_password": true,
    "host_video": true,
    "join_before_host": true,
    "participants_video": true,
    "pstn_password_protected": true
  },
  "telephony": {
    "audio_conference_info": "string",
    "show_international_numbers_link": true,
    "third_party_audio": true
  }
}
404 - User not found

Update a user's settings


Update a user's settings

Parameters

  • object
    • alternative_host_reminder boolean

      When an alternative host is set or removed from a meeting

    • cancel_meeting_reminder boolean

      When a meeting is cancelled

    • jbh_reminder boolean

      When attendees join meeting before host

  • object
    • large_meeting boolean

      Large meting feature

    • large_meeting_capacity integer

      Large meeting capacity, can be 100, 200, 300 or 500, depends on if having related large meeting capacity plan subscription or not.

    • meeting_capacity integer

      User’s meeting capacity.

    • webinar boolean

      Webinar feature

    • webinar_capacity integer

      Webinar capacity, can be 100, 500, 1000, 3000, 5000 or 10000, depends on if having related webinar capacity plan subscription or not.

  • object
    • annotation boolean

      Annotation

    • attendee_on_hold boolean

      Allow host to put attendee on hold

    • attention_tracking boolean

      Attention tracking

    • auto_saving_chat boolean

      Auto saving chats

    • breakout_room boolean

      Breakout room

    • chat boolean

      Chat

    • closed_caption boolean

      Closed caption

    • co_host boolean

      Co-host

    • e2e_encryption boolean

      End-to-end encryption

    • entry_exit_chime string

      Play sound on join/leave

    • far_end_camera_control boolean

      Far end camera control

    • feedback boolean

      Feedback to Zoom

    • file_transfer boolean

      File transfer

    • group_hd boolean

      Group HD video

    • non_verbal_feedback boolean

      Non-verbal feedback

    • polling boolean

      Polling

    • private_chat boolean

      Private chat

    • record_play_voice boolean

      Record and play their own voice

    • remote_control boolean

      Remote control

    • remote_support boolean

      Remote support

    • share_dual_camera boolean

      Share dual camera

    • virtual_background boolean

      Virtual background

    • waiting_room boolean

      Waiting room

  • object
    • auto_delete_cmr boolean

      Auto delete cloud recordings

    • auto_delete_cmr_days integer

      A specified number of days of auto delete cloud recordings

    • auto_recording string

      Automatic recording

    • cloud_recording boolean

      Cloud recording

    • local_recording boolean

      Local recording

    • record_audio_file boolean

      Record an audio only file

    • record_gallery_view boolean

      Record the gallery view

    • record_speaker_view boolean

      Record the active speaker view

    • recording_audio_transcript boolean

      Audio transcript

    • save_chat_text boolean

      Save chat text from the meeting

    • show_timestamp boolean

      Show timestamp on video

  • object
    • audio_type string

      Meeting audio

    • force_pmi_jbh_password boolean

      Require a password for Personal Meetings if attendees can join before host

    • host_video boolean

      Host video

    • join_before_host boolean

      Join before host

    • participants_video boolean

      Participants video

    • pstn_password_protected boolean

      Generate and require password for participants joining by phone

  • object
    • audio_conference_info string

      3rd party audio conference info

    • show_international_numbers_link boolean

      Show international numbers link on the invitation email

    • third_party_audio boolean

      3rd party audio conference

patch - /users/{userId}/settings
204 - User setting's updated
404 - User not found

Update a user's status


Update a user's status

Parameters

  • action string Required

    The action type

put - /users/{userId}/status
204 - Status updated
404 - User not found

Revoke a user's SSO token


Revoke a user's SSO token

Parameters

  • userId string Required

    The user ID or email address

delete - /users/{userId}/token
204 - Token deleted
404 - User not found

Retrieve a user's token


Retrieve a user's token

Parameters

  • userId string Required

    The user ID or email address

  • type string

    User token type

get - /users/{userId}/token
200 - Token returned
{
  "token": "string"
}
404 - User not found

Webinars


Webinar operations

List webinars


List webinars for a user

Parameters

  • userId string Required

    The user ID or email address

  • page_size integer

    The amount of records returns within a single API call.

  • page_number integer

    Current page number of returned records.

get - /users/{userId}/webinars
200 - List of Webinar objects returned
{
  "page_count": 123,
  "page_number": 123,
  "page_size": 123,
  "total_records": 123,
  "webinars": [
    {
      "created_at": "string",
      "duration": 123,
      "host_id": "string",
      "id": "string",
      "join_url": "string",
      "timezone": "string",
      "topic": "string",
      "type": 123,
      "uuid": "string"
    },
    {
      "created_at": "string",
      "duration": 123,
      "host_id": "string",
      "id": "string",
      "join_url": "string",
      "timezone": "string",
      "topic": "string",
      "type": 123,
      "uuid": "string"
    },
    {
      "created_at": "string",
      "duration": 123,
      "host_id": "string",
      "id": "string",
      "join_url": "string",
      "timezone": "string",
      "topic": "string",
      "type": 123,
      "uuid": "string"
    }
  ]
}
404 - User not found

Create a webinar


Create a webinar for a user

Parameters

  • agenda string

    Webinar description

  • duration integer

    Webinar duration (minutes). Used for scheduled webinar only.

  • password string

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

  • object

    Recurrence object

    • end_date_time string

      Recurrence Meeting End Date. Should be UTC time, such as 2017-11-25T12:00:00Z.

    • end_times integer

      Recurrence Meeting End occurrences times

    • monthly_day integer

      Recurrence Meeting Occurs on a month day. The value range is from 1 to 31

    • monthly_week integer

      Recurrence Meeting Occurs on the week of a month.

    • monthly_week_day integer

      Recurrence Meeting Occurs on the week day of a month

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

    • type integer

      Recurrence meeting type

    • weekly_days integer

      Recurrence Meeting Occurs on week days, multiple value separated by comma

  • object

    Webinar Settings

    • allow_multiple_devices boolean

      Allow attendees to join from multiple devices.

    • alternative_hosts string

      Alternative hosts emails or IDs. Multiple value separated by comma.

    • approval_type integer
    • audio string

      Meeting audio options

    • auto_recording string
    • close_registration boolean

      Close registration after event date.

    • 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

    • hd_video boolean

      Default to HD Video

    • host_video boolean

      Start video when host join webinar

    • panelists_video boolean

      Start video when panelists join webinar

    • practice_session boolean

      Enable Practice Session

    • registration_type integer

      Registration type. Used for recurring webinar with fixed time only.

    • show_share_button boolean

      Show social share buttons on registration page.

  • start_time string

    Webinar 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 webinar and recurring webinar with fixed time.

  • timezone string

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

  • topic string

    Webinar topic

  • type integer

    Webinar Type

post - /users/{userId}/webinars
201 - Webinar Created
{
  "host_id": "string",
  "id": "string",
  "uuid": "string",
  "agenda": "string",
  "created_at": "string",
  "duration": 123,
  "join_url": "string",
  "occurrences": [
    {
      "duration": 123,
      "occurrence_id": 123,
      "start_time": "string",
      "status": "string"
    },
    {
      "duration": 123,
      "occurrence_id": 123,
      "start_time": "string",
      "status": "string"
    },
    {
      "duration": 123,
      "occurrence_id": 123,
      "start_time": "string",
      "status": "string"
    }
  ],
  "settings": {
    "allow_multiple_devices": true,
    "alternative_hosts": "string",
    "approval_type": 123,
    "audio": "string",
    "auto_recording": "string",
    "close_registration": true,
    "enforce_login": true,
    "enforce_login_domains": "string",
    "hd_video": true,
    "host_video": true,
    "panelists_video": true,
    "practice_session": true,
    "registration_type": 123,
    "show_share_button": true
  },
  "start_time": "string",
  "start_url": "string",
  "timezone": "string",
  "topic": "string",
  "type": 123
}
404 - User not found

Delete a webinar


Delete a webinar

Parameters

  • webinarId integer Required

    The webinar ID

  • occurrence_id string

    The meeting occurrence ID

delete - /webinars/{webinarId}
204 - Webinar deleted
404 - Webinar not found

Retrieve a webinar


Retrieve a webinar

Parameters

  • webinarId integer Required

    The webinar ID

get - /webinars/{webinarId}
200 - Webinar object returned
{
  "host_id": "string",
  "id": "string",
  "uuid": "string",
  "agenda": "string",
  "created_at": "string",
  "duration": 123,
  "join_url": "string",
  "occurrences": [
    {
      "duration": 123,
      "occurrence_id": 123,
      "start_time": "string",
      "status": "string"
    },
    {
      "duration": 123,
      "occurrence_id": 123,
      "start_time": "string",
      "status": "string"
    },
    {
      "duration": 123,
      "occurrence_id": 123,
      "start_time": "string",
      "status": "string"
    }
  ],
  "settings": {
    "allow_multiple_devices": true,
    "alternative_hosts": "string",
    "approval_type": 123,
    "audio": "string",
    "auto_recording": "string",
    "close_registration": true,
    "enforce_login": true,
    "enforce_login_domains": "string",
    "hd_video": true,
    "host_video": true,
    "panelists_video": true,
    "practice_session": true,
    "registration_type": 123,
    "show_share_button": true
  },
  "start_time": "string",
  "start_url": "string",
  "timezone": "string",
  "topic": "string",
  "type": 123
}
404 - Webinar not found

Update a webinar


Update a webinar

Parameters

  • agenda string

    Webinar description

  • duration integer

    Webinar duration (minutes). Used for scheduled webinar only.

  • password string

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

  • object

    Recurrence object

    • end_date_time string

      Recurrence Meeting End Date. Should be UTC time, such as 2017-11-25T12:00:00Z.

    • end_times integer

      Recurrence Meeting End occurrences times

    • monthly_day integer

      Recurrence Meeting Occurs on a month day. The value range is from 1 to 31

    • monthly_week integer

      Recurrence Meeting Occurs on the week of a month.

    • monthly_week_day integer

      Recurrence Meeting Occurs on the week day of a month

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

    • type integer

      Recurrence meeting type

    • weekly_days integer

      Recurrence Meeting Occurs on week days, multiple value separated by comma

  • settings
  • start_time string

    Webinar 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 webinar and recurring webinar with fixed time.

  • timezone string

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

  • topic string

    Webinar topic

  • type integer

    Webinar Type

patch - /webinars/{webinarId}
204 - Webinar Updated
404 - Webinar not found

Remove a webinar's panelists


Remove all panelists from a webinar

Parameters

  • webinarId integer Required

    The webinar ID

delete - /webinars/{webinarId}/panelists
204 - Panelists removed
404 - Webinar not found

List a webinar's panelists


List panelists for a webinar

Parameters

  • webinarId integer Required

    The webinar ID

get - /webinars/{webinarId}/panelists
200 - Success
{
  "panelists": [
    {
      "id": "string",
      "email": "string",
      "name": "string",
      "join_url": "string"
    },
    {
      "id": "string",
      "email": "string",
      "name": "string",
      "join_url": "string"
    },
    {
      "id": "string",
      "email": "string",
      "name": "string",
      "join_url": "string"
    }
  ],
  "total_records": 123
}
404 - Webinar not found

Add a webinar panelist


Add panelist to webinar

Parameters

  • panelists array
post - /webinars/{webinarId}/panelists
201 - Panelist created
{
  "id": "string",
  "join_url": "string"
}
404 - Webinar not found

Remove a webinar panelist


Remove a panelist from a webinar

Parameters

  • webinarId integer Required

    The webinar ID

  • panelistId integer Required

    The panelist ID

delete - /webinars/{webinarId}/panelists/{panelistId}
204 - Panelists removed
404 - Webinar or Panelist not found

List a webinar's registrants


List registrants for a webinar

Parameters

  • webinarId integer Required

    The webinar ID

  • occurrence_id string

    The meeting occurrence ID

  • status string

    The registrant status

  • page_size integer

    The amount of records returns within a single API call.

  • page_number integer

    Current page number of returned records.

get - /webinars/{webinarId}/registrants
200 - Success
{}
404 - Webinar not found

Add a webinar registrant


Add a registrant for a webinar

Parameters

  • email string Required

    A valid email address

  • first_name string Required

    User’s first name

  • last_name string Required

    User’s last name

  • address string

    Address

  • city string

    City

  • comments string

    Questions & Comments

  • country string

    Country

  • custom_questions array

    Custom Question

  • industry string

    Industry

  • job_title string

    Job Title

  • no_of_employees string

    Number of Employees

  • org string

    Organization

  • phone string

    Phone

  • purchasing_time_frame string

    Purchasing Time Frame

  • role_in_purchase_process string

    Role in Purchase Process

  • state string

    State/Province

  • zip string

    Zip/Postal Code

post - /webinars/{webinarId}/registrants
201 - Registration created
{
  "id": "string",
  "join_url": "string",
  "registrant_id": "string",
  "start_time": "string",
  "topic": "string"
}
404 - Webinar not found

Update a webinar registrant's status


Update a webinar registrant's status

Parameters

  • action string Required
  • registrants array
put - /webinars/{webinarId}/registrants/status
204 - Registrant status updated
404 - Webinar or Registrant not found

Update a webinar's status


Update a webinar's status

Parameters

  • status string
put - /webinars/{webinarId}/status
204 - Webinar updated
404 - Webinar not found

Webhooks


Webhook operations

List webhooks


List webhooks for a account

get - /webhooks
200 - List of Webhook objects returned
{
  "total_records": 123,
  "webhooks": [
    {
      "webhook_id": "string",
      "auth_password": "string",
      "auth_user": "string",
      "events": [
        {},
        {},
        {}
      ],
      "url": "string"
    },
    {
      "webhook_id": "string",
      "auth_password": "string",
      "auth_user": "string",
      "events": [
        {},
        {},
        {}
      ],
      "url": "string"
    },
    {
      "webhook_id": "string",
      "auth_password": "string",
      "auth_user": "string",
      "events": [
        {},
        {},
        {}
      ],
      "url": "string"
    }
  ]
}
404 - Webhook not found

Create a webhook


Create a webhook for a account

Parameters

  • auth_password string Required

    Webhook auth password.

  • auth_user string Required

    Webhook auth user name.

  • url string Required

    Webhook endpoint

  • events array
post - /webhooks
201 - Webhook Created
{
  "webhook_id": "string",
  "auth_password": "string",
  "auth_user": "string",
  "events": [
    {},
    {},
    {}
  ],
  "url": "string",
  "created_at": "string"
}
404 - Account not found

Switch webhook version


Switch webhook version

Parameters

  • version string Required
patch - /webhooks/options
204 - Webhook Subscribe version update
404 - Webhook Subscribe not found

Delete a webhook


Delete a webhook

Parameters

  • webhookId string Required

    The webhook ID

delete - /webhooks/{webhookId}
204 - Webhook deleted
404 - Webhook not found

Retrieve a webhook


Retrieve a webhook

Parameters

  • webhookId string Required

    The webhook ID

get - /webhooks/{webhookId}
200 - Webhook object returned
{
  "webhook_id": "string",
  "auth_password": "string",
  "auth_user": "string",
  "events": [
    {},
    {},
    {}
  ],
  "url": "string",
  "created_at": "string"
}
404 - Webinar not found

Update a webhook


Update a webhook

Parameters

  • auth_password string

    Webhook auth password.

  • auth_user string

    Webhook auth user name.

  • events array
  • url string

    Webhook endpoint.

patch - /webhooks/{webhookId}
204 - Webhook Updated
404 - Webhook not found