Class TelegramClient<S>

Example

await client.connect();
if (await client.checkAuthorization()){
    console.log("I am logged in!");
}else{
    console.log("I am connected to telegram servers but not logged in with any account/bot");
}
Copy

Example

await client.logOut();
Copy

Example

// User can't access their email, reset it
const newSentCode = await client.resetLoginEmail("+1234567890", "abc123hash");
Copy

Example

await client.connect();
const {phoneCodeHash,isCodeViaApp} = await client.sendCode({
    apiId:1234,
    apiHash:"123456789abcfghj",
},"+123456798"});
Copy

Example

const result = await client.sendVerifyEmailCode(
    "+1234567890",
    "abc123hash",
    "[email protected]"
);
console.log(`Code sent to ${result.emailPattern}, length: ${result.length}`);
Copy

Example

await client.connect();
const bot = await client.signInBot({
    apiId:1234,
    apiHash:"12345",
},{
    botToken:"123456:abcdfghae4fg654",
});
// we are now logged in as a bot
console.log("Logged in",bot);
Copy

Example

await client.connect();
// we should only use this when we are not already authorized.
// This function is very similar to `client.start`
// The minor difference that start checks if already authorized and supports bots as well.
if (!await client.checkAuthorization()){
    const phoneNumber = "+123456789";
    await client.signIn({
        apiId:132456,
        apiHash:"132456",
    },{
    phoneNumber: async () => await input.text("number ?"),
    password: async () => await input.text("password?"),
    phoneCode: async () => await input.text("Code ?"),
    onError: (err) => console.log(err),
    })
 }
Copy

Example

'''ts
await client.connect();
const controller = new AbortController();
// call controller.abort() to cancel the QR login at any time
try {
  const user = await client.signInUserWithQrCode({ apiId, apiHash },
  {
      onError: async function(p1: Error) {
          console.log("error", p1);
          // true = stop the authentication processes
          return true;
      },
      qrCode: async (code) => {
          console.log("Convert the next string to a QR code and scan it");
          console.log(
              `tg://login?token=${code.token.toString("base64url")}`
          );
      },
      password: async (hint) => {
          // password if needed
          return "1111";
      },
      abortSignal: controller.signal,
  }
  );
  console.log("user is", user);
} catch (err) {
  if (err.name === "AbortError") console.log("QR login cancelled");
  else throw err;
}

'''
Copy

Example

await client.connect();
const me = await client.signInWithWebToken({ apiId, apiHash }, token);
console.log(client.session.save());
Copy

Example

// Verify with email code
const result = await client.verifyEmail(
    "+1234567890",
    "abc123hash",
    { type: "code", code: "12345" }
);

// Or verify with Google Sign-In
const result = await client.verifyEmail(
    "+1234567890",
    "abc123hash",
    { type: "google", token: "google-id-token" }
);
Copy

Example

import {Button} from "teleproto/tl/custom/button";
 // PS this function is not async
const markup = client.buildReplyMarkup(Button.inline("Hello!"));

await client.sendMessage(chat, {
    message: "click me!",
    buttons: markup,
}

// The following example can also be used in a simpler way like so

await client.sendMessage(chat, {
    message: "click me!",
    buttons: [Button.inline("Hello!")],
}
Copy

Example

 await client.deleteMessages(chat, messages);

 await client.deleteMessages(chat, messages, {revoke:false});
Copy

Example

 const message = await client.sendMessage(chat,{message:"Hi!"});

 await client.editMessage(chat,{message:message,text:"Hello!"}
 // or
 await client.editMessage(chat,{message:message.id,text:"Hello!"}
Copy

Example

const message = await client.getMessageByLink("https://t.me/durov/123");
Copy

Example

// The totalList has a .total attribute which will show the complete number of messages even if none are fetched.
// Get 0 photos and print the total to show how many photos there are
import { Api } from "teleproto";
const photos = await client.getMessages(chat, {limit: 0, filter:Api.InputMessagesFilterPhotos})
console.log(photos.total)

// Get all the photos
const photos = await client.getMessages(chat, {limit: undefined, filter:Api.InputMessagesFilterPhotos})

// Get messages by ID:
const messages = await client.getMessages(chat, {ids:1337})
const message_1337 = messages[0];
Copy

Example

for await (const chunk of client.iterDownload(message)) {
    stream.write(chunk);
}
Copy

Example

// From most-recent to oldest
for await (const message of client.iterMessages(chat,{}){
   console.log(message.id, message.text)
}

// From oldest to most-recent
for await (const message of client.iterMessages(chat,{reverse:true}){
   console.log(message.id, message.text)
}

// Filter by sender
for await (const message of client.iterMessages(chat,{fromUser:"me"}){
   console.log(message.id, message.text)
}

// Server-side search with fuzzy text
for await (const message of client.iterMessages(chat,{search:"hello"}){
   console.log(message.id, message.text)
}

// Filter by message type:
import { Api } from "teleproto";
for await (const message of client.iterMessages(chat,{filter: Api.InputMessagesFilterPhotos}){
   console.log(message.id, message.photo)
}

// Getting comments from a post in a channel:
 * for await (const message of client.iterMessages(chat,{replyTo: 123}){
   console.log(message.chat.title,, message.text)
}
Copy

Example

 // using a Message object
 const message = await client.sendMessage(chat, 'teleproto is awesome!');
 await client.markAsRead(chat, message)
 // ...or using the int ID of a Message
 await client.markAsRead(chat, message.id);

 // ...or passing a list of messages to mark as read
 await client.markAsRead(chat, messages)
Copy

Example

// gets the current parse mode.
console.log("parse mode is :",  client.parseMode)
Copy

Example

 const message = await client.sendMessage(chat, 'teleproto is awesome!');

 await client.pinMessage(chat, message);
Copy

Example

 const message = await client.sendMessage(chat, 'teleproto is awesome!');

 await client.pinMessage(chat, message);
Copy

Example

await client.saveDraft(chat, { message: "answer this tomorrow", replyTo: 123 });
Copy

Example

// Markdown is the default.
await client.sendMessage("me",{message:"Hello **world!**});

// Defaults to another parse mode.
client.setParseMode("HTML");

await client.sendMessage('me', {message:'Some <b>bold</b> and <i>italic</i> text'})
await client.sendMessage('me', {message:'An <a href="https://example.com">URL</a>'})
await client.sendMessage('me', {message:'<a href="tg://user?id=me">Mentions</a>'})

// Explicit parse mode.
//  No parse mode by default
client.setParseMode(undefined);
//...but here I want markdown
await client.sendMessage('me', {message:'Hello, **world**!', {parseMode:"md"}})

// ...and here I need HTML
await client.sendMessage('me', {message:'Hello, <i>world</i>!', {parseMode='html'}})


// Scheduling a message to be sent after 5 minutes

await client.sendMessage(chat, {message:'Hi, future!', schedule:(60 * 5) + (Date.now() / 1000)})

Copy

Example

await client.sendPoll(chat, {
    question: "Best transport?",
    answers: ["TCP full", "Abridged", "Obfuscated"],
});
await client.sendPoll(chat, {
    question: "2 + 2 = ?",
    answers: ["3", "4"],
    quiz: true,
    correctAnswers: 1,
    solution: "Basic arithmetic!",
});
Copy

Example

await client.sendReaction(chat, 123, [new Api.ReactionEmoji({ emoticon: "👍" })]);
Copy

Example

// sets the mode to HTML
client.setParseMode("html");
await client.sendMessage("me",{message:"<u>This is an underline text</u>"});
// disable formatting
client.setParseMode(undefined);
await client.sendMessage("me",{message:"<u> this will be sent as it is</u> ** with no formatting **});
Copy

Example

const t = await client.translateText({ entity: chat, ids: 123, toLang: "en" });
const t2 = await client.translateText({ text: "привет", toLang: "en" });
Copy

Example

 const message = await client.sendMessage(chat, 'teleproto is awesome!');

 // unpin one message
 await client.unpinMessage(chat, message);

 // unpin all messages
 await client.unpinMessage(chat);
Copy

Example

 const message = await client.sendMessage(chat, 'teleproto is awesome!');

 // unpin one message
 await client.unpinMessage(chat, message);

 // unpin all messages
 await client.unpinMessage(chat);
Copy

Example

await client.vote(chat, 123, 0);
await client.vote(chat, 123, [0, 2]); // multiple-choice poll
Copy

Example

const photo = message.photo;
const buffer = await client.downloadFile(
      new Api.InputPhotoFileLocation({
         id: photo.id,
         accessHash: photo.accessHash,
         fileReference: photo.fileReference,
         thumbSize: size.type
     }),
     {
         dcId: photo.dcId,
         fileSize: "m",
     }
);
Copy

Example: ```ts const buffer = await client.downloadMedia(message, {}) // to save it to a file later on using fs. import { promises as fs } from 'fs'; await fs.writeFile("file",buffer); // to use a progress callback you can pass it like so. const buffer = await client.downloadMedia(message, { progressCallback : console.log }) ```

Example

// Download your own profile photo
const buffer = await client.downloadProfilePhoto('me')
console.log("Downloaded image is",buffer);
// if you want to save it as a file you can use the fs module on node for that.
import { promises as fs } from 'fs';
await fs.writeFile("picture.jpg",buffer);
Copy

Example

// Normal files like photos
await client.sendFile(chat, {file:'/my/photos/me.jpg', caption:"It's me!"})
// or
await client.sendMessage(chat, {message:"It's me!", file:'/my/photos/me.jpg'})

Voice notes or round videos
await client.sendFile(chat, {file: '/my/songs/song.mp3', voiceNote:True})
await client.sendFile(chat, {file: '/my/videos/video.mp4', videoNote:True})

// Custom thumbnails
await client.sendFile(chat, {file:'/my/documents/doc.txt', thumb:'photo.jpg'})

// Only documents
await client.sendFile(chat, {file:'/my/photos/photo.png', forceDocument:True})

//logging progress
await client.sendFile(chat, {file: file, progressCallback=console.log})

// Dices, including dart and other future emoji
await client.sendFile(chat, {file:new Api.InputMediaDice("")})
await client.sendFile(chat, {file:new Api.InputMediaDice("🎯")})

// Contacts
await client.sendFile(chat, {file: new Api.InputMediaContact({
 phoneNumber:'+1 123 456 789',
 firstName:'Example',
 lastName:'',
 vcard:''
 }))
Copy

Example

import { CustomFile } from "teleproto/client/uploads";
const toUpload = new CustomFile("photo.jpg", fs.statSync("../photo.jpg").size, "../photo.jpg");
const file = await client.uploadFile({
 file: toUpload,
 workers: 1,
 });
 await client.invoke(new Api.photos.UploadProfilePhoto({
     file: file,
 }));
Copy

Example

const channel = await client.createChannel({ title: "My channel", about: "news" });
const group = await client.createChannel({ title: "My group", megagroup: true });
Copy

Example

await client.editAdmin(chat, user, { deleteMessages: true, banUsers: true, rank: "mod" });
await client.editAdmin(chat, user, {}); // demote
Copy

Example

await client.editBanned(chat, user);                       // full ban
await client.editBanned(chat, user, { sendMedia: true });  // mute media
await client.editBanned(chat, user, {});                   // unban
Copy

Example

await client.editPeerFolders(chat, 1); // archive
await client.editPeerFolders([chatA, chatB], 0); // unarchive
Copy

Example

const result = await client.getParticipant(channel, "username");
console.log(result.participant); // ChannelParticipant | ChannelParticipantAdmin | …
Copy