Reference
Scan a group
Scan a group's recent senders or member list with an account (counts against the scan limit).
View MarkdownThis page is generated from the source code on every release.
Scan a group's recent senders or member list with an account (counts against the scan limit).
Overview
| Name | Value |
|---|---|
| Code | scans.start |
| Scope needed | groups.scan |
| Risk | Write |
| May need confirmation | No |
| Runs as | Queues work for a node |
Needs Idempotency-Key |
No |
| Member roles allowed | owner, manager |
| In the app | Discover → Groups → Scan |
Input fields
| Field | Type | Required | Description |
|---|---|---|---|
groupId |
uuid |
Yes | |
accountId |
uuid |
Yes | |
mode |
"senders" | "members" |
Yes | |
force |
true/false |
No |
Example request
curl -X POST https://tlg.builera.app/api/public/v2/ops/scans.start \
-H "Authorization: Bearer $TELEGRAM_AUTO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"groupId":"00000000-0000-0000-0000-000000000000","accountId":"00000000-0000-0000-0000-000000000000","mode":"senders"}'Output fields (data)
| Field | Type | Required |
|---|---|---|
ok |
true |
Yes |
scanId |
text |
Yes |
Example answer
{
"data": {
"ok": true,
"scanId": "00000000-0000-4000-8000-000000000000"
}
}Using it over MCP
Tool scans_start is listed on the profiles: Discover (prospecting). On other profiles, find it with tools_search and run it with tools_run.