Meeting management

Configure event notifications

POST /server/v1/meet/set-callback Authentication: required (see Overview) Configure callback settings Request parameters

array<string>

Events to subscribe to

string

Callback URL

Request example:

{
  "cb_url": "",
  "events": [
    ""
  ]
}

Response parameters

string

Response data

Response example:

{
  "code": 0,
  "data": ""
}

List meetings

POST /server/v1/meet/list-meet Authentication: required (see Overview) Meeting list Request parameters

string

Room number

string

Meeting ID

array<string>

Meeting ID list

integer

Filter by meeting type. 1: instant meeting, 2: scheduled meeting

array<integer>

Filter by meeting status, multiple allowed. 1: not started, 2: in progress, 3: ended

string

Filter by creator user ID

integer

Start time

integer

End time

integer

Range of scheduled meeting start time

integer

Range of scheduled meeting start time

integer

Start time (timestamp); required for scheduled meetings

string

Sort order. Sortable field: created_at; prefix - for descending order (sortable fields: created_at)

integer

Page number, starting from 1 Example: 1

integer

Items per page Example: 10

Request example:

{
  "begin_at": 0,
  "creator": "",
  "end_at": 0,
  "meeting_id": "",
  "meeting_ids": [
    ""
  ],
  "meeting_status": [
    0
  ],
  "meeting_type": 0,
  "page": 1,
  "per-page": 10,
  "plan_begin_at": 0,
  "plan_end_at": 0,
  "plan_time": 0,
  "room_no": "",
  "sort": ""
}

Response parameters

string

Meeting ID

string

Room number

string

Meeting title

string

Meeting description

integer

Meeting status. 1: not started, 2: in progress, 3: ended

integer

1: unrestricted (default), 2: password required, 3: invitees only

integer

Meeting type. 1: instant meeting, 2: scheduled meeting

integer

Start time (timestamp); required for scheduled meetings

integer

Duration (minutes); required for scheduled meetings

integer

Start time

integer

End time

integer

Timestamp when the last member exited; 0 if the meeting has not ended

integer

Mute-on-entry option

boolean

Whether the watermark is off. false: on, true: off

boolean

Whether screenshots are disabled. false: allowed, true: disabled

boolean

Whether members can unmute themselves when audio is disabled in the room. false: allowed, true: not allowed

boolean

Whether members can turn their camera back on when the camera is off for everyone in the room. false: allowed, true: not allowed

boolean

Audio disabled in the room. false: allowed, true: disabled

boolean

Camera off for everyone in the room. false: no, true: yes

Disable sharing. false: no (default), true: yes

boolean

Chat disabled in the room. false: allowed, true: disabled

boolean

Whether the waiting room is off. false: on, true: off

boolean

Block entry before the host. false: allowed, true: blocked

boolean

Force entry

boolean

Lock status. false: unlocked, true: locked

object

Extension field

string

Meeting creator ID

string

Meeting creator name

string

Host user ID

array<string>

Co-host user ID list

array<string>

Invitee ID list

array<object>

Invitee details list

Show Element fields

string

User ID

string

Real name

string

In-meeting display name

string

User avatar

integer

User role. 0: regular member, 1: host, 2: co-host

integer

Meeting mode. 1: normal, 2: composite

boolean

Whether to record automatically

any

Layout data

integer

Recording status. 0: pending, 1: in progress, 2: stopping, 3: ended abnormally, 4: ended normally

integer

Creation time (timestamp)

integer

Update time

Response example:

