messaging-api-telegram

Messaging API client for Telegram

Table of Contents

• Installation
• Usage
• API Reference
  • Webhook API
  • Send API
  • Get API
  • Updating API
  • Group API
  • Payments API
  • Inline Mode API
  • Game API
  • Others
• Debug Tips
• Testing

Installation

npm i --save messaging-api-telegram

or

yarn add messaging-api-telegram

Usage

Initialize

const { TelegramClient } = require('messaging-api-telegram');

// get accessToken from telegram [@BotFather](https://telegram.me/BotFather)
const client = new TelegramClient({
  accessToken: '12345678:AaBbCcDdwhatever',
});

Error Handling

messaging-api-telegram uses axios as HTTP client. We use axios-error package to wrap API error instances for better formatting error messages. Directly calling console.log with the error instance will return formatted message. If you'd like to get the axios request, response, or config, you can still get them via those keys on the error instance.

client.getWebhookInfo().catch((error) => {
  console.log(error); // formatted error message
  console.log(error.stack); // error stack trace
  console.log(error.config); // axios request config
  console.log(error.request); // HTTP request
  console.log(error.response); // HTTP response
});

API Reference

All methods return a Promise.

Webhook API

• getWebhookInfo
• getUpdates
• setWebhook
• deleteWebhook

Send API - Official Docs

• sendMessage
• sendPhoto
• sendAudio
• sendDocument
• sendSticker
• sendVideo
• sendVoice
• sendVideoNote
• sendMediaGroup
• sendLocation
• sendVenue
• sendContact
• sendChatAction

Get API

• getMe
• getUserProfilePhotos
• getFile
• getFileLink
• getChat
• getChatAdministrators
• getChatMembersCount
• getChatMember

Updating API

• editMessageText
• editMessageCaption
• editMessageReplyMarkup
• deleteMessage
• editMessageLiveLocation
• stopMessageLiveLocation

Group API

• kickChatMember
• unbanChatMember
• restrictChatMember
• promoteChatMember
• exportChatInviteLink
• deleteChatPhoto
• setChatTitle
• setChatDescription
• setChatStickerSet
• deleteChatStickerSet
• pinChatMessage
• unpinChatMessage
• leaveChat

Payments API

• sendInvoice
• answerShippingQuery
• answerPreCheckoutQuery

Inline mode API

• answerInlineQuery

Game API

• sendGame
• setGameScore
• getGameHighScores

Others

• forwardMessage

Debug Tips

Log Requests Details

To enable default request debugger, use following DEBUG env variable:

DEBUG=messaging-api:request

If you want to use a custom request logging function, just provide your own onRequest:

const client = new TelegramClient({
  accessToken: ACCESS_TOKEN,
  onRequest: ({ method, url, headers, body }) => {
    /* */
  },
});

Testing

Point Requests to Your Dummy Server

To avoid sending requests to real Telegram server, specify the origin option when constructing your client:

const { TelegramClient } = require('messaging-api-telegram');

const client = new TelegramClient({
  accessToken: ACCESS_TOKEN,
  origin: 'https://mydummytestserver.com',
});

Warning: Don't do this on your production server.