Skip to main content

Purchase a Phone Number

POST 
/phone_numbers

Purchase a number and add it to your project.

Permissions​

The API token must include the following scopes: Numbers.

Request​

Body

required

    number stringrequired

    The phone number in E164 format.

Responses​

OK

Schema

    id uuid

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

    number stringrequired

    The phone number in E164 format.

    name string

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

    call_handler string

    Possible values: [relay_script, relay_context, relay_topic, relay_application, laml_webhooks, laml_application, dialogflow, relay_connector, relay_sip_endpoint, relay_verto_endpoint, video_room]

    What type of handler you want to run on inbound calls.

    call_receive_mode string

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

    call_request_url string

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

    call_request_method string

    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

    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

    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

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

    call_status_callback_method string

    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

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

    call_dialogflow_agent_id string

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

    call_relay_topic string

    A string representing the Relay topic to forward incoming calls to. This is only used (and required) when call_handler is set to relay_topic. Alias of call_relay_application. If both are sent, call_relay_application takes precedence.

    call_relay_topic_status_callback_url string

    A string representing a URL to send status change messages to. This is only used when call_handler is set to relay_topic.

    call_relay_context string

    The name of the Relay Context to send this call to when using the relay_context call handler. Alias of message_relay_application. If both are sent, call_relay_application takes precedence.

    call_relay_context_status_callback_url string

    A string representing a URL to send status change messages to. This is only used (and required) when call_handler is set to relay_context.

    call_relay_application string

    The name of the Relay Application to send this call to when using the relay_application call handler. Alias of call_relay_context. If both are sent, call_relay_application takes precedence.

    call_relay_connector_id string

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

    call_sip_endpoint_id string

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

    call_verto_resource string

    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

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

    message_handler string

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

    message_request_url string

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

    message_request_method string

    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

    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

    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

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

    message_relay_topic string

    The name of the Relay Topic to send this message to when using the relay_topic message handler. Alias of message_relay_application. If both are sent, message_relay_application takes precedence.

    message_relay_context string

    The name of the Relay Context to send this message to when using the relay_context message handler. Alias of message_relay_application. If both are sent, message_relay_application takes precedence.

    message_relay_application string

    The name of the Relay Application to send this message to when using the relay_application message handler. Alias of message_relay_context. If both are sent, message_relay_application takes precedence.

    capabilities string[]

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

    number_type string

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

    e911_address_id string

    A list of communication methods this phone number supports.

    created_at date-time

    The date the number was added to your project.

    updated_at date-time

    The date the number was last updated.

    next_billed_at date-time

    The next date the number will be billed for.

Loading...