Requirements

List all requirements

Changed on

List all requirements with filtering, sorting, and pagination

get/requirements

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/requirements
  • Auth: HTTP bearer

Query parameters

country_codestring

Filters results to those applying to a 2-character (ISO 3166-1 alpha-2) country code

phone_number_type'local' | 'mobile' | 'multipurpose' | 'national' | 'shared_cost' | 'toll_free'

Filters results to those applying to a specific phone_number_type

action'branded_calling' | 'ordering' | 'porting'

Filters requirements to those applying to a specific action.

Consolidated filter parameter for requirements (deepObject style). Originally: filter[country_code], filter[phone_number_type], filter[action]

{
  "country_code": "US",
  "phone_number_type": "local",
  "action": "porting"
}
sortstring[]

Specifies the sort order for results. If you want to sort by a field in ascending order, include it as a sort parameter. If you want to sort in descending order, prepend a - in front of the field name.

Consolidated sort parameter for requirements (deepObject style). Originally: sort[]

[
  "country_code"
]
sizeinteger

The size of the page

numberinteger

The page number to load

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

versioninteger

Filter by requirement version number. When omitted, returns the currently-active version.

Response

Successful response

Example response

{
  "data": [
    {
      "record_type": "requirement",
      "country_code": "FR",
      "locality": "Nice",
      "phone_number_type": "local",
      "action": "ordering",
      "requirement_types": [
        {
          "acceptance_criteria": {
            "time_limit": "Current and not expired",
            "locality_limit": "Issued by the same country that the phone number belongs to",
            "acceptable_values": [
              "US"
            ],
            "max_length": 20,
            "min_length": 16,
            "acceptable_characters": "abcdef0123456789"
          },
          "description": "Proves the customer has a physical address in the same locality as the phone number",
          "example": "Utility bill, internet bill, phone bill, or lease",
          "type": "document",
          "name": "Proof of Address",
          "record_type": "requirement_type",
          "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
          "created_at": "2021-04-09T22:25:27.521Z",
          "updated_at": "2021-04-12T20:20:20.020Z"
        }
      ],
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "created_at": "2021-04-09T22:25:27.521Z",
      "updated_at": "2021-04-12T20:20:20.020Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

Changes

  • 19db5ee4ec59Revision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

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

    • info

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

  • da303e40b51eRevision changes
    • warning

      added the new mobile enum value to the // response property for the response status

    • warning

      added the new multipurpose enum value to the // response property for the response status

    • warning

      added the new shared_cost enum value to the // response property for the response status

    • info

      added the enum value mobile to the property phone_number_type of the query request parameter filter

    • info

      added the enum value multipurpose to the property phone_number_type of the query request parameter filter

    • info

      added the enum value shared_cost to the property phone_number_type of the query request parameter filter