Title here
Summary here
Tools Reference
| Tool | Description | Side Effects |
|---|---|---|
list_countries | List available countries | Read-only |
list_services | List available services | Read-only |
order_number | Order a virtual phone number | Reserves balance |
check_sms | Check activation status / get SMS code | Read-only |
retry_activation | Request another SMS on same number | Free |
cancel_activation | Cancel activation, release number | Refunds balance |
list_countries
Returns available countries with their IDs. Use the country_id when calling order_number. IDs ending with _v indicate virtual numbers only.
Parameters: none
list_services
Returns available service categories with their IDs. Use the service_id when calling order_number. The other service covers categories not explicitly listed.
Parameters: none
order_number
Rent a virtual phone number for the given country and service. Returns a phone number and activation_id. Accepts human-readable names (“United States”, “Telegram”) — auto-resolved to IDs.
| Parameter | Type | Required | Description |
|---|---|---|---|
country | string | ✅ | Country name or ID (e.g. "United States", "us") |
service | string | ✅ | Service name or ID (e.g. "Telegram", "wa") |
max_price | integer | ❌ | Maximum price in USD cents. Protects against price changes. |
quality_factor | integer (0–100) | ❌ | 0 = cheapest, 50 = balanced (default), 100 = highest quality |
Use check_sms to poll for the SMS or check once on demand.
check_sms
Retrieve the current state of an activation — SMS text, parsed code, status, and expiration.
| Parameter | Type | Required | Description |
|---|---|---|---|
activation_id | string | ✅ | Activation ID returned by order_number |
retry_activation
Request an additional SMS on the same phone number. Free of charge. Only possible when is_retriable is true and activation is still active.
| Parameter | Type | Required | Description |
|---|---|---|---|
activation_id | string | ✅ | Activation ID to retry |
Use check_sms to poll for the new SMS or check once on demand.
cancel_activation
Cancel an active activation and release the phone number. The reserved amount is refunded. Only possible before SMS is received and after the cancelable_after timestamp has passed.
| Parameter | Type | Required | Description |
|---|---|---|---|
activation_id | string | ✅ | Activation ID to cancel |
Prev
Overview