conferenceList

Описание: уведомление, приходящее после обновления списка запланированных конференций или виртуальных комнат. JSON содержит сведения о мероприятиях, в которых авторизованный на TrueConf Room пользователь является участником с любой ролью (от владельца до просто приглашённого слушателя).

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

Пример:

{
   "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
}

Описание параметров:

• succeed - информация о результате запроса, может быть:

  • 1 - true

  • 2 - false

• cnt - количество конференций

• conferences - список конференций. Объект конференции состоит из:

  • id - уникальный идентификатор конференции

  • topic - тема конференции

  • owner - идентификатор пользователя (TrueConf ID) владельца конференции

  • description - описание конференции

  • max_podiums - максимальное количество спикеров конференции

  • max_participants - максимальное количество одновременных участников конференции

  • type - тип конференции. Принимает значения:

    • 0 - все на экране

    • 1 - видеоурок

    • 3 - видеоселектор

  • schedule - данные о расписании конференции. Состоит из:

    • type - тип расписания конференции. Может принимать значения:

      • -1 - без расписания

      • 0 - повторяется каждую неделю

      • 1 - без повторения, с одноразовым расписанием Дополнительные поля, если конференция с расписанием (type != -1):

    • start_time - время начала конференции в секундах

    • time_offset - сдвиг по времени в минутах относительно часового пояса сервера

    • special_time_offset- сдвиг по времени в минутах относительно Гринвича

    • duration - длительность конференции в секундах

    Дополнительные поля, если конференция с повторением (type == 0):

    • time - время начала конференции в часовом поясе сервера в формате hh:mm

    • days - дни недели, в которых конференция запускается. Состоит из семи последовательных значений 0 или 1 для каждого дня недели, начиная с воскресенья. 1 означает, что конференция на этот день запланирована. Например, список [0,1,0,0,1,0,0] означает, что мероприятие будет запускаться каждые понедельник и четверг, а список [0,0,0,1,0,1,0] - что каждую среду и пятницу.

  • invitations - список приглашений, которые используются для автоматического приглашения в конференцию. Объект приглашения состоит из:

    • id - идентификатор пользователя (TrueConf ID)

    • display_name - отображаемое имя пользования

  • allow_guests - флаг, который обозначает разрешение на приглашение гостей на конференцию

  • auto_invite - поле, отвечающее за автоматическую рассылку приглашений при запуске конференции. Принимает значения:

    • 0 - автоматическая рассылка отключена

    • 1 - любой участник может присоединиться к конференции

    • 2 - любой приглашенный участник может присоединиться к конференции

  • state - поле состояния конференции. Принимает значения:

    • running - конференция активна

    • stopped - конференция не активна

  • access - доступность конференции, может отсутствовать. Принимает значения:

    • private - внутренняя конференция

    • public - публичная конференция

  • url - ссылка на страницу конференции

  • webclient_url - виджет конференции

  • created_at - время создания конференции в секундах

  • multicast_enable - не используется

  • multicast_address- не используется

  • tags - тэги конференции для быстрого поиска

  • recording - состояние записи конференции

    • 0 - запись работает

    • 1 - запись не активна

  • stream_recording_state - не используется

  • rights - объект содержит описание прав групп участников конференции: пользователей (user) и гостей (guest). Права состоят из:

    • chat_send - флаг разрешения на отправку сообщений

    • chat_rcv - флаг разрешения на получение сообщений

    • slide_show_send - флаг разрешения на показ слайдшоу

    • slide_show_rcv - флаг разрешения на просмотр слайдшоу

    • white_board_send - флаг разрешения на редактирование доски рисования

    • white_board_rcv - флаг разрешения на просмотр доски рисования

    • file_transfer_send - флаг разрешения на отправку файлов

    • file_transfer_rcv- флаг разрешения на получение файлов

    • desktop_sharing - флаг разрешения на транслирование экрана или приложений

    • recording- флаг разрешения на просмотр трансляции экрана или приложений

    • audio_send - флаг разрешения на отправку аудио

    • audio_rcv - флаг разрешения на прием аудио

    • video_send - флаг разрешения на отправку видео

    • video_rcv - флаг разрешения на прием видео

  • broadcast_enabled - не используется

  • broadcast_id - не используется

  • broadcast - не используется

  • allow_only_planned_participants - не используется

См. также:

• getScheduler
• setCustomScheduler
• eraseCustomScheduler