id
|
String
|
POST Unique conference identifier. It can include digits, Latin characters, and underscores. The identifier will be generated automatically if it is not specified manually.
Size range: 1..128
|
topic
|
String
|
POST | PUT Conference subject.
Size range: 1..240
|
description
|
String
|
POST | PUT Conference description. The only field that can be edited during a conference call.
|
owner
|
String
|
GET | POST | PUT User identifier (user_id) of the conference owner.
Size range: 1..64
|
type
|
Integer
|
POST | PUT Conference mode. Click to learn more about available conference modes:
|
invitations
|
Object[]
|
Invitations list. They are used to automatically invite to the conferences. List of ObjectInvitationMini.
|
created_at
|
Integer
|
Timestamp indicating when the conference was created.
|
multicast_enable
|
Boolean
|
POST | PUT Indicates whether UDP Multicast is enabled for the conference.
|
multicast_address
|
String
|
POST | PUT The multicast_address parameter specifies the multicast address utilized when UDP Multicast is enabled for the conference communication. null is used when UDP Multicast is disabled.
|
max_podiums
|
Integer
|
The maximum number of conference speakers. The value of this parameter can be changed for “role-based” conferences. In “all-on-screen” conferences, the number of speakers equals the number of participants, while in “video lectures”, it is equal to 1.
Default value: $max_allowed
|
max_participants
|
Integer
|
POST | PUT Maximum number of participants depends on the conference mode. Click to learn more about available conference modes:
Default value: $max_allowed
|
schedule
|
Object
|
POST | PUT Schedule object.
|
allow_guests
|
Boolean
|
POST | PUT Permission to invite guests to the conference. For editing you need a webinar license.
Default value: false
|
rights
|
Object
|
POST | PUT ClientRights objects.
|
guest
|
Object
|
POST | PUT ClientRights object, applied to guests.
|
user
|
Object
|
POST | PUT ClientRights object, applied to users.
|
broadcast_enabled
|
Boolean
|
POST | PUT Indicates whether the broadcasting preset is enabled for the conference.
|
broadcast_id
|
String
|
POST | PUT Identifier for the broadcasting preset associated with the conference.
|
broadcast
|
String
|
The link to PresetMini object that is associated with the conference.
|
allow_only_planned_participants
|
Boolean
|
POST | PUT When set to true, only invited users can join the conference. This setting does not apply to public conferences (webinars).
|
auto_invite
|
Integer
|
POST | PUT This parameter is responsible for sending automatic invitations at the conference start: - 0 - disabled
- 1 - when any participant joins the conference
- 2 - when any invited participant joins the conference
Default value: 0
|
url
|
String
|
POST | PUT Conference page.
|
webclient_url
|
String
|
POST | PUT Conference widget.
|
state
|
String
|
GET | POST | PUT Conference state.
Allowed values:
"running" ,
"stopped"
|
tags
|
Array
|
POST | PUT Conference tags for fast search.
|
recording
|
Integer
|
POST | PUT Indicates whether conference recording should be enabled when the conference starts. - 0 - Recording is disabled
- 1 - Recording is enabled
Allowed values:
0 ,
1
|
stream_recording_state
|
Integer
|
Current state of the conference recording. - 0 - Recording is currently disabled
- 1 - Recording is currently enabled
Allowed values:
0 ,
1
|
stream_id
|
String
|
Unique identifier representing the ConferenceSession associated with the conference. It can be null , indicating that the conference is not currently running.
|
deeplinks
|
Array
|
Array containing deeplinks for connecting to the conference through various platforms. - The "default" deeplink uses a TrueConf-specific scheme suitable for various platforms.
- The "android" deeplink is designed for Android devices and uses an Android-specific intent.
|
connect_urls
|
Array
|
Object containing various connection URLs for different protocols. sip_external : URL for external SIP connections. If null, external SIP connections may not be available. sip : Array of SIP URLs for internal connections. Each element represents a SIP connection option. h323 : Array of H.323 URLs for connections. Each element represents an H.323 connection option.
|
pin_enabled
|
Boolean
|
Is there password for joining the conference.
|
pin
|
String
|
POST | PUT Password for joining the conference. The value will be available only to the conference owner; otherwise, null will be returned.
|
meeting_room
|
String
|
POST | PUT Conference meeting room. It can be null .
|
on_join_mute_mic
|
Integer
|
POST | PUT Mute participants on entry.
Allowed values:
0 ,
1
|
on_join_mute_camera
|
Integer
|
POST | PUT Stop participants’ video on entry.
Allowed values:
0 ,
1
|
registration
|
Object
|
POST | PUT Registration object.
|
vad_selector
|
Integer
|
POST | PUT Is smart meeting enabled. A smart meeting is a type of a conference where an attendee is immediately seen and heard by other users when he/she starts speaking (voice activity detection).
Allowed values:
0 ,
1
|
max_guests
|
Integer
|
POST | PUT Maximum number of guest connections.
Default value: $max_allowed
|
participants_lock_enabled
|
Boolean
|
Is the ongoing conference inaccessible to new participants. - if the value is
null , then the conference is not currently running.
|
reminders_enabled
|
Boolean
|
Is the conference reminders enabled. Reminder is a notification that is sent to the conference participants before (5/10/15/30 minutes/1 hour/1 day) the conference start.
|
reminders
|
Object[]
|
List of ObjectReminder.
|
waiting_room_enabled
|
Boolean
|
POST | PUT Is waiting room enabled.
|
waiting_room_scope
|
String
|
POST | PUT Waiting room scope.
Default value: all
Allowed values:
"all" ,
"unplanned" ,
"strangers" ,
"guests"
|
origin_type
|
String
|
Indicates the origin of the conference creation. restfulapi - The conference was created using the API clientapp - The conference was initiated from a client application
|
use_translation
|
Boolean
|
POST | PUT Is synchronous translation enabled.
Default value: false
|
translation_flat_volume
|
Integer
|
POST | PUT The volume level of the original audio track during synchronous translation. - If the parameter is
null , the default value (30) is used.
Allowed values:
0-100
|
expiration_time_updating_allowed
|
Boolean
|
POST | PUT Indicates if conference duration can be extended.
|
expiration_time_alert
|
Integer
|
POST | PUT Sets the time (in seconds) when to display the notification about the impending conference end. No notification is sent if the value is 0.
|
sequence_type
|
Integer
|
POST | PUT The type of interleaving for scanning slots across all conference layouts.
Allowed values:
0 ,
1
|
scan_type
|
Integer
|
POST | PUT The direction of movement of scanning slots when using the interleaving type "move".
Allowed values:
0 ,
1
|
disable_audio_remarks
|
Boolean
|
POST | PUT Indicates if audio remarks are disabled.
|
mcu_mode
|
Boolean
|
Enable MCU mode. POST | PUT
|
transcoding
|
Object
|
POST | PUT Transcoding object.
|
participant_restrictions
|
Object
|
POST | PUT Participant Restrictions object.
|
join_options_enabled
|
Boolean
|
POST | PUT Indicates if the local configuration is used for conference join options.
|
join_options
|
Array
|
POST | PUT Contains the methods available for participants to join the conference. Note that starting from API v3.10, this parameter only includes conference local join options. - Possible values:
clients - Participants can join using TrueConf clients. webrtc - Participants can join using WebRTC-enabled browser. qr_code - Participants can join by scanning a QR code. terminal - Participants can join through H.323/SIP terminals. If UDP Multicast is enabled, the available options are limited to clients and qr_code . If MCU Mode is enabled, the options are restricted to webrtc and terminal (subject to license availability) and cannot be modified. UDP Multicast and MCU Mode cannot be enabled at the same time.
|