Skip to main content

Search for available Phone Numbers to Purchase

Returns a list of phone numbers available for purchase that match the given search criteria parameters.

Permissions

The API token must include the following scopes: Numbers.

Query Parameters
areacode string

An areacode to search within.

number_type string

Search for either local or toll-free numbers. Defaults to local.

starts_with string

A string of 3 to 7 digits that should be used as the start of a number. Cannot be used in combination with contains or ends_with.

contains string

A string of 3 to 7 digits that should appear somewhere in the number. Cannot be used in combination with starts_with or ends_with.

ends_with string

A string of 3 to 7 digits that should be used as the end of a number. Cannot be used in combination with starts_with or contains.

max_results number

The maximum number of matches to return. Upper limit of 100. Defaults to 50.

region string

A region or state to search within. Must be an ISO 3166-2 alpha-2 code, i.e. TX for Texas. Cannot be used in combination with areacode.

city string

A specific City to search within. Must be used in combination with region. Cannot be used in combination with areacode, starts_with, contains, or ends_with.

Responses
200

OK

Schema OPTIONAL
links object OPTIONAL
self string OPTIONAL
first string OPTIONAL
next string OPTIONAL
prev string OPTIONAL
data object[] OPTIONAL
id uuid OPTIONAL

The unique identifier of the Phone Number on SignalWire. This can be used to find, update or delete the phone number programmatically.

number string

The phone number in E164 format.

name string OPTIONAL

The name given to the phone number. Helps to distinguish different phone numbers within your project.

call_handler string OPTIONAL

What type of handler you want to run on inbound calls. Possible values are: relay_context, laml_webhooks, laml_application, dialogflow, relay_connector, relay_sip_endpoint, relay_verto_endpoint, video_room.

call_receive_mode string OPTIONAL

How do you want to receive the incoming call. Possible values are: voice or fax. Default is voice.

call_request_url string OPTIONAL

The URL to make a request to when using the laml_webhooks call handler.

call_request_method string OPTIONAL

The HTTP method to use when making a request to the call_request_url. Possible values are: POST or GET. Default is POST.

call_fallback_url string OPTIONAL

The fallback URL to make a request to when using the laml_webhooks call handler and the call_request_url fails.

call_fallback_method string OPTIONAL

The HTTP method to use when making a request to the call_fallback_url. Possible values are: POST or GET. Default is POST.

call_status_callback_url string OPTIONAL

The URL to make status callbacks to when using the laml_webhooks call handler.

call_status_callback_method string OPTIONAL

The HTTP method to use when making a request to the call_status_callback_url. Possible values are: POST or GET. Default is POST.

call_laml_application_id string OPTIONAL

The ID of the LaML Application to use when using the laml_application call handler.

call_dialogflow_agent_id string OPTIONAL

The ID of the Dialogflow Agent to start when using the dialogflow call handler.

call_relay_context string OPTIONAL

The name of the Relay Context to send this call to when using the relay_context call handler.

call_relay_connector_id string OPTIONAL

The ID of the Relay Connector to send this call to when using the relay_connector call handler.

call_sip_endpoint_id string OPTIONAL

The ID of the Relay SIP Endpoint to send this call to when using the relay_sip_endpoint call handler.

call_verto_resource string OPTIONAL

The name of the Verto Relay Endpoint to send this call to when using the relay_verto_endpoint call handler.

call_video_room_id uuid OPTIONAL

The ID of the Video Room to send this call to when using the video_room call handler.

message_handler string OPTIONAL

What type of handler you want to run on inbound messages. Possible values are: relay_context, laml_webhooks, laml_application.

message_request_url string OPTIONAL

The URL to make a request to when using the laml_webhooks message handler.

message_request_method string OPTIONAL

The HTTP method to use when making a request to the message_request_url. Possible values are: POST or GET. Default is POST.

message_fallback_url string OPTIONAL

The fallback URL to make a request to when using the laml_webhooks message handler and the message_request_url fails.

message_fallback_method string OPTIONAL

The HTTP method to use when making a request to the message_fallback_url. Possible values are: POST or GET. Default is POST.

message_laml_application_id string OPTIONAL

The ID of the LaML Application to use when using the laml_application message handler.

message_relay_context string OPTIONAL

The name of the Relay Context to send this message to when using the relay_context message handler.

capabilities string[] OPTIONAL

A list of communication methods this phone number supports. Possible values are: voice, fax, sms, mms.

number_type string OPTIONAL

The type of number this is defined as. Possible values are: toll-free or longcode.

e911_address_id string OPTIONAL

A list of communication methods this phone number supports.

created_at date-time OPTIONAL

The date the number was added to your project.

updated_at date-time OPTIONAL

The date the number was last updated.

next_billed_at date-time OPTIONAL

The next date the number will be billed for.