Link Search Menu Expand Document

Constructor: groupCall

Back to constructors index

Info about a group call or livestream

Attributes:

NameTypeRequiredDescription
join_mutedBoolOptionalWhether the user should be muted upon joining the call
can_change_join_mutedBoolOptionalWhether the current user can change the value of the join_muted flag using phone.toggleGroupCallSettings
join_date_ascBoolOptionalSpecifies the ordering to use when locally sorting by date and displaying in the UI group call participants.
schedule_start_subscribedBoolOptionalWhether we subscribed to the scheduled call
can_start_videoBoolOptionalWhether you can start streaming video into the call
record_video_activeBoolOptionalWhether the group call is currently being recorded
rtmp_streamBoolOptionalWhether RTMP streams are allowed
listeners_hiddenBoolOptionalWhether 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.
idlongYesGroup call ID
access_hashlongYesGroup call access hash
participants_countintYesParticipant count
titlestringOptionalGroup call title
stream_dc_idintOptionalDC ID to be used for livestream chunks
record_start_dateintOptionalWhen was the recording started
schedule_dateintOptionalWhen is the call scheduled to start
unmuted_video_countintOptionalNumber of people currently streaming video into the call
unmuted_video_limitintYesMaximum number of people allowed to stream video into the call
versionintYesVersion

Type: GroupCall

Example:

$groupCall = ['_' => 'groupCall', 'join_muted' => Bool, 'can_change_join_muted' => Bool, 'join_date_asc' => Bool, 'schedule_start_subscribed' => Bool, 'can_start_video' => Bool, 'record_video_active' => Bool, 'rtmp_stream' => Bool, 'listeners_hidden' => Bool, 'id' => long, 'access_hash' => long, 'participants_count' => int, 'title' => 'string', 'stream_dc_id' => int, 'record_start_date' => int, 'schedule_date' => int, 'unmuted_video_count' => int, 'unmuted_video_limit' => int, 'version' => int];