node-telegram-api

설치(Installing)

npm 사용:

$ npm i node-telegram-api

yarn 사용:

$ yarn add node-telegram-api

예제 1 (usage)

TypeScript

기본적인 node-telegram-api 객체 생성후 메시지 발송하는 예제

import TelegramApi from "node-telegram-api";

const TELEGRAM_TOKEN = "your telegram token";
const TELEGRAM_CHAT_ID = 123445554; // your telegram chat ID

const telegramApi = new TelegramApi(TELEGRAM_TOKEN);

// 1.일반 메시지
telegramApi.sendMessage(TELEGRAM_CHAT_ID, "테스트 메시지입니다.");

// 2.키보드 메시지 예제
const keyboard = [
  ["a", "b", "c"],
  ["d", "e", "f"],
];
telegramApi.sendKeyboardMessage(TELEGRAM_CHAT_ID, "키보드", keyboard);

// 3.인라인 버튼 예제
const inlineButton = [
  [
    { text: "버튼1", callback_data: "1" },
    { text: "버튼2", callback_data: "2" },
    { text: "버튼3", callback_data: "3" },
  ],
  [
    { text: "버튼4", callback_data: "4" },
    { text: "버튼5", callback_data: "5" },
    { text: "버튼6", callback_data: "6" },
  ],
];
telegramApi.sendInlineButtonMessage(
  TELEGRAM_CHAT_ID,
  "인라인버튼",
  inlineButton
);

예제 2 (usage)

TypeScript

지속적으로 텔레그램 채팅창을 조회하여 상호 작용할 수 있도록 polling 방식으로 telegramApi 객체를 생성한다.

import TelegramApi from "node-telegram-api";
// 1. telegram bot 객체 생성
const telegramApi = new TelegramApi(TELEGRAM_TOKEN, {
  polling: true, // polling 여부
  process: "parallel", // parallel: 병렬 메시지 처리, series: 직렬 메시지 처리
});

// 2. init 메서드 추가
telegramApi.init((options) => {
  options.isAlarmOn = false; // 사용자 변수 임의로 추가 가능
});

// 키보드버튼 샘플
const getStartKeyboard = (isAlarmOn: boolean) => {
  const alarmOnOfButton = isAlarmOn ? "/알람 끄기" : "/알람 켜기";
  return [
    [alarmOnOfButton, "/코인선택"],
    [`/볼밴`, `/RSI`, `/캔들`],
  ];
};

// 인라인버튼 샘플
const getInlineButton = () => {
  return [
    [
      { text: "비트코인", callback_data: "BTC" },
      { text: "리플", callback_data: "XRP" },
      { text: "이더리움", callback_data: "ETH" },
    ],
    [
      { text: "비트코인캐시", callback_data: "BCH" },
      { text: "라이트코인", callback_data: "LTC" },
      { text: "스크라이크", callback_data: "STRK" },
    ],
  ];
};

// 3. 채팅창에 메시지가 입력되면 실행되는 콜백 Listener를 정의한다.
telegramApi.on("text", async ({ chatId, messageId, text, options }) => {
  let sendMsg = "";
  switch (text) {
    case "/start":
      sendMsg = "텔레그램 봇에 오신걸 환영합니다.";
      // 키보드 메시지
      await telegramApi.sendKeyboardMessage(
        chatId,
        sendMsg,
        getStartKeyboard(options?.isAlarmOn)
      );
      break;
    case "/알람 켜기":
      sendMsg = "알람이 켜졌습니다";
      options && (options.isAlarmOn = true);
      await telegramApi.sendKeyboardMessage(
        chatId,
        sendMsg,
        getStartKeyboard(options?.isAlarmOn)
      );
      break;
    case "/알람 끄기":
      sendMsg = "알람이 꺼졌습니다";
      options && (options.isAlarmOn = false);
      await telegramApi.sendKeyboardMessage(
        chatId,
        sendMsg,
        getStartKeyboard(options?.isAlarmOn)
      );
      break;
    case "/코인선택":
      sendMsg = "코인을 선택하십시오."; // 인라인버튼 콜백리스너에서 해당 메시지를 사용하여 콜백이벤트를 호출한다.
      // 인라인버튼 메시지
      telegramApi.sendInlineButtonMessage(chatId, sendMsg, getInlineButton());
      break;
    default:
      sendMsg = `텔레그램 봇입니다.[${text}]`;
      await telegramApi.sendMessage(chatId, sendMsg);
      break;
  }
});

// 4. 채팅장에 생성된 inline 버튼 클릭시 실행되는 콜백 Listener를 정의한다.
telegramApi.on(
  "callback",
  async ({ chatId, messageId, text, data, options }) => {
    let sendMsg = "";
    // text값은 inline버튼의 message 값이다.
    switch (text) {
      case "코인을 선택하십시오.":
        // data 값은 인라인버튼의 callback_data 값이다.
        sendMsg = `callback_data: ${data}`;
        await telegramApi.sendMessage(chatId, sendMsg);
        // 인라인버튼이 클릭되고 중복클릭을 방지하고싶다면 인라인버튼을 채팅창에서 삭제한다.
        await telegramApi.deleteMessage(chatId, messageId);
        break;
    }
  }
);

예제 3 (usage)

TypeScript

알람 On/Off 사용방법

telegramApi.watch(async ({ options }) => {
  // init메서드에서 추가한 사용자 변수를 가져온다.
  const isAlarmOn = options && options.isAlarmOn;
  if (isAlarmOn) {
    // 사용자변수가 true일때만 messageQueue에 chatID와 message를 push한다
    telegramApi.pushMessageQueue({
      chatId: TELEGRAM_CHAT_ID,
      message: "test",
    });
  }
}, 2000); // 2초간의 딜레이를 준다.

Resources

• CHANGELOG

License

MIT