View as Markdown
Telegram icon

Telegram ACTION

List Chats

List available Telegram chats. See the docs for more information
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Telegram account once, then configure and run List Chats 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-list-chats",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    telegram_bot_api: { authProvisionId: "apn_xxxxxxx" },
    offset: "Start offset (Update ID)",
    limit: 10,
  },
})

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.

List Chats inputs
Property Type Description
offset Start offset (Update ID) string
Enter the update ID <1, last update ID> you want to list from. Note: you can use this field to set your pagination - map last update ID from the result and increase this value by one to get next page.
Optional
limit Limit integer
Limits the number of updates to be retrieved <1-100>.
Optional
autoPaging Confirm processed requests by increasing the offset in the Telegram server [auto-paging] boolean
Check if to increasing the offset for the next request automatically. Caution: updates listed with auto-paging can be listed only once.
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-list-chats
Version
0.0.8
App
Telegram
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes