phone.checkGroupCall

Check which of the specified source IDs the server still recognizes as joined to a group call. This method can be used with all group call types, see here » for more info.

After joining the main connection with phone.joinGroupCall, pass its non-zero SSRC/source ID to this method periodically. If a presentation connection is also active, include the separate source registered using phone.joinGroupCallPresentation.

The method returns the subset of the supplied sources that are still joined. A missing source means that the corresponding connection must be recreated and joined again; it does not indicate whether media packets are currently flowing. If the method returns GROUPCALL_JOIN_MISSING, the main connection must be rejoined.

 Method schema is available as of layer 129. Switch »

Parameters

Name Type Description
call InputGroupCall Group call whose WebRTC connections should be checked
sources Vector<int> Non-zero SSRC/source IDs of the caller's main and presentation connections

Result

Vector<int>

Only users can use this method

Possible errors

Code Type Description
400 GROUPCALL_INVALID The specified group call is invalid.
400 GROUPCALL_JOIN_MISSING You haven't joined this group call.

Related pages

Group calls

How to start, join and manage group calls and video chats.

phone.joinGroupCall

Join any group call type ». Conference calls additionally require the E2E joining flow ».

The params field must contain a join payload generated by the local tgcalls group-call engine. It contains a random non-zero audio ssrc, ICE ufrag and pwd, DTLS fingerprints, and, when publishing video, ssrc-groups.

For example, a join payload without published video has the following shape:

{
  "ssrc": 123456789,
  "ufrag": "...",
  "pwd": "...",
  "fingerprints": [{
    "hash": "sha-256",
    "fingerprint": "...",
    "setup": "passive"
  }]
}

When joining an RTMP-mode call, generate the payload without published video source groups.

phone.joinGroupCallPresentation

Start screen sharing in a non-RTMP video chat/livestream or conference. Presentations are not supported in live stories or RTMP-mode video chats/livestreams, see here » for more info.