Bandwidth · Schema

OrderResponse

Response containing order details

CommunicationsCPaaSVoiceMessagingTelephonySMSMFA

Properties

Name Type Description
orderId string The unique identifier for the order
orderStatus string The current status of the order
orderCreateDate string The date and time the order was created
completedQuantity integer Number of phone numbers successfully ordered
failedQuantity integer Number of phone numbers that failed to order
completedNumbers array List of successfully ordered phone numbers
View JSON Schema on GitHub

JSON Schema

phone-numbers-order-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/bandwidth/refs/heads/main/json-schema/phone-numbers-order-response-schema.json",
  "title": "OrderResponse",
  "description": "Response containing order details",
  "type": "object",
  "properties": {
    "orderId": {
      "type": "string",
      "description": "The unique identifier for the order"
    },
    "orderStatus": {
      "type": "string",
      "enum": [
        "RECEIVED",
        "PROCESSING",
        "COMPLETE",
        "PARTIAL",
        "FAILED"
      ],
      "description": "The current status of the order"
    },
    "orderCreateDate": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time the order was created"
    },
    "completedQuantity": {
      "type": "integer",
      "description": "Number of phone numbers successfully ordered"
    },
    "failedQuantity": {
      "type": "integer",
      "description": "Number of phone numbers that failed to order"
    },
    "completedNumbers": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of successfully ordered phone numbers"
    }
  }
}