getScheduler

Description: Retrieve a list of scheduled conferences or virtual rooms. The JSON contains information about events where the authorized TrueConf Room user is a participant with any role, from owner to a mere invited attendee.

The data refresh period is 8-12 minutes, meaning the query result may lag slightly behind the actual changes in the list.

Example:

{
    "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": [
          0,
          1,
          1,
          1,
          1,
          1,
          0
        ]
      }
    }
  ],
  "result": true
}

Parameter description:

• cnt— number of conferences

• conference — Group conference list

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 - unique session identifier, may be absent or 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 - conference accessibility, may be absent. Accepts the following values:

  • 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 (TrueConf ID)

  • 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). It includes:

  • 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 - 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.

• requestId - a unique request identifier. You can learn more about it here.

See also:

• setCustomScheduler
• eraseCustomScheduler
• getDirectorySearchUrl
• conferenceList