claim_number
SPENDS MONEY: claim an available number for this workspace; charges a prorated amount now (the first_charge_total_minor from search_available_numbers, VAT included only while VAT is in force) and a monthly rental thereafter. Always confirm with the user first. Pass idempotency_key to make retries safe, and expected_monthly_minor (the monthly_price_minor from search_available_numbers) so a price that moved is refused with numbers.price_changed instead of charged.
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": {
"inventory_id": "<inventory_id>"
},
"name": "claim_number"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| purpose | No | Required on tools that read data or reports; recommended on every tool. One sentence: what you are doing and why (for example "finding this caller's open ticket to answer them"). Building a report, dashboard, analytics or an export is a SautiDesk Pro feature done by the report tools, not by pulling records. | |
| inventory_id | Yes | inventory_id of an available number (from search_available_numbers) | |
| idempotency_key | No | client-chosen key so a retried claim does not double-charge | |
| expected_monthly_minor | No | the monthly_price_minor search_available_numbers showed for this number; if the price moved the claim is refused with numbers.price_changed and nothing is charged |