messagebird · Schema

ConversationMessage

Properties

Name	Type	Description
id	string	The unique identifier of the message.
conversationId	string	The conversation this message belongs to.
channelId	string	The channel through which the message was sent or received.
platform	string	The platform of the channel.
to	string	The recipient identifier.
from	string	The sender identifier.
direction	string	The direction of the message.
status	string	The delivery status of the message.
type	string	The type of message content.
content	object
createdDatetime	string	The date and time when the message was created.
updatedDatetime	string	The date and time when the message was last updated.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ConversationMessage",
  "title": "ConversationMessage",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier of the message."
    },
    "conversationId": {
      "type": "string",
      "description": "The conversation this message belongs to."
    },
    "channelId": {
      "type": "string",
      "description": "The channel through which the message was sent or received."
    },
    "platform": {
      "type": "string",
      "description": "The platform of the channel."
    },
    "to": {
      "type": "string",
      "description": "The recipient identifier."
    },
    "from": {
      "type": "string",
      "description": "The sender identifier."
    },
    "direction": {
      "type": "string",
      "description": "The direction of the message.",
      "enum": [
        "sent",
        "received"
      ]
    },
    "status": {
      "type": "string",
      "description": "The delivery status of the message.",
      "enum": [
        "accepted",
        "pending",
        "sent",
        "delivered",
        "read",
        "failed",
        "deleted"
      ]
    },
    "type": {
      "type": "string",
      "description": "The type of message content."
    },
    "content": {
      "$ref": "#/components/schemas/MessageContent"
    },
    "createdDatetime": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time when the message was created."
    },
    "updatedDatetime": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time when the message was last updated."
    }
  }
}