{
  "_meta": {
    "currentPage": 1,
    "pageCount": 5,
    "perPage": 20,
    "totalCount": 100
  },
  "code": 0,
  "data": [
    {
      "attend_type": 0,
      "auto_record": false,
      "begin_time": 0,
      "camera_disabled": false,
      "chat_disabled": false,
      "co_hosts": [
        ""
      ],
      "conferee": [
        ""
      ],
      "conferee_details": [
        {
          "avatar": "",
          "nickname": "",
          "real_name": "",
          "role": 0,
          "user_id": ""
        }
      ],
      "content": "",
      "created_at": 0,
      "creator": "",
      "creator_name": "",
      "end_time": 0,
      "enter_before_host_disabled": false,
      "entry_mute_policy": 0,
      "extend_info": {},
      "force_join": false,
      "host_uid": "",
      "id": "",
      "last_exit_time": 0,
      "layout_data": null,
      "locked": false,
      "meeting_mode": 0,
      "meeting_status": 0,
      "meeting_type": 0,
      "mic_disabled": false,
      "plan_dur": 0,
      "plan_time": 0,
      "record_status": 0,
      "room_no": "",
      "screenshot_disabled": false,
      "self_unmute_camera_disabled": false,
      "self_unmute_mic_disabled": false,
      "share_disabled": false,
      "title": "",
      "updated_at": 0,
      "waiting_room_disabled": false,
      "watermark_disabled": false
    }
  ]
}

List in-meeting members

POST /server/v1/meet/list-user Authentication: required (see Overview) In-meeting members Request parameters

string

Room number

string

Meeting ID

integer

Page number, starting from 1 Example: 1

integer

Items per page Example: 10

Request example:

{
  "meeting_id": "",
  "page": 1,
  "per-page": 10,
  "room_no": ""
}

Response parameters

string

User ID

string

In-meeting display name

integer

User role. 0: regular member, 1: host, 2: co-host

integer

Audio status. 1: on, 2: off

integer

Video status. 1: on, 2: off

Sharing status. 0: none, 1: screen, 2: whiteboard

boolean

Whether the member has been removed

boolean

Whether chat is disabled for this member. false: allowed, true: disabled

integer

Device type. 0: unknown, 1: Windows, 2: Android, 3: iOS, 4: Linux, 5: macOS, 6: WebRTC, 7: Mini Program; 80 and above: devices connected via device integration

string

Extension field, supplied by the client when entering the meeting

integer

Entry time

Response example:

{
  "_meta": {
    "currentPage": 1,
    "pageCount": 5,
    "perPage": 20,
    "totalCount": 100
  },
  "code": 0,
  "data": [
    {
      "camera_state": 0,
      "chat_disabled": false,
      "device_type": 0,
      "extend_info": "",
      "is_kickout": false,
      "join_at": 0,
      "mic_state": 0,
      "nickname": "",
      "role": 0,
      "share_state": 0,
      "user_id": ""
    }
  ]
}

POST /server/v1/meet/meeting-users Authentication: required (see Overview) Meeting-related users Request parameters

string

Room number

string

Meeting ID

integer

Page number, starting from 1 Example: 1

integer

Items per page Example: 10

Request example:

{
  "meeting_id": "",
  "page": 1,
  "per-page": 10,
  "room_no": ""
}

Response parameters

string

User ID

string

Real name

string

In-meeting display name

string

User avatar

integer

User role. 0: regular member, 1: host, 2: co-host

boolean

Whether invited (allowlist)

integer

First entry time

integer

Last exit time

Response example:

{
  "_meta": {
    "currentPage": 1,
    "pageCount": 5,
    "perPage": 20,
    "totalCount": 100
  },
  "code": 0,
  "data": [
    {
      "avatar": "",
      "enter_at": 0,
      "exit_at": 0,
      "is_invite": false,
      "nickname": "",
      "real_name": "",
      "role": 0,
      "user_id": ""
    }
  ]
}

List attendance records

POST /server/v1/meet/list-record Authentication: required (see Overview) Attendance records Request parameters

string

Room number

string

Meeting ID

string

User ID

integer

Start time

integer

End time

string

Sort order. Sortable fields: updated_at / created_at, comma-separated; prefix - for descending order (sortable fields: updated_at, created_at)

integer

Page number, starting from 1 Example: 1

integer

Items per page Example: 10

Request example:

