GramJS

⚠️ This project is archived and no longer maintained. Development continues in teleproto, an actively maintained fork. It's largely compatible with GramJS for most projects, migration means little more than swapping the package:
npm install teleproto
See the migration guide for details.

messages.DeleteChatUser

Deletes a user from a chat and sends a service message on it.

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.messages.DeleteChatUser({
      chatId: BigInt("-4156887774564"),
      userId: "username",
      revokeHistory: true,
    })
  );
  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.messages.DeleteChatUser({
      chatId: BigInt("-4156887774564"),
      userId: "username",
      revokeHistory: true,
    })
  );
  console.log(result); // prints the result
})();

Parameters

NameTypeDescription
flags#Flags, see TL conditional fields
revokeHistoryflags.0?trueRemove the entire chat history of the specified user in this chat.
chatIdlongChat ID
userIdInputUserUser ID to be deleted

Result

Updates

Possible errors

CodeTypeDescription
400CHAT_ADMIN_REQUIREDYou must be an admin in this chat to do this.
400CHAT_ID_INVALIDThe provided chat id is invalid.
400PEER_ID_INVALIDThe provided peer id is invalid.
400USER_ID_INVALIDThe provided user ID is invalid.
400USER_NOT_PARTICIPANTYou're not a member of this supergroup/channel.

Can bots use this method?

Yes