Bandwidth · Schema

Message

Message schema from Bandwidth messaging API

CommunicationsCPaaSVoiceMessagingTelephonySMSMFA

Properties

Name Type Description
id string The unique identifier for the message
owner string The Bandwidth phone number that owns the message
applicationId string The application ID associated with this message
time string The time the message was created
segmentCount integer The number of segments the message was split into
direction string The direction of the message
to array The destination phone numbers
from string The source phone number
media array Media URLs attached to the message
text string The text content of the message
tag string Custom tag attached to the message
priority string The priority of the message
View JSON Schema on GitHub

JSON Schema

messaging-message-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/messaging-message-schema.json",
  "title": "Message",
  "description": "Message schema from Bandwidth messaging API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier for the message"
    },
    "owner": {
      "type": "string",
      "description": "The Bandwidth phone number that owns the message"
    },
    "applicationId": {
      "type": "string",
      "description": "The application ID associated with this message"
    },
    "time": {
      "type": "string",
      "format": "date-time",
      "description": "The time the message was created"
    },
    "segmentCount": {
      "type": "integer",
      "description": "The number of segments the message was split into"
    },
    "direction": {
      "type": "string",
      "enum": [
        "in",
        "out"
      ],
      "description": "The direction of the message"
    },
    "to": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The destination phone numbers"
    },
    "from": {
      "type": "string",
      "description": "The source phone number"
    },
    "media": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri"
      },
      "description": "Media URLs attached to the message"
    },
    "text": {
      "type": "string",
      "description": "The text content of the message"
    },
    "tag": {
      "type": "string",
      "description": "Custom tag attached to the message"
    },
    "priority": {
      "type": "string",
      "enum": [
        "default",
        "high"
      ],
      "description": "The priority of the message"
    }
  }
}