GramClaw API

Управляйте рассылками в Telegram из скриптов, ИИ-агентов или сервер Telegram MCP: ищите сообщения, управляйте CRM-воронкой, задавайте пользовательские столбцы и отправляйте сообщения, рассылки и кампании. Создайте ключ в Настройки → Ключи API.

Start with an outcome

Popular recipes

View all

Send your first Telegram message

Verify an API key, choose a connected Telegram account, and start a direct conversation by username.

5 minutes

Build an automated follow-up sequence

Create a personalized campaign with two timed follow-ups that stop automatically when a recipient replies.

10 minutes

Connect an AI agent through MCP

Give Claude Desktop, Cursor, or another MCP client controlled access to your GramClaw workspace.

10 minutes

Broadcast to a pipeline stage

Send a personalized update to the reachable contacts in one pipeline stage without assembling a contact list by hand.

7 minutes

Distribute a campaign across accounts

Queue a larger campaign across a controlled pool of Telegram accounts with per-account daily limits.

10 minutes

Find and qualify conversations

Search message history for buying signals, inspect the matching chats, and move relevant conversations into a pipeline stage.

8 minutes

Receive signed workspace events

15 minutes

Build a campaign performance report

Read workspace totals, compare recent campaigns, and inspect the recipients behind an unusual result.

6 minutes

Export a filtered inbox safely

Page through GramClaw's conversation store with an account or pipeline filter instead of requesting an unbounded inbox.

10 minutes

Аутентификация

Для каждого запроса нужен ключ API рабочего пространства в виде токена Bearer. Создайте его в Настройки → Ключи API — полный ключ ( gc_live_…) показывается один раз.

Базовый URL

https://gramclaw.com

Каждый запрос

Authorization: Bearer gc_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Быстрый старт

BASE="https://gramclaw.com"
KEY="gc_live_…"
curl -s "$BASE/api/v1/me" -H "Authorization: Bearer $KEY"

Обратите внимание: вызовы API выполняются напрямую — без шага подтверждения (в отличие от встроенного ИИ). Ключ — это авторизация; храните его как пароль. Ограничение частоты: 120 запросов / минуту на ключ, с заголовками X-RateLimit-* в каждом ответе. Ошибки возвращают { "error": "…" } со статусом 4xx/5xx.

Области доступа: ключи имеют read (чаты, сообщения, поиск, аналитика), write (воронка, столбцы, вебхуки), и/или send (сообщения, рассылки, кампании) — выберите их при создании ключа. POST-запросы отправки принимают заголовок Idempotency-Key , чтобы повторные попытки не приводили к двойной отправке.

Конечные точки

GET/api/v1/me— Verify key & list accountsобласть: read

Confirms a key works and returns the workspace plus the connected accounts it can act on (with account ids for broadcasting).

Ответ

{
  "workspace_id": "cbf805da-…",
  "key": { "name": "Claude MCP", "prefix": "gc_live_ab12cd34", "scopes": ["read","send"] },
  "accounts": [
    { "id": "acc_…", "provider": "Telegram", "type": "MESSAGING", "name": "…" }
  ]
}

GET/api/v1/chats— List conversationsобласть: read

The workspace's conversations newest-first, served from GramClaw's own store (fast — no provider calls). Cursor-paginated; filter by account, pipeline stage, or column value.

Поле	Тип	Примечания
cursor	string	from previous next_cursor
limit	number	default 50, max 100
account_id	string
stage_key	string	only chats in this stage
column_id	string	with column_value: only matching chats
column_value	string

Запрос

curl -s "$BASE/api/v1/chats?stage_key=qualified&limit=20" \
  -H "Authorization: Bearer $KEY"

Ответ

{
  "chats": [{ "id": "…", "name": "Sarah K", "provider": "TELEGRAM",
              "last_message_text": "…", "last_message_at": "…", "unread_count": 2 }],
  "next_cursor": "bzoyMA", "has_more": true
}

GET/api/v1/chats/{id}— Get one chatобласть: read

One chat enriched with its pipeline stage and custom-column values.

Ответ

{
  "chat": { "id": "…", "name": "Sarah K", "stage_key": "qualified",
            "columns": [{ "column_id": "…", "value": ["High"] }] }
}

