Airgram

Guides
/
/
Methods

api.joinGroupCall()

Joins an active group call. Returns join response payload for tgcalls

Parameters JoinGroupCallParams:

NameTypeDescription
groupCallIdnumber Group call identifier
participantId Identifier of a group call participant, which will be used to join the call; pass null to join as self; video chats only
audioSourceIdnumber Caller audio channel synchronization source identifier; received from tgcalls
payloadstring Group call join payload; received from tgcalls
isMutedboolean True, if the user's microphone is muted
isMyVideoEnabledboolean True, if the user's video is enabled
inviteHashstring If non-empty, invite hash to be used to join the group call without being muted by administrators
Returns ApiResponse interface:
interface ApiResponse {
  _: 'joinGroupCall' | 'error'
  airgram: Airgram
  request: {
    method: 'joinGroupCall'
    params: JoinGroupCallParams
  }
  response:  | 
  setState: (nextState: Record<string, unknown>) => void
  getState: () => Record<string, unknown>
}