Telegram Bot

Send messages, photos, and documents via a Telegram bot.

CommunicationAPI key7 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (7)
get_chat_member
send_media
send_text_message
create_invite_link
custom_api_call
get_file
request_approval_message
Details

Connect

Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("telegram_bot", "get_chat_member", {
    "chat_id": "<chat id>",
    "user_id": "<user id>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("Telegram Bot answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "telegram-bot-get-chat-member",
  name: "Telegram Bot: Get Chat Member",
  description: "Calls Telegram Bot when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("telegram_bot", {
      "action": "get_chat_member",
      "chat_id": "<chat id>",
      "user_id": "<user id>"
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/telegram_bot/get_chat_member" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"chat_id":"<chat id>","user_id":"<user id>"}}'

Actions

get_chat_memberin catalog

Get Chat Member. Get member info (or null) for provided chat id and user id

Input	Type	Description
`chat_id`required	text	Chat Id
`user_id`required	text	Unique identifier for the user

send_mediain catalog

Send Media. Send a media message through a Telegram bot

Input	Type	Description
`chat_id`required	text	Chat Id
`message_thread_id`optional	text	Unique identifier for the target message thread of the forums; for forums supergroups only
`media_type`optional	one of "photo" \| "video" \| "sticker" \| "animation"	Media Type
`media`optional	object (depends on other props)	Media Properties
`format`optional	one of "MarkdownV2" \| "HTML"	Choose format you want
`message`required	long text	The message to be sent
`reply_markup`optional	JSON	Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. Use special actions such…

send_text_messagein catalog

Send Text Message. Send a message through a Telegram bot

Input	Type	Description
`chat_id`required	text	Chat Id
`message_thread_id`optional	text	Unique identifier for the target message thread of the forums; for forums supergroups only
`format`optional	one of "MarkdownV2" \| "HTML"	Choose format you want
`web_page_preview`optional	boolean	Disable link previews for links in this message
`message`required	long text	The message to be sent
`reply_markup`optional	JSON	Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. Use special actions such…

create_invite_link

Create Invite Link. Create an invite link for a chat

Input	Type	Description
`chat_id`required	text	Chat Id
`name`optional	text	Name of the invite link (max 32 chars)
`expire_date`optional	date-time (ISO)	Point in time when the link will expire
`member_limit`optional	number	Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999

custom_api_call

Custom API Call. Make a custom API call to a specific endpoint

Input	Type	Description
`url`required	object (depends on other props)	url
`method`required	one of "GET" \| "POST" \| "PATCH" \| "PUT" \| "DELETE" \| "HEAD"	Method
`headers`required	object	Authorization headers are injected automatically from your connection.
`queryParams`required	object	Query Parameters
`body_type`optional	one of "none" \| "json" \| "form_data" \| "raw"	Body Type
`body`optional	object (depends on other props)	Body
`response_is_binary`optional	boolean	Enable for files like PDFs, images, etc.
`failsafe`optional	boolean	No Error on Failure
`timeout`optional	number	Timeout (in seconds)
`followRedirects`optional	boolean	Follow redirects

get_file

Get File. Get file information and download a file from Telegram

Input	Type	Description
`file_id`required	text	File identifier to get information about
`download`optional	boolean	If enabled, the file will be downloaded and returned as base64

request_approval_message

Request Approval Message. Send an approval message to a chat and wait until the message is approved or disapproved

Input	Type	Description
`chat_id`required	text	Chat Id
`message`required	long text	The approval message to be sent
`parse_mode`optional	one of "MarkdownV2" \| "HTML" \| "None"	Choose format for the message
`approve_button_text`optional	text	Text for the approve button
`disapprove_button_text`optional	text	Text for the disapprove button

Details

Id: telegram_bot
Category: Communication
Tags: chat, messaging, bot, telegram
Package: @activepieces/piece-telegram-bot@0.5.6
Tier: Built in