# getScheduler

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

msgid "The data update period is 8-12 minutes, which means the query result may slightly lag behind the actual list update." msgstr ""


    "method": "getScheduler",
    "requestId" : "1"

Response example:

  "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": [
  "result": true

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.
  • requestId - unique request identifier. More details can be found here

See also: