mirror of https://github.com/appleboy/telegram-action.git synced 2026-06-30 23:37:56 +00:00

Files

T

appleboy 84183da9cf docs: add Chinese READMEs for GitHub Actions notifications

- Add a Chinese (Simplified) README for GitHub Actions Telegram notifications
- Add a Chinese (Traditional) README for GitHub Actions Telegram notifications

Signed-off-by: appleboy <appleboy.tw@gmail.com>

2024-11-20 22:27:02 +08:00

5.6 KiB

Raw Blame History

🚀 GitHub Actions 的 Telegram

GitHub Action 用于发送 Telegram 通知消息。

使用方法

注意：如果您收到 "Error: Chat not found" 错误，请参考这个 stackoverflow 的回答这里。

发送自定义消息并查看如下的自定义变量。

Input variables

Variable	Description
socks5	optional. support socks5 proxy URL
photo	optional. photo message
document	optional. document message
sticker	optional. sticker message
audio	optional. audio message
voice	optional. voice message
location	optional. location message
venue	optional. venue message
video	optional. video message
debug	optional. enable debug mode
format	optional. `markdown` or `html`. See MarkdownV2 style
message	optional. custom message
message_file	optional. overwrite the default message template with the contents of the specified file.
disable_web_page_preview	optional. disables link previews for links in this message. default is `false`.
disable_notification	optional. disables notifications for this message, supports sending a message without notification. default is `false`.

Example

send photo message:

- uses: actions/checkout@master
- name: send photo message
  uses: appleboy/telegram-action@master
  with:
    to: ${{ secrets.TELEGRAM_TO }}
    token: ${{ secrets.TELEGRAM_TOKEN }}
    message: send photo message
    photo: tests/github.png
    document: tests/gophercolor.png

send location message:

- name: send location message
  uses: appleboy/telegram-action@master
  with:
    to: ${{ secrets.TELEGRAM_TO }}
    token: ${{ secrets.TELEGRAM_TOKEN }}
    location: '24.9163213 121.1424972'
    venue: '35.661777 139.704051 竹北體育館 新竹縣竹北市'

send message using custom proxy (support http, https, and socks5) like socks5://127.0.0.1:1080 or http://222.124.154.19:23500

- name: send message using socks5 proxy URL
  uses: appleboy/telegram-action@master
  with:
    to: ${{ secrets.TELEGRAM_TO }}
    token: ${{ secrets.TELEGRAM_TOKEN }}
    socks5: "http://222.124.154.19:23500"
    message: Send message from socks5 proxy URL.

Secrets

Getting started with Telegram Bot API.

token: Telegram authorization token.
to: Unique identifier for this chat.

How to get unique identifier from telegram api:

curl https://api.telegram.org/bot<token>/getUpdates

See the result: (get chat id like 65382999)

{
  "ok": true,
  "result": [
    {
      "update_id": 664568113,
      "message": {
        "message_id": 8423,
        "from": {
          "id": 65382999,
          "is_bot": false,
          "first_name": "Bo-Yi",
          "last_name": "Wu (appleboy)",
          "username": "appleboy46",
          "language_code": "en"
        },
        "chat": {
          "id": 65382999,
          "first_name": "Bo-Yi",
          "last_name": "Wu (appleboy)",
          "username": "appleboy46",
          "type": "private"
        },
        "date": 1550333434,
        "text": "?"
      }
    }
  ]
}

Template variable

Github Variable	Telegram Template Variable
GITHUB_REPOSITORY	repo
GITHUB_ACTOR	repo.namespace
GITHUB_SHA	commit.sha
GITHUB_REF	commit.ref
GITHUB_WORKFLOW	github.workflow
GITHUB_ACTION	github.action
GITHUB_EVENT_NAME	github.event.name
GITHUB_EVENT_PATH	github.event.path
GITHUB_WORKSPACE	github.workspace

5.6 KiB Raw Blame History