feat(frontend): add telegram integration (#491)

* feat(frontend): add telegram notification agent * feat(telegram): add i18n keys for telegram * style(telegram): change message formatting in notification * feat(telegram): add short tutorial for telegram setup * feat(telegram): add i18n keys for telegram tutorial * style(telegram): correct grammar in infobox Co-authored-by: sct <ryan@sct.dev> * fix(telegram): redo i18n extraction Co-authored-by: Jakob Ankarhem <jakob.ankarhem@jetshop.se> Co-authored-by: sct <ryan@sct.dev>
2025-09-17 17:24:35 +02:00 · 2020-12-26 16:02:00 +01:00
parent 7434a26f76
commit c8d4d674f4
12 changed files with 517 additions and 3 deletions
--- a/server/lib/notifications/agents/telegram.ts
+++ b/server/lib/notifications/agents/telegram.ts
@@ -0,0 +1,128 @@
+import axios from 'axios';
+import { Notification } from '..';
+import logger from '../../../logger';
+import { getSettings, NotificationAgentTelegram } from '../../settings';
+import { BaseAgent, NotificationAgent, NotificationPayload } from './agent';
+
+interface TelegramPayload {
+  text: string;
+  parse_mode: string;
+  chat_id: string;
+}
+
+class TelegramAgent
+  extends BaseAgent<NotificationAgentTelegram>
+  implements NotificationAgent {
+  private baseUrl = 'https://api.telegram.org/';
+
+  protected getSettings(): NotificationAgentTelegram {
+    if (this.settings) {
+      return this.settings;
+    }
+
+    const settings = getSettings();
+
+    return settings.notifications.agents.telegram;
+  }
+
+  // TODO: Add checking for type here once we add notification type filters for agents
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  public shouldSend(_type: Notification): boolean {
+    if (
+      this.getSettings().enabled &&
+      this.getSettings().options.botAPI &&
+      this.getSettings().options.chatId
+    ) {
+      return true;
+    }
+
+    return false;
+  }
+
+  private escapeText(text: string | undefined): string {
+    return text ? text.replace(/[_*[\]()~>#+=|{}.!-]/gi, (x) => '\\' + x) : '';
+  }
+
+  private buildMessage(
+    type: Notification,
+    payload: NotificationPayload
+  ): string {
+    const settings = getSettings();
+    let message = '';
+
+    const title = this.escapeText(payload.subject);
+    const plot = this.escapeText(payload.message);
+    const user = this.escapeText(payload.notifyUser.username);
+
+    /* eslint-disable no-useless-escape */
+    switch (type) {
+      case Notification.MEDIA_PENDING:
+        message += `\*New Request\*\n`;
+        message += `${title}\n\n`;
+        message += `${plot}\n\n`;
+        message += `\*Requested By\*\n${user}\n\n`;
+        message += `\*Status\*\nPending Approval\n`;
+
+        break;
+      case Notification.MEDIA_APPROVED:
+        message += `\*Request Approved\*\n`;
+        message += `${title}\n\n`;
+        message += `${plot}\n\n`;
+        message += `\*Requested By\*\n${user}\n\n`;
+        message += `\*Status\*\nProcessing Request\n`;
+
+        break;
+      case Notification.MEDIA_AVAILABLE:
+        message += `\*Now available\\!\*\n`;
+        message += `${title}\n\n`;
+        message += `${plot}\n\n`;
+        message += `\*Requested By\*\n${user}\n\n`;
+        message += `\*Status\*\nAvailable\n`;
+
+        break;
+      case Notification.TEST_NOTIFICATION:
+        message += `\*Test Notification\*\n`;
+        message += `${title}\n\n`;
+        message += `${plot}\n\n`;
+        message += `\*Requested By\*\n${user}\n`;
+
+        break;
+    }
+
+    if (settings.main.applicationUrl && payload.media) {
+      const actionUrl = `${settings.main.applicationUrl}/${payload.media.mediaType}/${payload.media.tmdbId}`;
+      message += `\[Open in Overseerr\]\(${actionUrl}\)`;
+    }
+    /* eslint-enable */
+
+    return message;
+  }
+
+  public async send(
+    type: Notification,
+    payload: NotificationPayload
+  ): Promise<boolean> {
+    logger.debug('Sending telegram notification', { label: 'Notifications' });
+    try {
+      const endpoint = `${this.baseUrl}bot${
+        this.getSettings().options.botAPI
+      }/sendMessage`;
+
+      await axios.post(endpoint, {
+        text: this.buildMessage(type, payload),
+        parse_mode: 'MarkdownV2',
+        chat_id: `${this.getSettings().options.chatId}`,
+      } as TelegramPayload);
+
+      return true;
+    } catch (e) {
+      logger.error('Error sending Telegram notification', {
+        label: 'Notifications',
+        message: e.message,
+      });
+      return false;
+    }
+  }
+}
+
+export default TelegramAgent;