{
  "opencollection": "1.0.0",
  "info": {
    "name": "Telnyx Access Tokens Phone Number Configurations API",
    "version": "2.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Phone Number Configurations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List phone numbers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/phone_numbers",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Specifies the sort order for results. If not given, results are sorted by created_at in descending order."
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "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]"
              },
              {
                "name": "handle_messaging_profile_error",
                "value": "",
                "type": "query",
                "description": "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."
              }
            ]
          },
          "docs": "List phone numbers"
        },
        {
          "info": {
            "name": "Verify ownership of phone numbers",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/phone_numbers/actions/verify_ownership",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Verifies ownership of the provided phone numbers and returns a mapping of numbers to their IDs, plus a list of numbers not found in the account."
        },
        {
          "info": {
            "name": "Slim List phone numbers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/phone_numbers/slim",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]"
              },
              {
                "name": "include_connection",
                "value": "",
                "type": "query",
                "description": "Include the connection associated with the phone number."
              },
              {
                "name": "include_tags",
                "value": "",
                "type": "query",
                "description": "Include the tags associated with the phone number."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Specifies the sort order for results. If not given, results are sorted by created_at in descending order."
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "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]"
              }
            ]
          },
          "docs": "List phone numbers, This endpoint is a lighter version of the /phone_numbers endpoint having higher performance and rate limit."
        },
        {
          "info": {
            "name": "List phone numbers with voice settings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/phone_numbers/voice",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Specifies the sort order for results. If not given, results are sorted by created_at in descending order."
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Consolidated filter parameter (deepObject style). Originally: filter[phone_number], filter[connection_name], filter[customer_reference], filter[voice.usage_payment_method]"
              }
            ]
          },
          "docs": "List phone numbers with voice settings"
        },
        {
          "info": {
            "name": "Retrieve a phone number",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/phone_numbers/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the resource."
              }
            ]
          },
          "docs": "Retrieve a phone number"
        },
        {
          "info": {
            "name": "Update a phone number",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.telnyx.com/v2/phone_numbers/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the resource."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a phone number"
        },
        {
          "info": {
            "name": "Delete a phone number",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.telnyx.com/v2/phone_numbers/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the resource."
              }
            ]
          },
          "docs": "Delete a phone number"
        },
        {
          "info": {
            "name": "Change the bundle status for a phone number (set to being in a bundle or remove from a bundle)",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.telnyx.com/v2/phone_numbers/:id/actions/bundle_status_change",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the resource."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Change the bundle status for a phone number (set to being in a bundle or remove from a bundle)"
        },
        {
          "info": {
            "name": "Enable emergency for a phone number",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/phone_numbers/:id/actions/enable_emergency",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the resource."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Enable emergency for a phone number"
        },
        {
          "info": {
            "name": "Retrieve a phone number with voice settings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/phone_numbers/:id/voice",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the resource."
              }
            ]
          },
          "docs": "Retrieve a phone number with voice settings"
        },
        {
          "info": {
            "name": "Update a phone number with voice settings",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.telnyx.com/v2/phone_numbers/:id/voice",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the resource."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a phone number with voice settings"
        }
      ]
    }
  ],
  "bundled": true
}