GET/api/v1/chats/{id}/messages— Read message historyобласть: read

A chat's messages, oldest-first within the page. Pass `before` (ISO timestamp) to page older messages; the response's next_before feeds the next call.

Поле	Тип	Примечания
limit	number	default 30, max 100
before	string	ISO timestamp — messages older than this

Запрос

curl -s "$BASE/api/v1/chats/CHAT_ID/messages?limit=50" \
  -H "Authorization: Bearer $KEY"

Ответ

{
  "messages": [{ "id": "…", "text": "Hey!", "is_sender": false,
                 "timestamp": "2026-07-06T10:00:00Z", "attachments": [] }],
  "source": "db", "next_before": "2026-07-01T08:00:00Z"
}

POST/api/v1/chats/start— Start a new conversationобласть: send

Start (or find) a DM with someone by phone, @username, or provider id — including people never messaged before. Optionally sends a first message. Supports Idempotency-Key.

Поле	Тип	Примечания
account_id*	string	account to send from (see /me)
identifier*	string	phone, @username, or provider id
provider	string	hint: TELEGRAM, WHATSAPP, …
text	string	optional first message

Запрос

curl -s "$BASE/api/v1/chats/start" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"account_id":"acc_…","identifier":"@newlead","text":"Hi!"}'

Ответ

{ "chat": { "id": "…" } }

GET/api/v1/contacts— List contactsобласть: read

The workspace's contact cache (name + provider id per account). Cursor-paginated, searchable by name.

Поле	Тип	Примечания
cursor	string
limit	number	default 100, max 200
account_id	string
q	string	name search

Ответ

{
  "contacts": [{ "account_id": "…", "provider_id": "…", "name": "Sarah K" }],
  "next_cursor": null, "has_more": false
}

POST/api/v1/search— Search messages & email

Search connected platforms by people, keywords, and date range. Returns matching excerpts plus the chats they came from — use a returned chat_id with the move / message endpoints.

Поле	Тип	Примечания
people	string[]	Person names
keywords	string[]	Topic keywords (not names)
time_after	string	ISO date lower bound
time_before	string	ISO date upper bound
account_types	"messaging" \| "email" \| "all"	Default all

Запрос

curl -s "$BASE/api/v1/search" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"people":["Sarah"],"keywords":["invoice"]}'

Ответ

{
  "match_count": 3,
  "platforms_searched": ["Telegram", "Gmail"],
  "chats": [{ "chat_id": "…", "chat_name": "Sarah", "provider": "Telegram" }],
  "context": "### Sarah (Telegram) …"
}

GET/api/v1/pipeline— Get pipeline

The workspace's pipeline stages and which chats sit in each stage. Chats not in placements are in the default 'new' stage.

Ответ

{
  "stages": [{ "key": "new", "label": "New", "terminal": false }, …],
  "placements": [{ "chat_id": "…", "stage_key": "qualified" }]
}

POST/api/v1/pipeline/move— Move a chat to a stage

Move a chat into a pipeline stage.

Поле	Тип	Примечания
chat_id*	string
stage_key*	string	from GET /api/v1/pipeline

Запрос

curl -s "$BASE/api/v1/pipeline/move" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"chat_id":"…","stage_key":"qualified"}'

Ответ

{ "ok": true, "message": "Moved to **Qualified**." }

GET/api/v1/columns— List custom columns

The workspace's custom columns (tags) with ids, types, and allowed option values.

Ответ

{
  "columns": [
    { "id": "…", "name": "Priority", "type": "select",
      "options": [{ "value": "High", "color": "#f87171" }] }
  ]
}

POST/api/v1/columns/set— Set a column value

Set (or clear) a custom-column value on a chat. An empty value array clears it.

Поле	Тип	Примечания
column_id*	string	from GET /api/v1/columns
chat_id*	string
value*	string[]	empty clears

Запрос

curl -s "$BASE/api/v1/columns/set" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"column_id":"…","chat_id":"…","value":["High"]}'

Ответ

{ "ok": true, "message": "Set **Priority** = High." }

POST/api/v1/messages— Send a message

Send a single message to an existing chat.

Поле	Тип	Примечания
chat_id*	string
text*	string

