View as Markdown
Telegram icon

Telegram ACTION

Kick a Chat Member

Use this method to kick a user from a group, a supergroup or channel. See the docs for more information
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Telegram account once, then configure and run Kick a Chat Member from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "telegram_bot_api-kick-chat-member",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    telegram_bot_api: { authProvisionId: "apn_xxxxxxx" },
    chatId: "Chat ID",
    userId: "User ID",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Kick a Chat Member inputs
Property Type Description
chatId Chat ID string
Enter the unique identifier for the target chat (e.g. 1035597319) or username of the target public chat (in the format @channelusername or @supergroupusername). For example, if the group's public link is t.me/mygroup, the username is @mygroup.
Required
userId User ID string
Enter the unique identifier of the target user.
Optional
until_date Until Date string
Enter the date when the user will be unbanned, in unix time (e.g. 1567780450).
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
telegram_bot_api-kick-chat-member
Version
0.0.8
App
Telegram
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes