Phone Numbers

List phone numbers

Changed on

Lists the phone numbers owned by your SignalWire project. These numbers can send or receive communications according to their capabilities and assigned handlers. Use Search phone numbers for numbers available to purchase, or Compatibility Incoming Phone Numbers for SID-based routes. Results are sorted by creation date, most recent first.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Numbers.

Learn more about API scopes.

get/api/relay/rest/phone_numbers

Request

  • Base URL
    https://{Your_Space_Name}.signalwire.com
  • URL
    https://{Your_Space_Name}.signalwire.com/api/relay/rest/phone_numbers
  • Auth
    HTTP basic

Query parameters

filter_namestring

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

filter_numberstring

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

page_numberinteger

The page number to retrieve (0-indexed).

page_sizeinteger

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

page_tokenstring

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

Response

The request has succeeded.

Example response

{
  "data": [
    {
      "number": "+15558675309",
      "name": "Jenny",
      "cnam": "ACME PLUMBING",
      "call_relay_topic": "office",
      "call_relay_topic_status_callback_url": "https://myapplication/handle_relay_callbacks",
      "call_relay_script_url": "https://example.signalwire.com/relay-bins/60e2ba7b-366e-44de-84e3-0c76cfccf1cc",
      "call_relay_context": "my_relay_app",
      "call_relay_context_status_callback_url": "https://myapplication/handle_relay_callbacks",
      "call_relay_application": "my_relay_app",
      "message_relay_context": "my_relay_app",
      "country_code": "US"
    }
  ]
}

Changes

  • 6a0a43b3e01eRevision changes
    • info

      added the required property // to the response with the status

  • dd526f1cd683Revision changes
    • info

      added to the // response property anyOf list for the response status

    • info

      removed subschema #1 from the // response property anyOf list for the response status

Some revisions have not been checked yet.