Describes a group call.
If the min flag is set, this is a partial (min) constructor: only a subset of its fields contains up-to-date information, and it must be merged into a previously cached non-min constructor as described below. If no full (non-min) constructor for this call was cached previously, the min constructor must be discarded.
When min is set, the following mandatory fields may be used: id, access_hash, participants_count and version. In addition, only the following conditional fields may be used if present, subject to the usual version check:
conferencertmp_streamlisteners_hiddentitlemessages_enabledrecord_start_date and record_video_activeschedule_datesend_paid_messages_starsWhen min is set, the following fields must be ignored, keeping the values from the previously cached non-min constructor:
join_mutedcan_change_join_mutedschedule_start_subscribedcan_start_videocreatorcan_change_messages_enabledunmuted_video_countunmuted_video_limitstream_dc_idinvite_linkdefault_send_asThe join_date_asc flag is set only when the call is created and never changes afterwards, so it too is not applied from a min constructor.
groupCall#553b0ba1 flags:# join_muted:flags.1?true can_change_join_muted:flags.2?true join_date_asc:flags.6?true schedule_start_subscribed:flags.8?true can_start_video:flags.9?true record_video_active:flags.11?true rtmp_stream:flags.12?true listeners_hidden:flags.13?true conference:flags.14?true creator:flags.15?true id:long access_hash:long participants_count:int title:flags.3?string stream_dc_id:flags.4?int record_start_date:flags.5?int schedule_date:flags.7?int unmuted_video_count:flags.10?int unmuted_video_limit:int version:int invite_link:flags.16?string = GroupCall;| Name | Type | Description |
|---|---|---|
| flags | # | Flags, see TL conditional fields |
| join_muted | flags.1?true | Whether the user should be muted upon joining the call. Must be ignored if the min flag is set. |
| can_change_join_muted | flags.2?true | Whether the current user can change the value of the join_muted flag using phone.toggleGroupCallSettings. Must be ignored if the min flag is set. |
| join_date_asc | flags.6?true | Specifies the ordering to use when locally sorting by date and displaying in the UI group call participants. Set only when the call is created and never changed afterwards, so it is not applied from a min constructor. |
| schedule_start_subscribed | flags.8?true | Whether we subscribed to the scheduled call. Must be ignored if the min flag is set. |
| can_start_video | flags.9?true | Whether you can start streaming video into the call. Must be ignored if the min flag is set. |
| record_video_active | flags.11?true | Whether the group call is currently being recorded |
| rtmp_stream | flags.12?true | Whether this call uses RTMP livestream mode » |
| listeners_hidden | flags.13?true | Whether the listeners list is hidden and cannot be fetched using phone.getGroupParticipants. The phone.groupParticipants.count and groupCall.participants_count counters will still include listeners. |
| conference | flags.14?true | Whether this is an E2E conference call. |
| creator | flags.15?true | Whether the current user created this group call. Must be ignored if the min flag is set. |
| messages_enabled | flags.17?true | Whether the in-call message overlay » is enabled |
| can_change_messages_enabled | flags.18?true | Whether the current user may enable or disable the in-call message overlay ». Must be ignored if the min flag is set. |
| min | flags.19?true | Whether this is a partial constructor that must be merged into a previously cached non-min constructor, following the rules described above. |
| id | long | Group call ID |
| access_hash | long | Group call access hash |
| participants_count | int | Participant count |
| title | flags.3?string | Group call title |
| stream_dc_id | flags.4?int | Media DC ID to use for RTMP stream requests ». Must be ignored if the min flag is set. |
| record_start_date | flags.5?int | When was the recording started |
| schedule_date | flags.7?int | When is the call scheduled to start |
| unmuted_video_count | flags.10?int | Number of people currently streaming video into the call. Must be ignored if the min flag is set. |
| unmuted_video_limit | int | Maximum number of people allowed to stream video into the call. Must be ignored if the min flag is set. |
| version | int | Revision used to apply group call updates » |
| invite_link | flags.16?string | Invitation link for a conference call ». Must be ignored if the min flag is set. |
| send_paid_messages_stars | flags.20?long | Minimum Stars donation required from users other than the live story owner to send a paid comment »; 0 or no value allows free comments |
| default_send_as | flags.21?Peer | Default peer displayed as the author of live story comments and reactions ». Must be ignored if the min flag is set. |
Change group call settings. Each setting supports different group call types, see here » for more info.
How to start, join and manage group calls and video chats.
Get group call participants.