conferenceList
Description: Notification received after the list of scheduled conferences displayed on the TrueConf Room main window is updated. The JSON contains information about events in which the user authorized on TrueConf Room API is a participant with any role (from owner to invited listener).
Example:
{
"method":"event",
"event":"conferenceList",
"cnt": 1,
"conferences": [{
"id": "3413915491",
"type": 0,
"topic": "Test conf",
"owner": "testtest@some.server",
"description": "",
"max_podiums": 36,
"max_participants": 36,
"schedule": {
"type": 1,
"start_time": 1605949200,
"time_offset": 0,
"special_time_offset": 180,
"duration": 28800
},
"invitations": [{
"id": "123",
"display_name": "123"
},
{
"id": "321",
"display_name": "321"
}
],
"allow_guests": false,
"auto_invite": 0,
"state": "stopped",
"access": "private",
"url": "https://some.server/c/34139",
"webclient_url": "https://some.server/webrtc/3413915",
"created_at": 1605860922,
"multicast_enable": false,
"multicast_address": null,
"tags": [],
"recording": 0,
"stream_recording_state": 0,
"rights": {
"guest": {
"chat_send": true,
"chat_rcv": true,
"slide_show_send": true,
"slide_show_rcv": true,
"white_board_send": true,
"white_board_rcv": true,
"file_transfer_send": true,
"file_transfer_rcv": true,
"desktop_sharing": true,
"recording": true,
"audio_send": true,
"audio_rcv": true,
"video_send": true,
"video_rcv": true
},
"user": {
"chat_send": true,
"chat_rcv": true,
"slide_show_send": true,
"slide_show_rcv": true,
"white_board_send": true,
"white_board_rcv": true,
"file_transfer_send": true,
"file_transfer_rcv": true,
"desktop_sharing": true,
"recording": true,
"audio_send": true,
"audio_rcv": true,
"video_send": true,
"video_rcv": true
}
},
"broadcast_enabled": false,
"broadcast_id": null,
"broadcast": null,
"allow_only_planned_participants": false
}],
"succeed":true
}Parameter description:
succeed— the information about the request result. The following options are possible:1- true2— false
cnt— number of conferencesconferences- list of conferences. The conference object consists of:id— Unique conference identifiertopic— Conference topicowner- the user identifier (TrueConf ID) of the conference ownerdescription— Conference descriptionmax_podiums— the maximum number of speakers in the conferencemax_participants— Maximum number of concurrent conference participantstype- conference type. Accepts the following values:0- all on screen1- video lecture3- role-based
schedule— the information about the conference schedule. It includes:type- the type of conference scheduling. It can take the following values:-1— without a schedule0— held weekly1— held only once
Additional fields that are available for the scheduled conference (
type!=-1):start_time— the conference start time, specified in secondstime_offset— the time offset relative the server time zone (specified in minutes)special_time_offset— the time shift relative to Greenwich (specified in minutes)duration— Conference duration in seconds
Additional fields that will be available for a recurring conference (
type==0):time— the conference start time relative to the server time zone (it will be presented in thehh:mmformat)days- days of the week in which the conference is scheduled to start. It consists of seven consecutive values of0or1for each day of the week, starting with Sunday. A1indicates 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.
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
allow_guests— the flag indicating if guests can be invited to the conferenceauto_invite— this field is needed for sending invitations automatically when the conference starts. The following values are possible:0— automatic invitations are disabled1— any participant can join the conference2— any invited participant can join the conference
state— the conference state field. The following values are possible:running— the conference is activestopped— the conference is not active
access- conference accessibility, which may be optional. It can take the following values:private— private conferencepublic— public conference
url— the link to the conference web pagewebclient_url— Conference widgetcreated_at— the time when the conference was created (specified in seconds)multicast_enable— is not usedmulticast_address— is not usedtags— Conference tags for quick searchrecording— Conference recording status0— recording is on1— video recording is off
stream_recording_state— is not usedrights— the object includes the description of rights assigned to groups of participants: users (user) and guests (guest). The rights include:chat_send— the flag indicating if group members are allowed to send messageschat_rcv— the flag indicating if group members are allowed to receive messagesslide_show_send— the flag indicating if group members are allowed to show slidesslide_show_rcv— the flag indicating if group members are allowed to view slideswhite_board_send— the flag indicating if group members are allowed to annotate the whiteboardwhite_board_rcv— the flag indicating if group members are allowed to view annotations on the whiteboardfile_transfer_send— the flag indicating if group members are allowed to send filesfile_transfer_rcv— the flag indicating if group members are allowed to receive filesdesktop_sharing- flag for permission to share the screen or applicationsrecording- flag for permission to view screen or application sharingaudio_send— the flag indicating if group members are allowed to send audioaudio_rcv— the flag indicating if group members are allowed to receive audiovideo_send— the flag indicating if group members are allowed to send videovideo_rcv— the flag indicating if group members are allowed to receive video
broadcast_enabled— is not usedbroadcast_id— is not usedbroadcast— is not usedallow_only_planned_participants— is not used
See also: