getScheduler24

Description: Retrieve a list of scheduled conferences set to begin within the next 24 hours. The JSON contains information about events in which the user authorized on TrueConf Room API is a participant with any role (from owner to simply an invited attendee). The list returned is the same as the one displayed in the “Upcoming Conferences” section on the TrueConf Room home screen.

The getScheduler24 request does not trigger a call to the video conferencing server; instead, it returns the most recently saved list (the one displayed in the main window).

Example:

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

Response example:

{
  "method": "getScheduler24",
  "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": "joe",
          "display_name": "Joe Smith"
        }
      ],
      "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

• 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 - a unique session identifier, which may be absent or empty

• mode — Conference mode that can be as follows:

  • PxP - all on screen

  • S|L - role-based

  • OxP - video lecture

• owner - the user identifier (TrueConf ID) of the conference owner

• 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, which may be optional. It can take 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 - user 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 - conference schedule data. Contains information if the conference is scheduled (schedule_type != none). It 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 - days of the week in which the conference is scheduled to start. It consists of seven consecutive values of 0 or 1 for each day of the week, starting with Sunday. A 1 indicates that a conference is scheduled for that day. For example, the list [0,1,0,0,1,0,0] means that the event will occur every Monday and Thursday, and the list [0,0,0,1,0,1,0] indicates that it will take place every Wednesday and Friday.

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

See also:

• setCustomScheduler
• eraseCustomScheduler
• getDirectorySearchUrl
• conference24List