# conferenceList

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

The data refresh period is 8-12 minutes, meaning that the event does not arrive immediately upon changes to the list.

Example:

{
   "method":"event",
   "event":"conferenceList",
   "cnt": 1,
   "conferences": [{
      "id": "3413915491",
      "type": 0,
      "topic": "Test conf",
      "owner": "testtest@some.server",
      "description": "",
      "max_podiums": 36,
      "max_participants": 36,
      "schedule": {
         "type": 1,
         "start_time": 1605949200,
         "time_offset": 0,
         "special_time_offset": 180,
         "duration": 28800
      },
      "invitations": [{
            "id": "123",
            "display_name": "123"
         },
         {
            "id": "321",
            "display_name": "321"
         }
      ],
      "allow_guests": false,
      "auto_invite": 0,
      "state": "stopped",
      "access": "private",
      "url": "https://some.server/c/34139",
      "webclient_url": "https://some.server/webrtc/3413915",
      "created_at": 1605860922,
      "multicast_enable": false,
      "multicast_address": null,
      "tags": [],
      "recording": 0,
      "stream_recording_state": 0,
      "rights": {
         "guest": {
            "chat_send": true,
            "chat_rcv": true,
            "slide_show_send": true,
            "slide_show_rcv": true,
            "white_board_send": true,
            "white_board_rcv": true,
            "file_transfer_send": true,
            "file_transfer_rcv": true,
            "desktop_sharing": true,
            "recording": true,
            "audio_send": true,
            "audio_rcv": true,
            "video_send": true,
            "video_rcv": true
         },
         "user": {
            "chat_send": true,
            "chat_rcv": true,
            "slide_show_send": true,
            "slide_show_rcv": true,
            "white_board_send": true,
            "white_board_rcv": true,
            "file_transfer_send": true,
            "file_transfer_rcv": true,
            "desktop_sharing": true,
            "recording": true,
            "audio_send": true,
            "audio_rcv": true,
            "video_send": true,
            "video_rcv": true
         }
      },
      "broadcast_enabled": false,
      "broadcast_id": null,
      "broadcast": null,
      "allow_only_planned_participants": false
   }],
   "succeed":true
}

Parameter description:

succeed — the information about the request result. The following options are possible:
- 1 - true
- 2 — false
cnt— number of conferences

conferences - list of conferences. The conference object consists of:

id — Unique conference identifier
topic — Conference topic
owner — Conference owner user identifier (TrueConf ID).
description — Conference description
max_podiums — the maximum number of speakers in the conference
max_participants — Maximum number of concurrent conference participants

type - conference type. Accepts the following values:

- `0` - all on screen

- `1` - video lecture

- `3` - role-based

schedule — the information about the conference schedule. It includes:

- `type` - the type of conference scheduling. It can take the following values:

        - `-1` — without a schedule

        - `0` — held weekly

        - `1` — held only once
          Additional fields that are available for the scheduled conference (`type` != `-1`):

- `start_time` — the conference start time, specified in seconds

- `time_offset` — the time offset relative the server time zone (specified in minutes)

- `special_time_offset` — the time shift relative to Greenwich (specified in minutes)

- `duration` — Conference duration in seconds

  Additional fields that will be available for a recurring conference (`type` == `0`):

- `time` — the conference start time relative to the server time zone (it will be presented in the `hh:mm` format)

- `days` - days of the week when the conference is scheduled to launch. It is composed of seven consecutive `0` or `1` values 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]` indicates that the event will be launched every Monday and Thursday, while the list `[0,0,0,1,0,1,0]` means it will be launched every Wednesday and Friday.

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

allow_guests — the flag indicating if guests can be invited to the conference

auto_invite — this field is needed for sending invitations automatically when the conference starts. The following values are possible:

- `0` — automatic invitations are disabled

- `1` — any participant can join the conference

- `2` — any invited participant can join the conference

state — the conference state field. The following values are possible:

- `running` — the conference is active

- `stopped` — the conference is not active

access - conference accessibility, may be absent. Accepts the following values:
```
- `private` — private conference

- `public` — public conference
```
url — the link to the conference web page
webclient_url — Conference widget
created_at — the time when the conference was created (specified in seconds)
multicast_enable — is not used
multicast_address — is not used
tags — Conference tags for quick search

recording — Conference recording status

- `0` — recording is on

- `1` — video recording is off

stream_recording_state — is not used

rights — the object includes the description of rights assigned to groups of participants: users (user) and guests (guest). The rights include:

- `chat_send` — the flag indicating if group members are allowed to send messages

- `chat_rcv`— the flag indicating if group members are allowed to receive messages

- `slide_show_send` — the flag indicating if group members are allowed to show slides

- `slide_show_rcv` — the flag indicating if group members are allowed to view slides

- `white_board_send` — the flag indicating if group members are allowed to annotate the whiteboard

- `white_board_rcv` — the flag indicating if group members are allowed to view annotations on the whiteboard

- `file_transfer_send` — the flag indicating if group members are allowed to send files

- `file_transfer_rcv` — the flag indicating if group members are allowed to receive files

- `desktop_sharing` — the flag indicating if group members are allowed to share the screen or application windows 

- `recording`— the flag indicating if group members are allowed to view the content shared by other participants 

- `audio_send`— the flag indicating if group members are allowed to send audio

- `audio_rcv`— the flag indicating if group members are allowed to receive audio

- `video_send` — the flag indicating if group members are allowed to send video

- `video_rcv`— the flag indicating if group members are allowed to receive video

broadcast_enabled — is not used
broadcast_id — is not used
broadcast — is not used
allow_only_planned_participants — is not used

See also: