@ingestkorea/client-telegram v1.0.9

@ingestkorea/client-telegram

Description

INGESTKOREA SDK - Telegram Client for Node.js.

INGESTKOREA SDK - Telegram Client for Node.js is a lightweight library that contains only the essential features frequently used in Telegram bots.

This SDK performs tasks such as the following automatically.

• Authentication using an Bot User OAuth Token
• Retry requests
• Handle error responses

Installing

npm install @ingestkorea/client-telegram

Getting Started

Pre-requisites

Telegram

• Create a bot, then generate an authentication token for your new bot.

Node.js

• Use TypeScript v5.x

• Includes the TypeScript definitions for node.

  npm install -D @types/node # save dev mode

Support Commands

• SendMessage
• GetBotInfo
• GetWebhookInfo
• CreateWebhook
• DeleteWebhook
• ListUpdates

Import

The INGESTKOREA SDK - Telegram Client is modulized by client and commands.

To send a request, you only need to import the TelegramClient and the commands you need, for example SendMessageCommand:

import { TelegramClient, SendMessageCommand, SendMessageCommandInput } from "@ingestkorea/client-telegram";

Usage

To send a request, you:

• Initiate client with configuration.
• Initiate command with input parameters.
• Call send operation on client with command object as input.

// a client can be shared by different commands.
const client = new TelegramClient({
  credentials: {
    token: TOKEN, // required // 0123456789:ABCDEFG
    chatId: CHAT_ID, // required // 9876543210 (string | number)
  },
});

const params: SendMessageCommandInput = {
  text: "hello client-telegram : " + new Date().toISOString(), // required"
  chatId: CHAT_ID, // optional // this chatId override TelegramClient config
};

const command = new SendMessageCommand(params);

GetBotInfo

import { GetBotInfoCommand } from "@ingestkorea/client-telegram";

const command = new GetBotInfoCommand({});

GetWebhookInfo

import { GetWebhookInfoCommand } from "@ingestkorea/client-telegram";

const command = new GetWebhookInfoCommand({});

CreateWebhook

• If you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain a header "X-Telegram-Bot-Api-Secret-Token" with the secret token as content.
• You will not be able to receive updates using ListUpdatesCommand for as long as an outgoing webhook is set up.

import { CreateWebhookCommand } from "@ingestkorea/client-telegram";

const command = new CreateWebhookCommand({
  url: "https://webhook.yourdomain.com", // required
});

DeleteWebhook

import { DeleteWebhookCommand } from "@ingestkorea/client-telegram";

const command = new DeleteWebhookCommand({});

ListUpdates

• Use this method to receive incoming updates using long polling.
• This method will not work if an outgoing webhook is set up.

import { ListUpdatesCommand } from "@ingestkorea/client-telegram";

const command = new ListUpdatesCommand({});

Async/await

We recommend using await operator to wait for the promise returned by send operation as follows:

(async () => {
  const start = process.hrtime.bigint();
  try {
    // a client can be shared by different commands.
    const data = await client.send(command);
    console.dir(data, { depth: 5 });
  } catch (err) {
    console.log(err);
  } finally {
    let end = process.hrtime.bigint();
    let duration = Number(end - start) / 1000000;
    console.log("duration: " + duration + "ms");
  }
})();

Promises

• You can also use Promise chaining to execute send operation.
• Promises can also be called using .catch() and .finally() as follows:

const start = process.hrtime.bigint();

client
  .send(command)
  .then((data) => console.dir(data, { depth: 5 }))
  .catch((err) => console.log(err))
  .finally(() => {
    let end = process.hrtime.bigint();
    let duration = Number(end - start) / 1000000;
    console.log("duration: " + duration + "ms");
  });

Getting Help

We use the GitHub issues for tracking bugs and feature requests.

If it turns out that you may have found a bug, please open an issue.

License

This SDK is distributed under the MIT License, see LICENSE for more information.

Client Commands

SendMessage

CreateWebhook

DeleteWebhook

ListUpdates

Types

ParseMode

• "MarkdownV2"
• "HTML"
• "Markdown";

InlineKeyboardMarkup

InlineKeyboardButton