setCustomScheduler

Description: add scheduled conferences or virtual rooms to the local events list. v4.3.0+

The command is used to add conferences to a list that will subsequently be utilized in all relevant areas: API, main screen display, etc. These events are not created on the server side, and no validation of the specified data against reality is performed; it only checks that the specified conference IDs (the id parameter) are not present in the conference list (returned in the conferenceList notification) at the time of execution. In other words, the accuracy of the data is the responsibility of the person executing the command. The added conferences will be displayed exclusively on the moderated role-based conference TrueConf Room API. The previous local list will be completely replaced with the newly added one.

This command can be useful, for example, to add events to the local list that are created on a federative server and include your TrueConf Room API as a participant.

Example:

{
    "method": "setCustomScheduler",
    "requestId": "1",
    "conferences": [
        {
            "id": "0048411008",
            "created_at": "2023-01-20T16:44:43Z",
            "session_id": "",
            "mode": "S|L",
            "owner": "user@some.server",
            "topic": "Interview",
            "state": "stopped",
            "access": "private",
            "invitations": [
                {
                    "id": "ivanov",
                    "display_name": "Ivan Ivanov"
                }
            ],
            "schedule_type": "week",
            "schedule": {
                "start_time": "2023-02-20T16:54:00Z",
                "duration": 28800,
                "days": [
                    0,
                    1,
                    1,
                    1,
                    1,
                    1,
                    0
                ]
            }
        },
        {
            "id": "0048881003",
            "created_at": "2023-01-20T18:44:43Z",
            "session_id": "",
            "mode": "S|L",
            "owner": "user2@some.server",
            "topic": "Interview 2",
            "state": "stopped",
            "access": "private",
            "invitations": [
                {
                    "id": "igor",
                    "display_name": "Igor Ivanov"
                }
            ],
            "schedule_type": "week",
            "schedule": {
                "start_time": "2023-03-20T16:44:00Z",
                "duration": 30000,
                "days": [
                    0,
                    1,
                    1,
                    1,
                    1,
                    1,
                    0
                ]
            }
        }
    ]
}

Response example:

{
  "method": "setCustomScheduler",
  "requestId" : "1",
  "result": true
}

Parameter description:

• conferences - local list of events

• id — Unique conference identifier

• created_at - the conference creation time in RFC3339 format

• session_id - a unique session identifier, which 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 - 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 - information about the conference schedule. Contains data if the conference has a schedule (schedule_type != none). It consists of:

  • start_time - conference start time in RFC3339

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

• getScheduler
• eraseCustomScheduler
• conferenceList