setCustomScheduler

Version: 4.3.0+

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

The command is used to add conferences to a list that will subsequently be used in all relevant places: API, information display on the main screen, etc. However, the events are not created on the server side and there is no verification of the provided data for accuracy; only the absence of the specified conference IDs (the id parameter) in the list of conferences (which is returned in the conferenceList notification) is checked at the time the command is executed. Thus, the person executing the command is responsible for the accuracy of the data. The added conferences will be displayed exclusively on the managed VideoSDK/Room. The previous local list is completely replaced with the newly added one.

This command can be useful, for instance, for adding events created on a federated server to your local list of events, where your VideoSDK/Room has been added 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 - 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 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 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:

• getScheduler
• eraseCustomScheduler
• conferenceList