Stop measuring a chat's earlier history
stop_history_previewStop measuring a chat's earlier history when the user asks. Before the first page of a chat not captured yet, the measure is canceled and its allowance place returned (result: canceled); after it, or on a captured chat, it stops and keeps what it counted (result: stopped), and nothing more is asked of the phone. start_history_preview with continue: true resumes a stopped one. A chat with nothing measuring answers result: nothing_to_stop. Pass a list of up to 100 chat_ids to stop several. Name the chat as for start_history_preview; phone may be omitted when the user has a single number.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "stop_history_preview"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| phone | No | The connected number, from list_connected_numbers. Omit it when the user has a single connected number. | |
| chat_id | No | The chat, by the chat_id list_capturable_chats returns, or a list of 1–100 of them. Pass exactly one of chat_id, contact_phone and chat_name. | |
| chat_name | No | The chat, by its name exactly as list_capturable_chats returns it. Pass exactly one of chat_id, contact_phone and chat_name. | |
| contact_phone | No | The chat, when it is a 1:1: the other party's number in E.164. Pass exactly one of chat_id, contact_phone and chat_name. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | No | stopped | canceled | nothing_to_stop | |
| status | No | The measure's status after this call. | |
| results | No | Batch only: one per distinct chat_id, in input order. | |
| next_step | No | ||
| estimate_id | No | ||
| messages_seen | No | What the measure counted, when it counted any. | |
| reached_back_to | No | The earliest local day it reached. |