# conferenceList

Description: notification that comes after updating the list of scheduled conferences or virtual rooms. JSON contains information about events in which the authorized user of VideoSDK/Room is a participant with any role (from owner to simply invited listener).

msgid "The data update period is 8-12 minutes, which means the event doesn't come immediately upon list changes."

msgstr "Период обновления данных составляет 8-12 минут, то есть событие приходит не сразу при изменении списка."


   "cnt": 1,
   "conferences": [
            "id": "true_webinar",
            "created_at": 1682079249,
            "session_id": "",
            "mode": "PxP",
            "owner": "brown",
            "topic": "Webinar",
            "state": "stopped",
            "access": "public",
            "invitations": [
                    "id": "brown@video.example.com",
                    "display_name": "Elle Brown"
                    "id": "smith@video.example.com",
                    "display_name": "Joe Smith"
            "schedule_type": "once",
            "schedule": {
                "start_time": 1682589600,
                "duration": 28800

Parameter description:

  • cnt— number of conferences

  • conferences - list of conferences. Each conference object consists of:

    • id — Unique conference identifier

    • created_at — the time when the conference was created (specified in seconds). The time zone is not taken into account (GMT+0000).

    • session_id — the unique session identifier; this field is optional and may be empty

    • mode — Conference mode that can be as follows:

      - `PxP` - all on screen
      - `OxP` - video lecture
      - `S|L` - role-based
    • owner — Conference owner user identifier (TrueConf ID).

    • topic — Conference topic

    • state — the state of a conference. The following values are possible:

      - `running` — the conference is active
      - `stopped` — the conference is not active
    • access — availability of the conference. The field is optional. The following values are possible:

      - `private` — private conference
      - `public` — public conference
    • invitations — the list of objects used for sending conference invitations automatically. Each object includes the following fields:

      - `id` — the user's identifier (<to-site alias="trueconf-id">TrueConf ID</to-site>)
      - `display_name`— the user’s display name
    • schedule_type — the type of the conference schedule. The following values are possible:

      - `none` — without a schedule
      - `week` — held weekly
      - `once` — held only once
    • schedule - information about the conference schedule. Contains data if the conference has a schedule (schedule_type != none). Consists of:

      - `start_time` — the conference start time (specified in seconds). The time zone is not taken into account (GMT+0000).
      - `duration` — Conference duration in seconds
        Additional fields that will be available for a recurring conference (`schedule_type` == `week`):
      - `days` - the days of the week in which the conference is scheduled to run. It consists of seven consecutive values of `0` or `1` for each day of the week, starting with Sunday. `1` means that the conference is scheduled for that day. For example, the list `[0,1,0,0,1,0,0]` means that the event will run every Monday and Thursday, and the list `[0,0,0,1,0,1,0]` means every Wednesday and Friday.

See also: