Request Phone Number Purchase
request_number_purchaseBuy a specific available phone number for the business from the phone carrier, with the owner's confirmed approval. The carrier bills the number to the business right away. Available numbers come from search_available_numbers. Optionally connects it to agent_id. Returns needs_user_input, needs_approval, pending_approval, executed, denied or unsupported; only executed means the change was made.
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_number": "<phone_number>",
"idempotency_key": "<idempotency_key>"
},
"name": "request_number_purchase"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| actor | No | Do not set. Kept for older clients; the signed-in connection identifies you. | |
| reason | No | Why the change is being made; kept in the audit log. | |
| dry_run | No | Check access, inputs and approval without making the change. | |
| agent_id | No | Optional: the agent that answers the number. | |
| authority | No | Do not set. It cannot approve a change: the owner approves through review_url or by being signed in. | |
| source_ref | No | Optional reference for the request, such as a ticket or automation run ID. | |
| business_id | No | Business ID. Required when the token can reach more than one business. | |
| phone_number | Yes | The number to buy (E.164), from search_available_numbers. | |
| idempotency_key | Yes | Required to make the change. Repeating a key returns the first outcome instead of running the change again. | |
| queue_for_approval | No | When approval is missing, create a pending approval the owner can accept in the dashboard instead of returning needs_approval. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| code | No | ||
| error | No | Present when success is false | |
| intent | No | ||
| result | No | ||
| status | No | ||
| message | No | ||
| success | Yes | Whether the tool completed successfully | |
| summary | No | ||
| approval | No | ||
| request_id | No | ||
| risk_level | No | ||
| business_id | No | ||
| missing_fields | No |