Bandwidth · JSON Structure

Phone Numbers Order Request Structure

Request to order phone numbers

Type: object Properties: 4
CommunicationsCPaaSVoiceMessagingTelephonySMSMFA

OrderRequest is a JSON Structure definition published by Bandwidth, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

name siteId peerId existingTelephoneNumberOrderType

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/bandwidth/refs/heads/main/json-structure/phone-numbers-order-request-structure.json",
  "name": "OrderRequest",
  "description": "Request to order phone numbers",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 50,
      "description": "A name for the order (required, max 50 characters)"
    },
    "siteId": {
      "type": "string",
      "description": "The site to assign the numbers to"
    },
    "peerId": {
      "type": "string",
      "description": "The SIP peer to assign the numbers to"
    },
    "existingTelephoneNumberOrderType": {
      "type": "object",
      "properties": {
        "telephoneNumberList": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "List of specific phone numbers to order"
        }
      }
    }
  }
}