{
  "begin_at": 0,
  "end_at": 0,
  "meeting_id": "",
  "page": 1,
  "per-page": 10,
  "room_no": "",
  "sort": "",
  "user_id": ""
}

Response parameters

string

App ID

string

Meeting ID

string

User ID

string

In-meeting display name

string

Mobile number

integer

User role. 0: regular member, 1: host, 2: co-host

integer

Entry time

integer

Exit time

integer

Device type. 0: unknown, 1: Windows, 2: Android, 3: iOS, 4: Linux, 5: macOS, 6: WebRTC, 7: Mini Program; 80 and above: devices connected via device integration

string

Extension field, supplied by the client when entering the meeting

Response example:

{
  "_meta": {
    "currentPage": 1,
    "pageCount": 5,
    "perPage": 20,
    "totalCount": 100
  },
  "code": 0,
  "data": [
    {
      "app_id": "",
      "device_type": 0,
      "enter_time": 0,
      "exit_time": 0,
      "extend_info": "",
      "meeting_id": "",
      "mobile": "",
      "nickname": "",
      "role": 0,
      "user_id": ""
    }
  ]
}

Send an in-meeting custom message

POST /server/v1/meet/send-room-custom-message Authentication: required (see Overview) Request parameters

string

required

Meeting ID

string

required

Message content, up to 500 characters (max length 500)

string

User ID

Request example:

{
  "content": "",
  "meeting_id": "",
  "target_id": ""
}

Response parameters

string

Response data

Response example:

{
  "code": 0,
  "data": ""
}

Get meeting details

POST /server/v1/meet/detail Authentication: required (see Overview) Request parameters

string

Room number

string

Meeting ID

Request example:

{
  "meeting_id": "",
  "room_no": ""
}

Response parameters

string

Device ID

string

Room number

string

Meeting title

string

Meeting description

integer

Meeting status. 1: not started, 2: in progress, 3: ended

integer

1: unrestricted (default), 2: password required, 3: invitees only

integer

Meeting type. 1: instant meeting, 2: scheduled meeting

string

Password; required when attend_type is 2

integer

Start time (timestamp); required for scheduled meetings

integer

Duration (minutes); required for scheduled meetings

integer

Actual start time (timestamp); 0 if not started

integer

End time

integer

Timestamp when the last member exited; 0 if the meeting has not ended

integer

Current number of online members

integer

Mute on entry. 1: on (everyone is muted on entry), 2: off (follows the client’s initial audio state), 3: mute beyond 6 (members entering after the first 6 are muted). Default: 3

boolean

Whether the watermark is off. false: on, true: off

boolean

Whether screenshots are disabled. false: allowed, true: disabled

boolean

Whether members are prevented from unmuting themselves when everyone is muted. false: not prevented, true: prevented

boolean

Whether members are prevented from turning their camera back on when the camera is off for everyone. false: not prevented, true: prevented

boolean

Mute all. false: not muted, true: muted

boolean

Camera off for everyone. false: no, true: yes

Disable sharing. false: no (default), true: yes

boolean

Whether chat is disabled for everyone. false: allowed, true: disabled

boolean

Whether the waiting room is off. false: on, true: off

boolean

Whether others are blocked from entering before the host. false: allowed, true: blocked

boolean

Force entry

boolean

Lock status; once locked, no one new can enter. false: unlocked, true: locked

object

Extension field

string

Meeting creator ID

string

Meeting creator name

string

Host user ID

array<string>

Co-host user ID list

array<string>

Invitee ID list

array<object>

Invitee details list

Show Element fields

string

User ID

string

Real name

string

In-meeting display name

string

User avatar

integer

User role. 0: regular member, 1: host, 2: co-host

integer

Meeting mode. 1: normal, 2: composite, 3: voice, 4: training, 5: sub-meeting

boolean

Whether to record automatically

any

Layout data

integer

Recording status. 0: pending, 1: in progress, 2: stopping, 3: ended abnormally, 4: ended normally

integer

Creation time (timestamp)

integer

Update time

