GramJS

messages.AddChatUser

Adds a user to 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.AddChatUser({
      chatId: 43,
      userId: "username",
      fwdLimit: 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.messages.AddChatUser({
      chatId: 43,
      userId: "username",
      fwdLimit: 43,
    })
  );
  console.log(result); // prints the result
})();

Parameters

NameTypeDescription
chatIdintChat ID
userIdInputUserUser ID to be added
fwdLimitintNumber of last messages to be forwarded

Result

messages.StatedMessage

Possible errors

CodeTypeDescription
400CHAT_ADMIN_REQUIREDYou must be an admin in this chat to do this
400CHAT_ID_INVALIDThe provided chat id is invalid
403CHAT_WRITE_FORBIDDENYou can't write in this chat
400INPUT_USER_DEACTIVATEDThe specified user was deleted
400PEER_ID_INVALIDThe provided peer id is invalid
400USERS_TOO_MUCHThe maximum number of users has been exceeded (to create a chat, for example)
400USER_ALREADY_PARTICIPANTThe user is already in the group
400USER_ID_INVALIDThe provided user ID is invalid
403USER_NOT_MUTUAL_CONTACTThe provided user is not a mutual contact
403USER_PRIVACY_RESTRICTEDThe user's privacy settings do not allow you to do this

Can bots use this method?

No