Capture a chat's earlier history
start_history_captureCapture a WhatsApp chat's earlier history, after the user picked an option start_history_preview served for that chat: pass that option's from_date, or "all". A date is accepted only if start_history_preview served it for this chat, at the quote it served; if the window moved since, the call is refused with the option as it stands now, to show the user and ask again. "all" over a measure that has not finished, or a chat never measured, brings all the history the phone has with no quote: on a number the wallet pays for it consumes the balance as it arrives and pauses when it runs out, so tell the user that first. Works on a chat not captured yet, one capturing, or one stopped. Without with_live_capture, new messages are left as they are: a chat not captured yet gets only its history. transcribe applies to this history and becomes the chat's voice-note choice, as on the web. Name the chat with chat_id, contact_phone or chat_name from list_capturable_chats; phone may be omitted when the user has a single number. On a number with a subscription, all_history brings the chat's whole available history too, included in the subscription. Under free capture it brings a sample of the chat's history rather than all of it, and history_hint says how much. If this tool answers an error whose code is currency_selection_required, the user has not confirmed the account's currency: show them the action_url and do not retry until they say it is done.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"from_date": "<from_date>"
},
"name": "start_history_capture"
}
}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. 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. | |
| from_date | Yes | The option's from_date (YYYY-MM-DD) as start_history_preview served it, or "all". | |
| transcribe | No | Transcribe this history's voice notes; default false. | |
| 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. | |
| with_live_capture | No | Also capture the chat's new messages from now on, as start_live_capture; default false. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | What happens next, to tell the user. | |
| declined | No | True when the confirmation form came back declined; nothing was captured. | |
| chat_name | No | ||
| from_date | No | The day the history brought in starts (YYYY-MM-DD); null for all history with no quote, and under free capture. | |
| funded_by | No | subscription | free_capture | wallet | |
| transcribe | No | The chat's voice-note choice after this call, for this history and the new messages. | |
| audio_count | No | Voice notes this history transcribes. | |
| message_count | No | Messages in the window; null when unmeasured. | |
| conversation_id | No | ||
| conversation_url | No | ||
| free_capture_sample | No | Under free capture: the sample that arrives instead of the window. | |
| capturing_new_messages | No | Whether the chat's new messages are captured after this call. |