list | SignalWire

List phone numbers owned by the project.

Query parameters

filter_namestringOptional

The name given to the phone number. Will return all Phone Numbers containing this value as a substring.

filter_numberstringOptional

The phone number in E164 format. Will return all Phone Numbers containing this value as a substring.

page_numberintegerOptionalDefaults to 0

The page number to retrieve (0-indexed).

page_sizeintegerOptional1-1000Defaults to 50

The number of items per page (1-1000).

page_tokenstringOptional

Token for cursor-based pagination. Required when page_number > 0.

Response

linksobjectRequired

Pagination links.

datalist of objectsRequired

List of phone numbers.

Response Example

Response

1 {
2   "links": {
3     "self": "string",
4     "first": "string",
5     "next": "string",
6     "prev": "string"
7   },
8   "data": [
9     {
10       "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
11       "number": "+15558675309",
12       "name": "Jenny",
13       "capabilities": [
14         "voice"
15       ],
16       "number_type": "toll-free",
17       "e911_address_id": "string",
18       "created_at": "2024-01-15T09:30:00Z",
19       "updated_at": "2024-01-15T09:30:00Z",
20       "next_billed_at": "2024-01-15T09:30:00Z",
21       "call_handler": "relay_context",
22       "calling_handler_resource_id": "fe4093d9-58c2-4931-b4b9-5679f82652c6",
23       "call_receive_mode": "voice",
24       "call_request_url": "string",
25       "call_request_method": "POST",
26       "call_fallback_url": "string",
27       "call_fallback_method": "POST",
28       "call_status_callback_url": "string",
29       "call_status_callback_method": "POST",
30       "call_laml_application_id": "string",
31       "call_dialogflow_agent_id": "string",
32       "call_relay_topic": "office",
33       "call_relay_topic_status_callback_url": "https://myapplication/handle_relay_callbacks",
34       "call_relay_script_url": "https://example.signalwire.com/relay-bins/60e2ba7b-366e-44de-84e3-0c76cfccf1cc",
35       "call_relay_context": "my_relay_app",
36       "call_relay_context_status_callback_url": "https://myapplication/handle_relay_callbacks",
37       "call_relay_application": "my_relay_app",
38       "call_relay_connector_id": "string",
39       "call_sip_endpoint_id": "string",
40       "call_verto_resource": "string",
41       "call_video_room_id": "fe4093d9-58c2-4931-b4b9-5679f82652c6",
42       "message_handler": "relay_application",
43       "messaging_handler_resource_id": "fe4093d9-58c2-4931-b4b9-5679f82652c6",
44       "message_request_url": "string",
45       "message_request_method": "POST",
46       "message_fallback_url": "string",
47       "message_fallback_method": "POST",
48       "message_laml_application_id": "string",
49       "message_relay_topic": "string",
50       "message_relay_context": "my_relay_app",
51       "country_code": "US"
52     }
53   ]
54 }

Example

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 result = client.phone_numbers.list(page_size=10)
10 for number in result.get("data", []):
11     print(number["number"], number.get("name"))