Get Chat
telegram.get_chat
ActionChat & messagingconnection required
Calls the Telegram API with the connection's credentials.
Read up-to-date information about a chat, group or channel.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Telegram
- Secret shape
- the bot token, or {"token": "…"}
- Resolved by
- config.connection_id, else node.connection_id
Configuration
1 field, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
chat_id The chat to read: a numeric chat/user id, or an @channelusername. | string | Yes | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
ok True when Telegram accepted the call. | boolean | true |
id Numeric chat id. | number | — |
type One of private, group, supergroup or channel. | string | — |
title Title, for groups, supergroups and channels. | string | — |
username Public @username, when the chat has one. | string | — |
chat The full ChatFullInfo object, as returned. | object | — |
{
"chat": {},
"id": 0,
"ok": true,
"title": "",
"type": "",
"username": ""
}Notes
- chat_id is a numeric chat/user id or an @channelusername. A bot can only message a user who started it, or a group/channel it has been added to.
- The bot token sits in the request URL, so it is redacted out of every error message and dry-run report these nodes produce.
- Telegram answers HTTP 200 even for failures; the node reads the {'ok': …} envelope and raises on ok:false with Telegram's own description.
See Get Chat run in a workflow.
In a technical demo we add the Telegram connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.