Bandwidth · JSON Structure

Phone Numbers Feature Order Request Structure

Request to configure phone number features

Type: object Properties: 2
CommunicationsCPaaSVoiceMessagingTelephonySMSMFA

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

Properties

callingNameDisplay directoryListing

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-feature-order-request-structure.json",
  "name": "FeatureOrderRequest",
  "description": "Request to configure phone number features",
  "type": "object",
  "properties": {
    "callingNameDisplay": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean",
          "description": "Whether CNAM display is enabled"
        },
        "callingName": {
          "type": "string",
          "maxLength": 15,
          "description": "The caller name to display (max 15 characters)"
        }
      }
    },
    "directoryListing": {
      "type": "object",
      "properties": {
        "listed": {
          "type": "boolean",
          "description": "Whether the number is listed in the directory"
        },
        "listingType": {
          "type": "string",
          "enum": [
            "LISTED",
            "NON_LISTED",
            "NON_PUBLISHED"
          ],
          "description": "The type of directory listing"
        },
        "listingName": {
          "type": "string",
          "description": "The name for the directory listing"
        },
        "listAddress": {
          "type": "boolean",
          "description": "Whether to list the address in the directory"
        }
      }
    }
  }
}