messaging-api-telegram
Messaging API client for Telegram
Table of Contents
Installation
npm i --save messaging-api-telegram
or
yarn add messaging-api-telegram
Usage
Initialize
const { TelegramClient } = require('messaging-api-telegram');
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);
console.log(error.stack);
console.log(error.config);
console.log(error.request);
console.log(error.response);
});
API Reference
All methods return a Promise.
Webhook API
Get API
Updating API
Group API
Payments API
Inline mode API
Game API
Others
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.