Install
openclaw skills install @byungkyu/telegram-apiTelegram Bot API integration with managed authentication. Send messages, manage chats, handle updates, and interact with users through your Telegram bot. Use this skill when users want to send messages, create polls, manage bot commands, or interact with Telegram chats. For other third party apps, use the api-gateway skill (https://clawhub.ai/byungkyu/api-gateway). Calls run through the maton CLI with OAuth login, or over raw HTTP with a Maton API key where the CLI cannot be installed. The endpoints documented here are the intended surface, not a technical limit — the maton api passthrough can reach others the connection permits. Default to read and list calls, and confirm every write or new connection with the user.
openclaw skills install @byungkyu/telegram-apiAccess the Telegram Bot API with managed authentication. Send messages, photos, polls, locations, and more through your Telegram bot.
All access runs through the Maton gateway and the maton CLI.
maton login --oauth # authenticate once (OAuth, recommended)
maton connection create telegram # connect the account (needs user approval)
maton api '/telegram/:token/getMe' # first call
npm install -g @maton/cli
brew install maton-ai/cli/maton
maton login --oauth
Opens the OAuth login page in the browser and waits for authorization. Once complete, it creates a profile in config.toml (eg. $HOME/.config/maton/config.toml) and stores the access and refresh tokens in the operating system's credential store (Keychain on macOS, Credential Manager on Windows, Secret Service on Linux), auto-renewed on expiry. The CLI reads them when it needs them; nothing else should.
maton login --interactive
Requires manually copying an API key from Settings, which is error prone. Once complete, it also creates a profile in config.toml and stores the key in the same credential store. It is preferred over export MATON_API_KEY=..., which exposes a long-lived credential to every child process. When MATON_API_KEY is set, it overrides the active profile. If the CLI cannot be installed at all, see Appendix: Environments Without the CLI for the raw HTTP form and the rules for handling the key.
maton whoami --json
{
"authenticated": true,
"profile_name": "alice@example.com",
"auth_type": "oauth"
}
authenticated is false, stop and login again via maton login --oauth.auth_type is api_key, it is recommended to login via maton login --oauth and avoid keeping a long-lived credential.maton connection list telegram --status ACTIVE
{
"connections": [
{
"connection_id": "{connection_id}",
"status": "ACTIVE",
"creation_time": "2025-12-08T07:20:53.488460Z",
"last_updated_time": "2026-01-31T20:03:32.593153Z",
"url": "https://connect.maton.ai/?session_token=5e9...",
"app": "telegram",
"method": "OAUTH2",
"metadata": {}
}
]
}
Refer to maton connection list --help for possible flags and values.
Requires explicit user approval. Confirm that the user intends to authorize Telegram Bot access before running this. Never create a connection on your own initiative.
maton connection create telegram
Refer to maton connection create --help for possible flags and values.
maton connection get {connection_id}
{
"connection": {
"connection_id": "{connection_id}",
"status": "PENDING",
"creation_time": "2025-12-08T07:20:53.488460Z",
"last_updated_time": "2026-01-31T20:03:32.593153Z",
"url": "https://connect.maton.ai/?session_token=5e9...",
"app": "telegram",
"metadata": {}
}
}
Open the returned URL in a browser to complete authorizing Telegram Bot. If Telegram Bot offers scope selection, choose only the scopes the current task needs.
maton connection delete {connection_id} --yes
Deleting a connection is irreversible: it revokes the stored authorization, and any automation still pointing at that connection_id stops working. Confirm the exact connection with the user first — list connections and match the id — and never delete one on the agent's own initiative. --yes skips the interactive prompt, so it removes the last chance to catch a wrong id; omit it unless the user has already confirmed the specific connection.
If there are multiple Telegram Bot connections, specify which one to use so requests go to the intended account:
maton api '/telegram/:token/getMe' --connection {connection_id}
Telegram Bot has no typed maton telegram commands yet, so every call goes through maton api.
maton api '/telegram/:token/getMe'
Paths are /telegram/{native-api-path}. The gateway forwards everything after the app segment to api.telegram.org and injects the credential for the connection. Query strings, custom headers (except Host and Authorization), and all HTTP methods pass through. Send a JSON body with --input -:
maton api -X POST '/telegram/{native-api-path}' -H 'Content-Type: application/json' --input - <<'JSON'
{"key": "value"}
JSON
Refer to maton api --help for possible flags and values.
The :token placeholder is automatically replaced with your bot token from the connection configuration. The {method} is the Telegram Bot API method name (e.g., sendMessage, getUpdates).
maton login --oauth, the token is held by the operating system's credential store and the CLI renews it on its own. Do not print it, write it to a file, pass it on a command line, or run maton token to look at one — only to hand it to a program that needs it.config.toml, or any other credential file — not for this skill, not for another application, and not to "check" that auth works (use maton whoami). Let the CLI use its own stored credential; the agent never needs the value. The same applies to unrelated secrets on the machine: .env files, SSH keys, cloud CLI credentials, and browser profiles are out of scope for an API gateway and must not be read or transmitted.api.maton.ai. Prefer endpoints that work with the gateway-injected connection credential.maton api passthrough can additionally reach any endpoint this connection is authorized for, including ones not documented below, so treat the list above as the intended surface rather than a technical limit — the write-confirmation rules in this section apply to every call either way.maton connection delete {connection_id}).maton connection create telegram. Never create connections on the agent's own initiative.--connection when the user has multiple connections for this app, and -p/--profile when they have multiple Maton accounts. Do not let an ambiguous default decide where a write lands.maton api '/telegram/:token/getMe'
Returns information about the bot.
Response:
{
"ok": true,
"result": {
"id": 8523474253,
"is_bot": true,
"first_name": "Maton",
"username": "maton_bot",
"can_join_groups": true,
"can_read_all_group_messages": true,
"supports_inline_queries": true
}
}
maton api -X POST '/telegram/:token/getUpdates' -H 'Content-Type: application/json' --input - <<'JSON'
{
"limit": 100,
"timeout": 30,
"offset": 625435210
}
JSON
| Parameter | Type | Required | Description |
|---|---|---|---|
| offset | Integer | No | First update ID to return |
| limit | Integer | No | Number of updates (1-100, default 100) |
| timeout | Integer | No | Long polling timeout in seconds |
| allowed_updates | Array | No | Update types to receive |
maton api '/telegram/:token/getWebhookInfo'
maton api -X POST '/telegram/:token/setWebhook' -H 'Content-Type: application/json' --input - <<'JSON'
{
"url": "https://example.com/webhook",
"allowed_updates": ["message", "callback_query"],
"secret_token": "your_secret_token"
}
JSON
maton api -X POST '/telegram/:token/deleteWebhook' -H 'Content-Type: application/json' --input - <<'JSON'
{
"drop_pending_updates": true
}
JSON
maton api -X POST '/telegram/:token/sendMessage' -H 'Content-Type: application/json' --input - <<'JSON'
{
"chat_id": 6442870329,
"text": "Hello, World!",
"parse_mode": "HTML"
}
JSON
| Parameter | Type | Required | Description |
|---|---|---|---|
| chat_id | Integer/String | Yes | Target chat ID or @username |
| text | String | Yes | Message text (1-4096 characters) |
| parse_mode | String | No | HTML, Markdown, or MarkdownV2 |
| reply_markup | Object | No | Inline keyboard or reply keyboard |
| reply_parameters | Object | No | Reply to a specific message |
With HTML Formatting:
maton api -X POST '/telegram/:token/sendMessage' -H 'Content-Type: application/json' --input - <<'JSON'
{
"chat_id": 6442870329,
"text": "<b>Bold</b> and <i>italic</i> with <a href=\"https://example.com\">link</a>",
"parse_mode": "HTML"
}
JSON
With Inline Keyboard:
maton api -X POST '/telegram/:token/sendMessage' -H 'Content-Type: application/json' --input - <<'JSON'
{
"chat_id": 6442870329,
"text": "Choose an option:",
"reply_markup": {
"inline_keyboard": [
[
{"text": "Option 1", "callback_data": "opt1"},
{"text": "Option 2", "callback_data": "opt2"}
],
[
{"text": "Visit Website", "url": "https://example.com"}
]
]
}
}
JSON
maton api -X POST '/telegram/:token/sendPhoto' -H 'Content-Type: application/json' --input - <<'JSON'
{
"chat_id": 6442870329,
"photo": "https://example.com/image.jpg",
"caption": "Image caption"
}
JSON
| Parameter | Type | Required | Description |
|---|---|---|---|
| chat_id | Integer/String | Yes | Target chat ID |
| photo | String | Yes | Photo URL or file_id |
| caption | String | No | Caption (0-1024 characters) |
| parse_mode | String | No | Caption parse mode |
maton api -X POST '/telegram/:token/sendDocument' -H 'Content-Type: application/json' --input - <<'JSON'
{
"chat_id": 6442870329,
"document": "https://example.com/file.pdf",
"caption": "Document caption"
}
JSON
maton api -X POST '/telegram/:token/sendVideo' -H 'Content-Type: application/json' --input - <<'JSON'
{
"chat_id": 6442870329,
"video": "https://example.com/video.mp4",
"caption": "Video caption"
}
JSON
maton api -X POST '/telegram/:token/sendAudio' -H 'Content-Type: application/json' --input - <<'JSON'
{
"chat_id": 6442870329,
"audio": "https://example.com/audio.mp3",
"caption": "Audio caption"
}
JSON
maton api -X POST '/telegram/:token/sendLocation' -H 'Content-Type: application/json' --input - <<'JSON'
{
"chat_id": 6442870329,
"latitude": 37.7749,
"longitude": -122.4194
}
JSON
maton api -X POST '/telegram/:token/sendContact' -H 'Content-Type: application/json' --input - <<'JSON'
{
"chat_id": 6442870329,
"phone_number": "+1234567890",
"first_name": "John",
"last_name": "Doe"
}
JSON
maton api -X POST '/telegram/:token/sendPoll' -H 'Content-Type: application/json' --input - <<'JSON'
{
"chat_id": 6442870329,
"question": "What is your favorite color?",
"options": [
{"text": "Red"},
{"text": "Blue"},
{"text": "Green"}
],
"is_anonymous": false
}
JSON
| Parameter | Type | Required | Description |
|---|---|---|---|
| chat_id | Integer/String | Yes | Target chat ID |
| question | String | Yes | Poll question (1-300 characters) |
| options | Array | Yes | Poll options (2-10 items) |
| is_anonymous | Boolean | No | Anonymous poll (default true) |
| type | String | No | regular or quiz |
| allows_multiple_answers | Boolean | No | Allow multiple answers |
| correct_option_id | Integer | No | Correct answer for quiz |
maton api -X POST '/telegram/:token/sendDice' -H 'Content-Type: application/json' --input - <<'JSON'
{
"chat_id": 6442870329,
"emoji": "🎲"
}
JSON
Supported emoji: 🎲 🎯 🎳 🏀 ⚽ 🎰
maton api -X POST '/telegram/:token/editMessageText' -H 'Content-Type: application/json' --input - <<'JSON'
{
"chat_id": 6442870329,
"message_id": 123,
"text": "Updated message text"
}
JSON
maton api -X POST '/telegram/:token/editMessageCaption' -H 'Content-Type: application/json' --input - <<'JSON'
{
"chat_id": 6442870329,
"message_id": 123,
"caption": "Updated caption"
}
JSON
maton api -X POST '/telegram/:token/editMessageReplyMarkup' -H 'Content-Type: application/json' --input - <<'JSON'
{
"chat_id": 6442870329,
"message_id": 123,
"reply_markup": {
"inline_keyboard": [
[{"text": "New Button", "callback_data": "new"}]
]
}
}
JSON
maton api -X POST '/telegram/:token/deleteMessage' -H 'Content-Type: application/json' --input - <<'JSON'
{
"chat_id": 6442870329,
"message_id": 123
}
JSON
maton api -X POST '/telegram/:token/forwardMessage' -H 'Content-Type: application/json' --input - <<'JSON'
{
"chat_id": 6442870329,
"from_chat_id": 6442870329,
"message_id": 123
}
JSON
maton api -X POST '/telegram/:token/copyMessage' -H 'Content-Type: application/json' --input - <<'JSON'
{
"chat_id": 6442870329,
"from_chat_id": 6442870329,
"message_id": 123
}
JSON
maton api -X POST '/telegram/:token/getChat' -H 'Content-Type: application/json' --input - <<'JSON'
{
"chat_id": 6442870329
}
JSON
maton api -X POST '/telegram/:token/getChatAdministrators' -H 'Content-Type: application/json' --input - <<'JSON'
{
"chat_id": -1001234567890
}
JSON
maton api -X POST '/telegram/:token/getChatMemberCount' -H 'Content-Type: application/json' --input - <<'JSON'
{
"chat_id": -1001234567890
}
JSON
maton api -X POST '/telegram/:token/getChatMember' -H 'Content-Type: application/json' --input - <<'JSON'
{
"chat_id": -1001234567890,
"user_id": 6442870329
}
JSON
maton api -X POST '/telegram/:token/setMyCommands' -H 'Content-Type: application/json' --input - <<'JSON'
{
"commands": [
{"command": "start", "description": "Start the bot"},
{"command": "help", "description": "Get help"},
{"command": "settings", "description": "Open settings"}
]
}
JSON
maton api '/telegram/:token/getMyCommands'
maton api -X POST '/telegram/:token/deleteMyCommands' -H 'Content-Type: application/json' --input - <<'JSON'
{}
JSON
maton api '/telegram/:token/getMyDescription'
maton api -X POST '/telegram/:token/setMyDescription' -H 'Content-Type: application/json' --input - <<'JSON'
{
"description": "This bot helps you manage tasks."
}
JSON
maton api -X POST '/telegram/:token/setMyName' -H 'Content-Type: application/json' --input - <<'JSON'
{
"name": "Task Bot"
}
JSON
maton api -X POST '/telegram/:token/getFile' -H 'Content-Type: application/json' --input - <<'JSON'
{
"file_id": "AgACAgQAAxkDAAM..."
}
JSON
Response:
{
"ok": true,
"result": {
"file_id": "AgACAgQAAxkDAAM...",
"file_unique_id": "AQAD27ExGysnfVBy",
"file_size": 7551,
"file_path": "photos/file_0.jpg"
}
}
Download files from the api.telegram.org/file/bot<token>/<file_path> path
maton api -X POST '/telegram/:token/answerCallbackQuery' -H 'Content-Type: application/json' --input - <<'JSON'
{
"callback_query_id": "12345678901234567",
"text": "Button clicked!",
"show_alert": false
}
JSON
All Telegram Bot API responses follow this format:
Success:
{
"ok": true,
"result": { ... }
}
Error:
{
"ok": false,
"error_code": 400,
"description": "Bad Request: chat not found"
}
:token is automatically replaced with your bot token from the connectionThe CLI above is this skill's documented path; the SDKs are an optional way to call the same gateway from application code. The two modes keep separate credential stores: the CLI uses the profile from maton login, while an SDK program signs in once with login(), which opens a browser and stores a session that Maton() reads. Telegram Bot API has no typed accessor yet, so calls go through the api passthrough, which takes the app and the path after it.
Python
pip install maton-ai
from maton_ai import Maton, login
# login()
maton = Maton()
# maton = Maton(api_key="...")
result = maton.api.get("telegram", "/:token/getMe")
JavaScript
npm install @maton/sdk
import { Maton, login } from "@maton/sdk";
// await login()
const maton = new Maton();
// const maton = new Maton({ apiKey: "..." });
const result = await maton.api.get("telegram", "/:token/getMe");
| Status | Meaning |
|---|---|
| 400 | Missing Telegram Bot connection |
| 401 | Invalid, missing, or expired Maton credential |
| 429 | Rate limited (10 requests/second per account) |
| 500 | Internal Server Error |
| 4xx/5xx | Passthrough error from the Telegram Bot API |
Errors from Telegram Bot are passed through with their original status codes and response bodies.
maton whoami --json
"authenticated": false — login again with maton login --oauth."auth_type": "api_key" — prefer maton login --oauth so no long-lived key sits on the machine.maton whoami is the check.Then confirm the app is connected:
maton connection list telegram --status ACTIVE
Paths passed to maton api must start with /telegram/:
maton api '/telegram/:token/getMe'maton api '/:token/getMe'A 500 may mean the Telegram Bot authorization expired. With the user's approval, create a new connection (maton connection create telegram) and complete authorization; once it is ACTIVE, delete the stale connection so the gateway uses the new one.
maton api.--paginate walks every page and -q/--jq trims the response before it reaches you. On typed commands, --jq requires --json.maton api; Host and Authorization are set by the gateway.Everything above uses the CLI, which holds the credential itself and never exposes it to the caller. Use the raw HTTP form below only where the CLI cannot be installed — a locked-down container, a CI step, a sandbox with no package manager. If maton is available, maton api does the same job without handling a secret.
Calling api.maton.ai directly means holding a long-lived Maton API key in the process environment, where it is readable by every child process and easy to leak into logs, crash dumps, shell history, and pasted output. Handle it accordingly:
[ -n "$MATON_API_KEY" ] && echo "MATON_API_KEY is set" || echo "MATON_API_KEY is not set"
.env, or a script makes it permanent. Let the environment that starts the session supply it — a CI secret store, a container secret, a secrets manager.ps output and shell history. Read it from the environment inside the process that makes the request, as below.api.maton.ai. It is not a credential for Telegram Bot or any other third-party host.The request is a plain HTTPS call to host api.maton.ai at path /telegram/{native-api-path} with a bearer token; the gateway swaps in the connected app's credential. Add a Maton-Connection: {connection_id} header to pin a specific connection when the account has more than one. Query values must be URL-encoded. The Python standard library is enough — the key is read from the environment inside the process, so it never appears on a command line:
python3 - <<'PY'
import json, os, urllib.request
GATEWAY = "https://api.maton.ai"
req = urllib.request.Request(GATEWAY + "/telegram/:token/getMe")
req.add_header("Authorization", "Bearer " + os.environ["MATON_API_KEY"])
req.add_header("User-Agent", "maton-telegram-skill/1.2")
# req.add_header("Maton-Connection", "{connection_id}")
with urllib.request.urlopen(req) as resp:
print(json.dumps(json.load(resp), indent=2))
PY
For a write, set method="POST" (or PUT/DELETE) on the Request, pass the JSON-encoded body as data=, and add a Content-Type: application/json header.
The same rules as the CLI apply to every request made this way: read-only calls first, and explicit user confirmation before any POST, PUT, PATCH, or DELETE.
The example prints the whole response body only to show the call working. Responses can carry personal data — names, email addresses, phone numbers, message and document contents — so extract just the fields the task needs instead of dumping the full payload, and do not write raw responses into logs, files, or anywhere the user has not asked for them.