Telegram Bot Integration

Field	Description	Required	Format
Telegram Bot Token	Your Telegram Bot token obtained from @BotFather	Yes	`-`

send_text_message — Send a text message to a Telegram chat. Supports Markdown, MarkdownV2, and HTML formatting.

Parameters

string

required

Unique identifier for the target chat or @username of the target channel

string

required

Text of the message (1-4096 characters)

string

Mode for parsing entities (‘Markdown’, ‘MarkdownV2’, or ‘HTML’)

boolean

Send silently with no sound (Default: false)

integer

ID of the message to reply to

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "SendTextMessageOutput",
  "type": "object"
}

send_photo — Send a photo to a Telegram chat. Photos can be sent by URL or file_id.

Parameters

string

required

Unique identifier for the target chat or @username of the target channel

string

required

Photo to send (file_id or HTTP URL)

string

Photo caption (0-1024 characters)

string

Mode for parsing entities (‘Markdown’, ‘MarkdownV2’, or ‘HTML’)

boolean

Send silently with no sound (Default: false)

integer

ID of the message to reply to

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "SendPhotoOutput",
  "type": "object"
}

send_document — Send a document or file to a Telegram chat.

Parameters

string

required

Unique identifier for the target chat or @username of the target channel

string

required

Document to send (file_id or HTTP URL)

string

Document caption (0-1024 characters)

string

Mode for parsing entities (‘Markdown’, ‘MarkdownV2’, or ‘HTML’)

boolean

Send silently with no sound (Default: false)

integer

ID of the message to reply to

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "SendDocumentOutput",
  "type": "object"
}

send_video — Send a video to a Telegram chat.

Parameters

string

required

Unique identifier for the target chat or @username of the target channel

string

required

Video to send (file_id or HTTP URL)

string

Video caption (0-1024 characters)

integer

Duration of sent video in seconds

string

Mode for parsing entities (‘Markdown’, ‘MarkdownV2’, or ‘HTML’)

boolean

Send silently with no sound (Default: false)

integer

ID of the message to reply to

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "SendVideoOutput",
  "type": "object"
}

send_audio — Send an audio file to a Telegram chat.

Parameters

string

required

Unique identifier for the target chat or @username of the target channel

string

required

Audio to send (file_id or HTTP URL)

string

Audio caption (0-1024 characters)

integer

Duration of the audio in seconds

string

Performer of the audio

string

Track name

boolean

Send silently (Default: false)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "SendAudioOutput",
  "type": "object"
}

forward_message — Forward a message from one chat to another.

Parameters

string

required

Unique identifier for the target chat or @username of the target channel

string

required

Chat where the original message was sent

integer

required

Message identifier in from_chat_id

boolean

Send silently (Default: false)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "ForwardMessageOutput",
  "type": "object"
}

edit_text_message — Edit a text message previously sent by the bot.

Parameters

string

required

Unique identifier for the target chat or @username of the target channel

integer

required

Identifier of the message to edit

string

required

New text of the message (1-4096 characters)

string

Mode for parsing entities

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "EditTextMessageOutput",
  "type": "object"
}

delete_message — Delete a message from a chat (messages older than 48 hours cannot be deleted).

Parameters

string

required

Unique identifier for the target chat or @username of the target channel

integer

required

Identifier of the message to delete

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "DeleteMessageOutput",
  "type": "object"
}

pin_message — Pin a message in a chat. Bot must be an administrator with can_pin_messages permission.

Parameters

string

required

Unique identifier for the target chat or @username of the target channel

integer

required

Identifier of the message to pin

boolean

Pin silently (Default: false)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "PinMessageOutput",
  "type": "object"
}

get_chat_member_count — Get the number of members in a chat.

Parameters

string

required

Unique identifier for the target chat or @username of the target channel

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetChatMemberCountOutput",
  "type": "object"
}

get_chat_administrators — Get a list of administrators in a chat with their permissions.

Parameters

string

required

Unique identifier for the target chat or @username of the target channel

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetChatAdministratorsOutput",
  "type": "object"
}

get_updates — Get incoming updates via long polling: messages, edited messages, channel posts, and other events.

Parameters

integer

Identifier of the first update to be returned

integer

Number of updates to retrieve (1-100) (Default: 100)

integer

Timeout in seconds for long polling (Default: 0)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetUpdatesOutput",
  "type": "object"
}

ban_chat_member — Ban a user from a group, supergroup, or channel. Bot must be an administrator.

Parameters

string

required

Unique identifier for the target chat or @username of the target channel

integer

required

Unique identifier of the target user

integer

Date when the user will be unbanned (Unix time)

boolean

Delete all messages from the chat for the user (Default: false)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "BanChatMemberOutput",
  "type": "object"
}

unban_chat_member — Unban a previously banned user.

Parameters

string

required

Unique identifier for the target chat or @username of the target channel

integer

required

Unique identifier of the target user

boolean

Do nothing if the user is not banned (Default: true)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "UnbanChatMemberOutput",
  "type": "object"
}

create_chat_invite_link — Create an additional invite link for a chat. Bot must have can_invite_users permission.

Parameters

string

required

Unique identifier for the target chat or @username of the target channel

string

Invite link name (0-32 characters)

integer

Unix timestamp when the link will expire

integer

Maximum number of users (1-99999)

boolean

Users joining need admin approval (Default: false)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateChatInviteLinkOutput",
  "type": "object"
}

get_chat — Get up-to-date information about a chat including title, description, photo, and settings.

Parameters

string

required

Unique identifier for the target chat or @username of the target channel

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetChatOutput",
  "type": "object"
}

get_me — Get basic information about the bot — its username, name, and capabilities.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetMeOutput",
  "type": "object"
}

​Overview

​Authentication

​Bot Token Authentication

​Required Credentials

​Available Actions

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Response

​Limits & Quotas

​Related integrations

Pinterest

Slack

WhatsApp

​Links

Overview

Authentication

Bot Token Authentication

Required Credentials

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Response

Limits & Quotas

Related integrations

Links