Response example:

{
  "code": 0,
  "data": {
    "attend_type": 0,
    "auto_record": false,
    "begin_time": 0,
    "camera_disabled": false,
    "chat_disabled": false,
    "co_hosts": [
      ""
    ],
    "conferee": [
      ""
    ],
    "conferee_details": [
      {
        "avatar": "",
        "nickname": "",
        "real_name": "",
        "role": 0,
        "user_id": ""
      }
    ],
    "content": "",
    "created_at": 0,
    "creator": "",
    "creator_name": "",
    "end_time": 0,
    "enter_before_host_disabled": false,
    "entry_mute_policy": 0,
    "extend_info": {},
    "force_join": false,
    "host_uid": "",
    "id": "",
    "last_exit_time": 0,
    "layout_data": null,
    "locked": false,
    "meeting_mode": 0,
    "meeting_status": 0,
    "meeting_type": 0,
    "mic_disabled": false,
    "online_num": 0,
    "password": "",
    "plan_dur": 0,
    "plan_time": 0,
    "record_status": 0,
    "room_no": "",
    "screenshot_disabled": false,
    "self_unmute_camera_disabled": false,
    "self_unmute_mic_disabled": false,
    "share_disabled": false,
    "title": "",
    "updated_at": 0,
    "waiting_room_disabled": false,
    "watermark_disabled": false
  }
}

Cancel a meeting

POST /server/v1/meet/cancel Authentication: required (see Overview) Cancel a meeting (only before it starts) Request parameters

string

Room number

string

Meeting ID

Request example:

{
  "meeting_id": "",
  "room_no": ""
}

Response parameters

string

Response data

Response example:

{
  "code": 0,
  "data": ""
}

Create a meeting

POST /server/v1/meet/create Authentication: required (see Overview) Request parameters

string

Creator, i.e. the meeting host. Use the user’s unique ID in your system, the same value as user_id in conferee_details

string

Creator’s display name

string

Room number (max length 50)

string

required

Meeting title (max length 100)

string

Meeting description (max length 500)

string

Meeting password (max length 50)

integer

required

Meeting type. 1: instant meeting, 2: scheduled meeting

integer

Entry type. 1: unrestricted, 2: password required, 3: invitees only, 4: password + allowlist

array<string>

Co-host ID list. Use the users’ unique IDs in your system, the same values as user_id in conferee_details

array<string>

Invitee list (for compatibility with the legacy API)

array<object>

Invitee details list (new API)

Show Element fields

string

User ID, i.e. the user’s unique ID in your system

string

Real name

string

In-meeting display name; defaults to real_name if empty

string

User avatar

integer

User role. 0: regular member, 1: host, 2: co-host. Ignored with built-in roles: use creator to set the host and co_hosts to set co-hosts. The in-meeting role takes this value only when you use your own custom roles (external role mode); see the “Custom roles” section of “Key concepts”. If omitted or 0, the role registered for this user in the user database is used; set it explicitly rather than relying on this fallback

integer

Start time

integer

Duration (minutes)

integer

Mute-on-entry option

boolean

Whether the watermark is off. false: on, true: off

boolean

Whether screenshots are disabled. false: allowed, true: disabled

boolean

Whether members can unmute themselves when audio is disabled in the room. false: allowed, true: not allowed

boolean

Whether members can turn their camera back on when the camera is off for everyone in the room. false: allowed, true: not allowed

boolean

Audio disabled in the room. false: allowed, true: disabled

boolean

Camera off for everyone in the room. false: no, true: yes

Sharing disabled in the room. false: allowed, true: disabled

boolean

Chat disabled in the room. false: allowed, true: disabled

boolean

Whether the waiting room is off. false: on, true: off

boolean

Whether others are blocked from entering before the host. false: allowed, true: blocked

boolean

Whether to force entry

object

Extension field

integer

Meeting mode. 1: normal, 2: composite

boolean

Whether to record automatically

object

Layout data

Show Fields

string

