OfferingsResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-communication-services/json-schema/microsoft-azure-communication-services-offerings-response-schema.json",
  "title": "OfferingsResponse",
  "description": "Represents a wrapper around a list of offerings.",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/microsoft-azure-communication-services-browse-for-available-countries-cities-and-area-codes-api-openapi.yml#/components/schemas/OfferingsResponse",
  "type": "object",
  "properties": {
    "phoneNumberOfferings": {
      "description": "Represents the underlying list of offerings.",
      "type": "array",
      "items": {
        "$ref": "#/$defs/PhoneNumberOffering"
      }
    },
    "nextLink": {
      "description": "Represents the URL link to the next page.",
      "type": "string"
    }
  },
  "$defs": {
    "PhoneNumberCapabilities": {
      "description": "Capabilities of a phone number.",
      "required": [
        "calling",
        "sms"
      ],
      "type": "object",
      "properties": {
        "calling": {
          "description": "Capability value for calling.",
          "enum": [
            "none",
            "inbound",
            "outbound",
            "inbound+outbound"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "PhoneNumberCapabilityType",
            "modelAsString": true
          }
        },
        "sms": {
          "description": "Capability value for SMS.",
          "enum": [
            "none",
            "inbound",
            "outbound",
            "inbound+outbound"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "PhoneNumberCapabilityType",
            "modelAsString": true
          }
        }
      }
    },
    "PhoneNumberCost": {
      "description": "The incurred cost for a single phone number.",
      "required": [
        "amount",
        "billingFrequency",
        "currencyCode"
      ],
      "type": "object",
      "properties": {
        "amount": {
          "format": "double",
          "description": "The cost amount.",
          "type": "number"
        },
        "currencyCode": {
          "description": "The ISO 4217 currency code for the cost amount, e.g. USD.",
          "type": "string"
        },
        "billingFrequency": {
          "description": "The frequency with which the cost gets billed.",
          "enum": [
            "monthly"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "BillingFrequency",
            "modelAsString": true
          }
        }
      }
    },
    "PhoneNumberOffering": {
      "description": "Represents a phone number capability offering",
      "required": [
        "cost"
      ],
      "type": "object",
      "properties": {
        "phoneNumberType": {
          "description": "Represents the number type of the offering.",
          "enum": [
            "geographic",
            "tollFree",
            "mobile"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "PhoneNumberType",
            "modelAsString": true
          }
        },
        "assignmentType": {
          "description": "Represents the assignment type of the offering.",
          "enum": [
            "person",
            "application"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "PhoneNumberAssignmentType",
            "modelAsString": true
          }
        },
        "availableCapabilities": {
          "$ref": "#/$defs/PhoneNumberCapabilities"
        },
        "cost": {
          "$ref": "#/$defs/PhoneNumberCost"
        }
      }
    }
  }
}