InexplicitNumberOrderRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/telnyx/main/json-schema/telnyx-inexplicit-number-order-request-schema.json",
  "title": "InexplicitNumberOrderRequest",
  "x-generated": "2026-10-08",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-inexplicit-number-orders-api-openapi.yml#/components/schemas/InexplicitNumberOrderRequest",
  "properties": {
    "billing_group_id": {
      "description": "Billing group id to apply to phone numbers that are purchased",
      "type": "string"
    },
    "connection_id": {
      "description": "Connection id to apply to phone numbers that are purchased",
      "type": "string"
    },
    "customer_reference": {
      "description": "Reference label for the customer",
      "type": "string"
    },
    "messaging_profile_id": {
      "description": "Messaging profile id to apply to phone numbers that are purchased",
      "type": "string"
    },
    "ordering_groups": {
      "description": "Group(s) of numbers to order. You can have multiple ordering_groups objects added to a single request.",
      "items": {
        "properties": {
          "administrative_area": {
            "description": "Filter for phone numbers in a given state / province",
            "type": "string"
          },
          "count_requested": {
            "description": "Quantity of phone numbers to order",
            "type": "string"
          },
          "country_iso": {
            "description": "Country where you would like to purchase phone numbers. Allowable values: US, CA",
            "enum": [
              "US",
              "CA"
            ],
            "type": "string"
          },
          "exclude_held_numbers": {
            "description": "Filter to exclude phone numbers that are currently on hold/reserved for your account.",
            "type": "boolean"
          },
          "features": {
            "description": "Filter for phone numbers that have the features to satisfy your use case (e.g., [\"voice\"])",
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "locality": {
            "description": "Filter for phone numbers in a given city / region / rate center",
            "type": "string"
          },
          "national_destination_code": {
            "description": "Filter by area code",
            "type": "string"
          },
          "phone_number": {
            "description": "Phone number search criteria",
            "properties": {
              "contains": {
                "description": "Filter for phone numbers that contain the digits specified",
                "type": "string"
              },
              "ends_with": {
                "description": "Filter by the ending digits of the phone number",
                "type": "string"
              },
              "starts_with": {
                "description": "Filter by the starting digits of the phone number",
                "type": "string"
              }
            },
            "type": "object"
          },
          "phone_number_type": {
            "description": "Number type (local, toll-free, etc.)",
            "type": "string"
          },
          "quickship": {
            "description": "Filter to exclude phone numbers that need additional time after to purchase to activate. Only applicable for +1 toll_free numbers.",
            "type": "boolean"
          },
          "strategy": {
            "default": "always",
            "description": "Ordering strategy. Define what action should be taken if we don't have enough phone numbers to fulfill your request. Allowable values are: always = proceed with ordering phone numbers, regardless of current inventory levels; never = do not place any orders unless there are enough phone numbers to satisfy the request. If not specified, the always strategy will be enforced.",
            "enum": [
              "always",
              "never"
            ],
            "type": "string"
          }
        },
        "required": [
          "country_iso",
          "count_requested",
          "phone_number_type"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "ordering_groups"
  ],
  "type": "object"
}