required

Layout type

object

Watermark

Show Fields

integer

Type. 0: default, 1: none, 2: single row, 3: multiple rows

string

Custom text; empty means automatic (meeting title)

integer

Font size; 0 means the default

string

Font color; empty means the default

string

Outline color; empty means the default

integer

Outline width; 0 means the default

string

Text shown when no one is in the meeting; empty means recording stops when no one is present

object

Default name label

Show Fields

string

Type, a letter or combination: L left, R right, T top, B bottom

string

Custom text; empty means automatic (in-meeting display name)

integer

Font size; 0 means default

string

Font color; empty means default

string

Background color; empty means default

integer

Rotation interval (seconds); 0 disables rotation

array<object>

Logical block list

Show Element fields

array<object>

Grid cell list; empty means the remaining cells share the users here

array<string>

User ID list. Empty: rotate through all remaining online users; multiple IDs: rotate among these users only

Request example:

{
  "attend_type": 0,
  "auto_record": false,
  "camera_disabled": false,
  "chat_disabled": false,
  "co_hosts": [
    ""
  ],
  "conferee": [
    ""
  ],
  "conferee_details": [
    {
      "avatar": "",
      "nickname": "",
      "real_name": "",
      "role": 0,
      "user_id": ""
    }
  ],
  "content": "",
  "creator": "",
  "creator_name": "",
  "enter_before_host_disabled": false,
  "entry_mute_policy": 0,
  "extend_info": {},
  "force_join": false,
  "layout_data": {
    "div_list": [
      {
        "cells": [
          {
            "bind_share": false,
            "idx": 0,
            "tag": {
              "bg_color": "",
              "color": "",
              "size": 0,
              "text": "",
              "type": ""
            }
          }
        ],
        "uids": [
          ""
        ]
      }
    ],
    "layout": "",
    "nobody_text": "",
    "polling_dur": 0,
    "tag": {
      "bg_color": "",
      "color": "",
      "size": 0,
      "text": "",
      "type": ""
    },
    "watermark": {
      "color": "",
      "ol_color": "",
      "ol_width": 0,
      "size": 0,
      "text": "",
      "type": 0
    }
  },
  "meeting_mode": 0,
  "meeting_type": 0,
  "mic_disabled": false,
  "password": "",
  "plan_dur": 0,
  "plan_time": 0,
  "room_no": "",
  "screenshot_disabled": false,
  "self_unmute_camera_disabled": false,
  "self_unmute_mic_disabled": false,
  "share_disabled": false,
  "title": "",
  "waiting_room_disabled": false,
  "watermark_disabled": false
}

Response parameters

string

Meeting ID, used by all subsequent meeting endpoints

string

Room number; users enter this number in the client to enter the meeting

Response example:

{
  "code": 0,
  "data": {
    "meeting_id": "",
    "room_no": ""
  }
}

Update a meeting before it starts

POST /server/v1/meet/update Authentication: required (see Overview) Update a meeting Request parameters

string

required

Meeting ID

string

Creator, i.e. the meeting host. Use the user’s unique ID in your system, the same value as user_id in conferee_details

string

Meeting title (max length 100)

string

Meeting description (max length 500)

integer

Entry type. 1: unrestricted, 2: password required, 3: invitees only, 4: password + allowlist

string

Meeting password (max length 50)

array<string>

Invitee list (for compatibility with the legacy API)

array<object>

Invitee details list (new API)

Show Element fields

string

User ID, i.e. the user’s unique ID in your system

string

Real name

string

In-meeting display name; defaults to real_name if empty

string

User avatar

integer

Start time

integer

Duration (minutes)

integer

Mute-on-entry option

boolean

Whether the watermark is off. false: on, true: off

boolean

Whether screenshots are disabled. false: allowed, true: disabled

boolean

Chat disabled in the room. false: allowed, true: disabled

boolean

Whether the waiting room is off. false: on, true: off

boolean

Whether others are blocked from entering before the host. false: allowed, true: blocked

