GramJS

phone.CreateGroupCall

Create a group call or livestream

Example

const { Api, TelegramClient } = require("telegram");
const { StringSession } = require("telegram/sessions");

const session = new StringSession(""); // You should put your string session here
const client = new TelegramClient(session, apiId, apiHash, {});

(async function run() {
  await client.connect(); // This assumes you have already authenticated with .start()

  const result = await client.invoke(
    new Api.phone.CreateGroupCall({
      peer: "username",
      randomId: 43,
      rtmpStream: true,
      title: "My very normal title",
      scheduleDate: 43,
    })
  );
  console.log(result); // prints the result
})();
import { Api, TelegramClient } from "telegram";
import { StringSession } from "telegram/sessions";

const session = new StringSession(""); // You should put your string session here
const client = new TelegramClient(session, apiId, apiHash, {});

(async function run() {
  await client.connect(); // This assumes you have already authenticated with .start()

  const result: Api.Updates = await client.invoke(
    new Api.phone.CreateGroupCall({
      peer: "username",
      randomId: 43,
      rtmpStream: true,
      title: "My very normal title",
      scheduleDate: 43,
    })
  );
  console.log(result); // prints the result
})();

Parameters

NameTypeDescription
flags#Flags, see TL conditional fields
rtmpStreamflags.2?trueWhether RTMP stream support should be enabled: only the group/supergroup/channel owner can use this flag.
peerInputPeerAssociate the group call or livestream to the provided group/supergroup/channel
randomIdintUnique client message ID required to prevent creation of duplicate group calls
titleflags.0?stringCall title
scheduleDateflags.1?intFor scheduled group call or livestreams, the absolute date when the group call will start

Result

Updates

Possible errors

CodeTypeDescription
400CHAT_ADMIN_REQUIREDYou must be an admin in this chat to do this.
400PEER_ID_INVALIDThe provided peer id is invalid.
400SCHEDULE_DATE_INVALIDInvalid schedule date provided.

Can bots use this method?

No

Channels, supergroups, gigagroups and basic groups

How to handle channels, supergroups, gigagroups, basic groups, and what's the difference between them.