Regal · Schema

RegalMessage

An outbound SMS message sent via the Regal Messages API.

AIAI AgentsVoice AIContact CenterOutbound CallingInbound CallingPhone AgentsSMSChatWebRTCConversation IntelligenceJourney OrchestrationBranded Caller IDCCaaSCPaaSSales DialerCustomer Engagement

Properties

Name Type Description
to object
from object
channel string
content object
campaignId integer
View JSON Schema on GitHub

JSON Schema

regal-message-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/regal-ai/refs/heads/main/json-schema/regal-message-schema.json",
  "title": "RegalMessage",
  "description": "An outbound SMS message sent via the Regal Messages API.",
  "type": "object",
  "required": ["to", "channel"],
  "properties": {
    "to": {
      "type": "object",
      "required": ["phoneNumber"],
      "properties": {
        "phoneNumber": { "type": "string" },
        "contactId": { "type": "string" }
      }
    },
    "from": {
      "type": "object",
      "properties": {
        "phoneNumber": { "type": "string" }
      }
    },
    "channel": { "type": "string", "enum": ["sms"] },
    "content": {
      "type": "object",
      "properties": {
        "body": { "type": "string" },
        "mediaUrl": { "type": "string", "format": "uri" }
      }
    },
    "campaignId": { "type": "integer" }
  }
}