boolean

Whether to force entry

array<string>

Co-host ID list. Use the users’ unique IDs in your system, the same values as user_id in conferee_details

object

Extension field

integer

Meeting mode. 1: normal, 2: composite

boolean

Whether to record automatically

object

Layout data

Show Fields

string

required

Layout type

object

Watermark

Show Fields

integer

Type. 0: default, 1: none, 2: single row, 3: multiple rows

string

Custom text; empty means automatic (meeting title)

integer

Font size; 0 means the default

string

Font color; empty means the default

string

Outline color; empty means the default

integer

Outline width; 0 means the default

string

Text shown when no one is in the meeting; empty means recording stops when no one is present

object

Default name label

Show Fields

string

Type, a letter or combination: L left, R right, T top, B bottom

string

Custom text; empty means automatic (in-meeting display name)

integer

Font size; 0 means default

string

Font color; empty means default

string

Background color; empty means default

integer

Rotation interval (seconds); 0 disables rotation

array<object>

Logical block list

Show Element fields

array<object>

Grid cell list; empty means the remaining cells share the users here

array<string>

User ID list. Empty: rotate through all remaining online users; multiple IDs: rotate among these users only

Request example:

{
  "attend_type": 0,
  "auto_record": false,
  "chat_disabled": false,
  "co_hosts": [
    ""
  ],
  "conferee": [
    ""
  ],
  "conferee_details": [
    {
      "avatar": "",
      "nickname": "",
      "real_name": "",
      "role": 0,
      "user_id": ""
    }
  ],
  "content": "",
  "creator": "",
  "enter_before_host_disabled": false,
  "entry_mute_policy": 0,
  "extend_info": {},
  "force_join": false,
  "layout_data": {
    "div_list": [
      {
        "cells": [
          {
            "bind_share": false,
            "idx": 0,
            "tag": {
              "bg_color": "",
              "color": "",
              "size": 0,
              "text": "",
              "type": ""
            }
          }
        ],
        "uids": [
          ""
        ]
      }
    ],
    "layout": "",
    "nobody_text": "",
    "polling_dur": 0,
    "tag": {
      "bg_color": "",
      "color": "",
      "size": 0,
      "text": "",
      "type": ""
    },
    "watermark": {
      "color": "",
      "ol_color": "",
      "ol_width": 0,
      "size": 0,
      "text": "",
      "type": 0
    }
  },
  "meeting_id": "",
  "meeting_mode": 0,
  "password": "",
  "plan_dur": 0,
  "plan_time": 0,
  "screenshot_disabled": false,
  "title": "",
  "waiting_room_disabled": false,
  "watermark_disabled": false
}

Response parameters

string

Response data

Response example:

{
  "code": 0,
  "data": ""
}

Update invitees

POST /server/v1/meet/update-conferee Authentication: required (see Overview) Update invitees during the meeting Request parameters

string

Room number

string

Meeting ID

array<string>

Invitees (for compatibility with the legacy API)

array<object>

Invitee details list (new API)

Show Element fields

string

User ID, i.e. the user’s unique ID in your system

string

Real name

string

In-meeting display name; defaults to real_name if empty

string

User avatar

integer

boolean

Whether to append

boolean

Whether to force entry (takes effect only when calling users into the meeting)

Request example:

{
  "conferee": [
    ""
  ],
  "conferee_details": [
    {
      "avatar": "",
      "nickname": "",
      "real_name": "",
      "role": 0,
      "user_id": ""
    }
  ],
  "force_join": false,
  "is_additional": false,
  "meeting_id": "",
  "room_no": ""
}

Response parameters

string

Response data

Response example:

{
  "code": 0,
  "data": ""
}

Remove invitees

POST /server/v1/meet/delete-conferee Authentication: required (see Overview) Remove users from the allowlist Request parameters

string

Room number

string

Meeting ID

array<string>

required

User ID list

Request example:

{
  "meeting_id": "",
  "room_no": "",
  "user_ids": [
    ""
  ]
}

