Sign in
Phone Number Configurations

List phone numbers

Returns phone numbers associated with the account. Results support pagination, sorting, and filters for number attributes, status, source, connections, billing groups, emergency addresses, tags, and customer references.

get/phone_numbers

Query parameters

numberinteger

The page number to load

sizeinteger

The size of the page

Consolidated page parameter (deepObject style). Originally: page[size], page[number]

sort'purchased_at' | 'phone_number' | 'connection_name' | 'usage_payment_method'
Example:connection_name

Specifies the sort order for results. If not given, results are sorted by created_at in descending order.

billing_group_idstring

Filter by the billing_group_id associated with phone numbers. To filter to only phone numbers that have no billing group associated them, set the value of this filter to the string 'null'.

connection_idstring

Filter by connection_id.

customer_referencestring

Filter numbers via the customer_reference set.

emergency_address_idstring

Filter by the emergency_address_id associated with phone numbers. To filter only phone numbers that have no emergency address associated with them, set the value of this filter to the string 'null'.

phone_numberstring

Filter by phone number. Requires at least three digits. Non-numerical characters will result in no values being returned.

source'ported' | 'purchased'

Filter phone numbers by their source. Use 'ported' for numbers ported from other carriers, or 'purchased' for numbers bought directly from Telnyx.

status'purchase-pending' | 'purchase-failed' | 'port-pending' | 'active' | 'deleted' | 'port-failed' | 'emergency-only' | 'ported-out' | 'port-out-pending'

Filter by phone number status.

tagstring

Filter by phone number tags.

voice.usage_payment_method'pay-per-minute' | 'channel'

Filter by usage_payment_method.

without_tags'true' | 'false'

When set to 'true', filters for phone numbers that do not have any tags applied. All other values are ignored.

Consolidated filter parameter (deepObject style). Originally: filter[tag], filter[phone_number], filter[status], filter[country_iso_alpha2], filter[connection_id], filter[voice.connection_name], filter[voice.usage_payment_method], filter[billing_group_id], filter[emergency_address_id], filter[customer_reference], filter[number_type], filter[source]

{
  "billing_group_id": "62e4bf2e-c278-4282-b524-488d9c9c43b2",
  "connection_id": "1521916448077776306",
  "country_iso_alpha2": "US",
  "emergency_address_id": "9102160989215728032",
  "status": "active",
  "voice.connection_name": {
    "contains": "test",
    "ends_with": "test",
    "eq": "test",
    "starts_with": "test"
  },
  "voice.usage_payment_method": "channel"
}
handle_messaging_profile_error'true' | 'false'
Example:false

Although it is an infrequent occurrence, due to the highly distributed nature of the Telnyx platform, it is possible that there will be an issue when loading in Messaging Profile information. As such, when this parameter is set to true and an error in fetching this information occurs, messaging profile related fields will be omitted in the response and an error message will be included instead of returning a 503 error.

Response

Successful response with a list of phone numbers.

Example response

{
  "data": [
    {
      "activated_at": "2019-10-23T18:10:00.000Z",
      "billing_group_id": "86f58db9-0fe3-4adc-9d1f-46e66e6e9323",
      "call_forwarding_enabled": true,
      "call_recording_enabled": true,
      "caller_id_name_enabled": true,
      "cnam_listing_enabled": true,
      "connection_id": "1293384261075731499",
      "connection_name": "connection-name",
      "country_iso_alpha2": "US",
      "created_at": "2019-10-23T18:10:00.000Z",
      "customer_reference": "customer-reference",
      "deletion_lock_enabled": false,
      "emergency_address_id": "1315261609962112019",
      "emergency_enabled": true,
      "emergency_status": "active",
      "external_pin": "1234",
      "hd_voice_enabled": true,
      "id": "1293384261075731499",
      "inbound_call_screening": "disabled",
      "messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600000000",
      "messaging_profile_name": "regional-customers",
      "phone_number": "+19705555098",
      "phone_number_type": "local",
      "purchased_at": "2019-10-23T18:10:00.000Z",
      "record_type": "phone_number",
      "source_type": "number_order",
      "status": "active",
      "t38_fax_gateway_enabled": true,
      "tags": [
        "tag_1",
        "tag_2"
      ],
      "updated_at": "2019-10-24T18:10:00.000Z"
    }
  ],
  "errors": [
    {
      "code": "10007",
      "detail": "An unexpected error occured.",
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      },
      "source": {
        "pointer": "/base"
      },
      "title": "Unexpected error"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

Changes

Changed in 4 of the 61 revisions of this API.20616

  • 1571b0380bd7155See the full diff
    • ▲

      the response property errors/items/code became optional for the status 400

      response-property-became-optional

    • ▲

      the response property errors/items/code became optional for the status 401

      response-property-became-optional

    • ▲

      the response property errors/items/code became optional for the status 404

      response-property-became-optional

    • ▲

      the response property errors/items/code became optional for the status 422

      response-property-became-optional

    • ▲

      the response property errors/items/code became optional for the status 500

      response-property-became-optional

    • ▲

      the response property errors/items/title became optional for the status 400

      response-property-became-optional

    • ▲

      the response property errors/items/title became optional for the status 401

      response-property-became-optional

    • ▲

      the response property errors/items/title became optional for the status 404

      response-property-became-optional

    • ▲

      the response property errors/items/title became optional for the status 422

      response-property-became-optional

    • ▲

      the response property errors/items/title became optional for the status 500

      response-property-became-optional

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 400

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 401

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 404

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 422

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 500

      response-property-type-changed

    • ○

      added the optional property errors/items/meta/url to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property errors/items/meta/url to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property errors/items/meta/url to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property errors/items/meta/url to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property errors/items/meta/url to the response with the 500 status

      response-optional-property-added

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8f5f4e5379945510See the full diff
    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 400

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 401

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 404

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 422

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 500

      response-property-type-changed

    • ●

      removed the optional property errors/items/meta/url from the response with the 400 status

      response-optional-property-removed

    • ●

      removed the optional property errors/items/meta/url from the response with the 401 status

      response-optional-property-removed

    • ●

      removed the optional property errors/items/meta/url from the response with the 404 status

      response-optional-property-removed

    • ●

      removed the optional property errors/items/meta/url from the response with the 422 status

      response-optional-property-removed

    • ●

      removed the optional property errors/items/meta/url from the response with the 500 status

      response-optional-property-removed

    • ○

      the response property errors/items/code became required for the status 400

      response-property-became-required

    • ○

      the response property errors/items/code became required for the status 401

      response-property-became-required

    • ○

      the response property errors/items/code became required for the status 404

      response-property-became-required

    • ○

      the response property errors/items/code became required for the status 422

      response-property-became-required

    • ○

      the response property errors/items/code became required for the status 500

      response-property-became-required

    • ○

      the response property errors/items/title became required for the status 400

      response-property-became-required

    • ○

      the response property errors/items/title became required for the status 401

      response-property-became-required

    • ○

      the response property errors/items/title became required for the status 404

      response-property-became-required

    • ○

      the response property errors/items/title became required for the status 422

      response-property-became-required

    • ○

      the response property errors/items/title became required for the status 500

      response-property-became-required

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • b1f7c46528b51See the full diff
    • ○

      added the optional property data/items/activated_at to the response with the 200 status

      response-optional-property-added

  • 224ed0d8a5c31See the full diff
    • ●

      removed the optional property data/items/activated_at from the response with the 200 status

      response-optional-property-removed

    This revision also has 111 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog