getScheduler

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

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

Пример:

{
    "method": "getScheduler",
    "requestId" : "1"
}

Пример ответа:

{
  "method": "getScheduler",
  "requestId" : "1",
  "cnt": 1,
  "conferences": [
    {
      "id": "0048411003",
      "created_at": 1627928539,
      "session_id": "",
      "mode": "S|L",
      "owner": "testtest@some.server",
      "topic": "Testing conference",
      "state": "stopped",
      "access": "private",
      "invitations": [
        {
          "id": "ivanov",
          "display_name": "Ivan Ivanov"
        }
      ],
      "schedule_type": "week",
      "schedule": {
        "start_time": 1659349800,
        "duration": 28800,
        "days": [
          0,
          1,
          1,
          1,
          1,
          1,
          0
        ]
      }
    }
  ],
  "result": true
}

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

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

• conferences - список конференций. Каждый объект конференции состоит из:

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

  • created_at - время создания конференции в секундах. Часовой пояс не учитывается (GMT+0000)

  • session_id - уникальный идентификатор сессии, может отсутствовать или быть пустым

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

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

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

    • S|L - видеоселектор

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    • once - без повторения, с одноразовым расписанием

  • schedule - данные о расписании конференции. Содержит данные, если конференция с расписанием (schedule_type != none). Состоит из:

    • start_time - время начала конференции в секундах. Часовой пояс не учитывается (GMT+0000)

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

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

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

• requestId - уникальный идентификатор запроса. Детальнее с ним можно ознакомиться здесь

См. также:

• setCustomScheduler
• eraseCustomScheduler
• getDirectorySearchUrl
• conferenceList