Phone Numbers

Search for available phone numbers, purchase them, and manage the numbers in your SignalWire project. This resource extends the standard CRUD pattern with a search() method for discovering available numbers, uses PUT for updates, and provides typed helpers for binding inbound calls to a handler (SWML webhook, cXML webhook, AI agent, call flow, RELAY application/topic).

Access via client.phone_numbers on a RestClient instance.

1
from signalwire.rest import RestClient
2
3
client = RestClient(
4
    project="your-project-id",
5
    token="your-api-token",
6
    host="your-space.signalwire.com",
7
)
8
9
available = client.phone_numbers.search(area_code="512")
10
for number in available.get("data", []):
11
    print(number["phone_number"])

Methods

Standard CRUD

Typed Binding Helpers

Each helper is a one-line wrapper over update that sets call_handler to the right value and populates the handler-specific companion field for you. Pass extra keyword arguments through to update for fields the helper doesn’t name explicitly. Setting a binding auto-materializes the matching Fabric resource on the server.

PhoneCallHandler enum

For callers passing call_handler directly to update, the PhoneCallHandler enum provides typed values. Each member is a str subclass, so passing the enum member serializes to the wire value without .value indirection.

1
from signalwire.rest import PhoneCallHandler
2
3
client.phone_numbers.update(
4
    "phone-number-id",
5
    call_handler=PhoneCallHandler.AI_AGENT,
6
    call_ai_agent_id="ai-agent-id",
7
)