Запрос

curl -s "$BASE/api/v1/messages" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"chat_id":"…","text":"Hi there!"}'

Ответ

{ "ok": true, "message": "Message sent." }

POST/api/v1/broadcast— Broadcast to an audience

Send one message to everyone in a pipeline stage or with a custom-column value. Supports {{name}} personalization. Capped at 30 recipients per call.

Поле	Тип	Примечания
account_id*	string	account to send from (see /me)
audience_type*	"stage" \| "column"
audience_ref*	string	stage_key, or column_id for column
column_value	string	required for column audiences
message_text*	string	may include {{name}}

Запрос

curl -s "$BASE/api/v1/broadcast" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"account_id":"acc_…","audience_type":"stage",
       "audience_ref":"qualified","message_text":"Hi {{name}}!"}'

Ответ

{ "ok": true, "message": "Broadcast sent to **12** recipients.",
  "recipients": 12, "audience_total": 12, "capped": false }

POST/api/v1/campaigns— Create a campaign (large sends)область: send

The API path for sends larger than broadcast's 30-recipient cap (max 5,000 contacts). GramClaw's background worker delivers every message — initial + optional follow-up steps — respecting per-account daily quotas. Supports Idempotency-Key. Also: GET /api/v1/campaigns lists campaigns; GET /api/v1/campaigns/{id} returns status + per-contact detail.

Поле	Тип	Примечания
name	string
account_id	string	or account_pool: string[] to rotate accounts
message_text*	string	may include {{name}}
contacts*	array	[{ name?, identifier, chat_id? }]
steps	array	follow-ups: [{ branch, wait_hours, variants[] }]
daily_quota_per_account	number	default 30

Запрос

curl -s "$BASE/api/v1/campaigns" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: launch-jul-06" \
  -d '{"account_id":"acc_…","message_text":"Hi {{name}}!",
       "contacts":[{"name":"Sarah","identifier":"@sarahk"}]}'

Ответ

{ "campaign": { "id": "…", "status": "queued" }, "queued": true }

GET/api/v1/analytics— Campaign analyticsобласть: read

Workspace campaign totals (sent, failed, replies, reply rate) plus the 50 most recent campaigns.

Ответ

{
  "totals": { "campaigns": 12, "sent": 452, "replies": 87, "reply_rate": 0.1925 },
  "campaigns": [ … ]
}

POST/api/v1/webhooks— Register a webhookобласть: write

Get pushed events instead of polling: message.received, message.edited, message.deleted, pipeline.moved, campaign.replied. Deliveries are signed (X-GramClaw-Signature: sha256=HMAC_SHA256(secret, body)); the secret is returned once at creation. GET lists endpoints; PATCH /api/v1/webhooks/{id} updates url/events/active; DELETE removes. Max 10 per workspace; 20 consecutive failures auto-disable an endpoint.

Поле	Тип	Примечания
url*	string	your HTTPS endpoint
events	string[]	omit or ["*"] for all events

Запрос

curl -s "$BASE/api/v1/webhooks" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/hooks/gramclaw",
       "events":["message.received","pipeline.moved"]}'

Ответ

{ "webhook": { "id": "…", "events": ["message.received","pipeline.moved"] },
  "secret": "whsec_…  ← shown once, signs every delivery" }

Подключение из Claude / Cursor (Telegram MCP)

Проще всего — удалённый коннектор (URL). В вашем MCP-клиенте добавьте пользовательский коннектор и вставьте персональный URL. Создайте ключ в Настройки → Ключи API, чтобы получить полный URL с вашим ключом. См. обзор Telegram MCP для списка инструментов.

Удалённый URL MCP

https://gramclaw.com/api/mcp?key=gc_live_…

Альтернатива — локальный сервер (Cursor или файл конфигурации Claude Desktop):

claude_desktop_config.json

{
  "mcpServers": {
    "gramclaw": {
      "command": "npx",
      "args": ["-y", "gramclaw-mcp"],
      "env": {
        "GRAMCLAW_API_KEY": "gc_live_…",
        "GRAMCLAW_BASE_URL": "https://gramclaw.com"
      }
    }
  }
}

Нужна помощь с настройкой? Откройте руководство по API и MCP.