messagebird · Schema

AvailableNumber

Properties

Name	Type	Description
number	string	The available phone number in E.164 format.
country	string	The two-letter country code.
region	string	The region or city for the number.
locality	string	The locality for the number.
features	array	The features supported by the number.
type	string	The type of phone number.
initialContractDuration	integer	The initial contract duration in months.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AvailableNumber",
  "title": "AvailableNumber",
  "type": "object",
  "properties": {
    "number": {
      "type": "string",
      "description": "The available phone number in E.164 format."
    },
    "country": {
      "type": "string",
      "description": "The two-letter country code."
    },
    "region": {
      "type": "string",
      "description": "The region or city for the number."
    },
    "locality": {
      "type": "string",
      "description": "The locality for the number."
    },
    "features": {
      "type": "array",
      "description": "The features supported by the number.",
      "items": {
        "type": "string",
        "enum": [
          "sms",
          "voice",
          "mms"
        ]
      }
    },
    "type": {
      "type": "string",
      "description": "The type of phone number.",
      "enum": [
        "landline",
        "mobile",
        "premium_rate",
        "toll_free"
      ]
    },
    "initialContractDuration": {
      "type": "integer",
      "description": "The initial contract duration in months."
    }
  }
}