Response parameters

string

Response data

Response example:

{
  "code": 0,
  "data": ""
}

List chat history

POST /server/v1/meet/user-chat-record Authentication: required (see Overview) User chat history Request parameters

string

Room number

string

Meeting ID

string

Filter by sender user ID

integer

Message type. 1: text, 2: file, 3: image, 4: voice

string

Message content

integer

Chat time range

integer

Chat time range

string

Sort fields, comma-separated; prefix - for descending order, e.g. -created_at

integer

Page number, starting from 1 Example: 1

integer

Items per page Example: 10

Request example:

{
  "begin_at": 0,
  "end_at": 0,
  "meeting_id": "",
  "msg": "",
  "msg_type": 0,
  "page": 1,
  "per-page": 10,
  "room_no": "",
  "sender_id": "",
  "sort": ""
}

Response parameters

string

Device ID

string

Meeting ID

string

Sender’s third-party user ID

string

Sender name

string

Sender’s real name

integer

Sender role. 0: regular member, 1: host, 2: co-host

integer

Message type. 1: text, 2: file, 3: image, 4: voice

string

Message content

integer

Sent time (timestamp)

Response example:

{
  "_meta": {
    "currentPage": 1,
    "pageCount": 5,
    "perPage": 20,
    "totalCount": 100
  },
  "code": 0,
  "data": [
    {
      "created_at": 0,
      "id": "",
      "meeting_id": "",
      "msg": "",
      "msg_type": 0,
      "real_name": "",
      "role": 0,
      "sender_id": "",
      "sender_name": ""
    }
  ]
}

List files in chat history

POST /server/v1/meet/chat-record-files Authentication: required (see Overview) Chat history files Request parameters

string

Room number

string

Meeting ID

Request example:

{
  "meeting_id": "",
  "room_no": ""
}

Response parameters

string

File name

string

File size (bytes)

string

File key

string

Playback/download URL, valid for 2 hours

Response example:

{
  "code": 0,
  "data": [
    {
      "key": "",
      "name": "",
      "size": "",
      "url": ""
    }
  ]
}

Get today’s meeting overview

POST /server/v1/meet/today Authentication: required (see Overview) Today’s data Request parameters None Response parameters

integer

Date

integer

Count

integer

Duration (seconds)

Response example:

{
  "code": 0,
  "data": {
    "dur": 0,
    "num": 0,
    "time": 0
  }
}

Get meeting count statistics

POST /server/v1/meet/stats Authentication: required (see Overview) Meeting statistics Request parameters

integer

Start time

integer

End time

Request example:

{
  "begin_at": 0,
  "end_at": 0
}

Response parameters

string

Date

integer

Count

integer

Duration (seconds)

Response example:

{
  "code": 0,
  "data": [
    {
      "day": "",
      "dur": 0,
      "num": 0
    }
  ]
}

Overview

Web SDK

Android SDK

Swift SDK (iOS/macOS)

Server API

Configure event notifications

List meetings

List in-meeting members

List attendance records

Send an in-meeting custom message

Get meeting details

Cancel a meeting

Create a meeting

Update a meeting before it starts

Update invitees

Remove invitees

List chat history

List files in chat history

Get today’s meeting overview

Get meeting count statistics

​Configure event notifications

​List meetings

​List in-meeting members

​List meeting-related users

​List attendance records

​Send an in-meeting custom message

​Get meeting details

​Cancel a meeting

​Create a meeting

​Update a meeting before it starts

​Update invitees

​Remove invitees

​List chat history

​List files in chat history

​Get today’s meeting overview

​Get meeting count statistics

Configure event notifications

List meetings

List in-meeting members

List meeting-related users

List attendance records

Send an in-meeting custom message

Get meeting details

Cancel a meeting

Create a meeting

Update a meeting before it starts

Update invitees

Remove invitees

List chat history

List files in chat history

Get today’s meeting overview

Get meeting count statistics