# getScheduler
Description
Retrieve a list of scheduled conferences or virtual rooms. The JSON contains information about events where the authorized TrueConf VideoSDK 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.
void getScheduler()
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
}
Response Parameters
| Name | 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 - Unique session identifier, may be absent or empty • mode - Conference mode that can be as follows: ⠀⠀• PxP - All on screen ⠀⠀• 0xP - 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. Has 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 - 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 - conference start time in seconds GMT+0000 ⠀⠀• duration - Conference duration in seconds ⠀⠀• days - days of the week when the conference is scheduled to launch |
| requestId | A unique request identifier |
| result | A flag indicating whether the request was successful |
See also