Start capturing a chat
start_captureDeprecated: start_live_capture starts a chat's new messages from today and replaces this tool when no history is asked for. Start capturing one chat from a connected WhatsApp number. By default it starts from today, exactly as before. After start_history_preview returns ready, it can instead include one history option only when you echo that estimate's id, date, transcription choice and exact price after showing them to the user and getting explicit agreement. A user who will not wait for an estimate can instead ask for the chat's earlier history with all_history, which takes no quote. On a number the wallet funds, that is the chat's whole available history, billed as it arrives until the wallet runs out, at which point capture pauses until funds are added. New messages land in a Werify conversation as they arrive and are metered against the user's wallet. A positive balance is enough; auto-topup with a card is the other funding option. One chat per call, named as list_capturable_chats returns it: by its chat_id, its contact_phone or its name as chat_name. A new account starts with free capture: its first chats on one number capture at no charge, for a limited time. Every other capture, and every capture once free capture ends, is paid from the account's balance or by that number's subscription. list_connected_numbers says what funds each number, and what to tell the user, in its funding_note. 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": {
"phone": "<phone>"
},
"name": "start_capture"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| phone | Yes | The connected number, from list_connected_numbers. | |
| chat_id | No | The chat to capture, by the chat_id list_capturable_chats returns for it. Pass exactly one of chat_id, contact_phone and chat_name. | |
| chat_jid | No | Deprecated and removed in a later version: name the chat by chat_id, contact_phone or chat_name instead. | |
| chat_name | No | The chat to capture, by its name exactly as list_capturable_chats returns it. When two chats share the name, the call is refused with both and their chat_ids. Pass exactly one of chat_id, contact_phone and chat_name. | |
| transcribe | No | Transcribe voice notes (default false), including selected history when requested. Billed per audio minute. | |
| all_history | No | Default false. Brings this chat's earlier history with no quote. How much arrives depends on what funds the number, as this tool's description says. On a number the wallet funds it is the chat's whole available history, billed to the wallet as it arrives until the balance runs out — capture on the number then pauses until funds are added, so suggest auto-topup. Set it true only after the user explicitly agreed to what it brings and what it draws on. Cannot be combined with include_history. | |
| estimate_id | No | Required when include_history is true: the id returned by start_history_preview. | |
| contact_phone | No | The chat to capture, when it is a 1:1: the other party's number in E.164, as list_capturable_chats returns it. Pass exactly one of chat_id, contact_phone and chat_name. | |
| include_history | No | Default false. Set true only after showing one ready estimate history option and getting explicit agreement. | |
| history_from_date | No | When include_history is true: the selected option's exact YYYY-MM-DD. Omit/null only for all available measured history. | |
| quoted_history_cents | No | Required when include_history is true: echo the exact cents price shown for the same date and transcription choice. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| chat_name | No | The chat's name; null when the phone sent none. | |
| transcribe | No | Whether voice notes arriving from now on are transcribed. | |
| all_history | No | True when this call started an all-history capture with no quote (all_history: true). | |
| history_hint | No | What to do next about the chat's earlier history. | |
| captures_from | No | The local day the capture starts from (YYYY-MM-DD). For an all-history capture this is today: how far back it reaches is the phone's to decide. | |
| contact_phone | No | The 1:1's other party in E.164; null for a chat with no number, as a group. | |
| conversation_id | No | The conversation the capture feeds — the id the read tools take. | |
| conversation_url | No | ||
| history_included | No | True only when this call started capture with the explicitly agreed history option. | |
| already_capturing | No | True when this chat was already being captured; nothing changed. |