Chatwoot · Schema

Message

Chatwoot Message schema

Customer SupportMessagingLive ChatOmni-channelConversationsContactsAgentsOpen Source

Properties

Name Type Description
id number The ID of the message
content string The text content of the message
account_id number The ID of the account
inbox_id number The ID of the inbox
conversation_id number The ID of the conversation
message_type integer The type of the message
created_at integer The time at which message was created
updated_at integerstring The time at which message was updated
private boolean The flags which shows whether the message is private or not
status stringnull The status of the message
source_id stringnull The source ID of the message
content_type stringnull The type of the template message
content_attributes object The content attributes for each content_type
sender_type stringnull The type of the sender
sender_id numbernull The ID of the sender
external_source_ids object The external source IDs of the message
additional_attributes object The additional attributes of the message
processed_message_content stringnull The processed message content
sentiment objectnull The sentiment of the message
conversation objectnull The conversation object
attachment objectnull The file object attached to the image
sender object User/Agent/AgentBot object
View JSON Schema on GitHub

JSON Schema

message.json Raw ↑
{
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "The ID of the message"
    },
    "content": {
      "type": "string",
      "description": "The text content of the message"
    },
    "account_id": {
      "type": "number",
      "description": "The ID of the account"
    },
    "inbox_id": {
      "type": "number",
      "description": "The ID of the inbox"
    },
    "conversation_id": {
      "type": "number",
      "description": "The ID of the conversation"
    },
    "message_type": {
      "type": "integer",
      "enum": [
        0,
        1,
        2,
        3
      ],
      "description": "The type of the message"
    },
    "created_at": {
      "type": "integer",
      "description": "The time at which message was created"
    },
    "updated_at": {
      "type": [
        "integer",
        "string"
      ],
      "description": "The time at which message was updated"
    },
    "private": {
      "type": "boolean",
      "description": "The flags which shows whether the message is private or not"
    },
    "status": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "sent",
        "delivered",
        "read",
        "failed",
        null
      ],
      "description": "The status of the message"
    },
    "source_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The source ID of the message"
    },
    "content_type": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "text",
        "input_text",
        "input_textarea",
        "input_email",
        "input_select",
        "cards",
        "form",
        "article",
        "incoming_email",
        "input_csat",
        "integrations",
        "sticker",
        "voice_call",
        null
      ],
      "description": "The type of the template message"
    },
    "content_attributes": {
      "type": "object",
      "description": "The content attributes for each content_type"
    },
    "sender_type": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "Contact",
        "User",
        "AgentBot",
        "Captain::Assistant",
        null
      ],
      "description": "The type of the sender"
    },
    "sender_id": {
      "type": [
        "number",
        "null"
      ],
      "description": "The ID of the sender"
    },
    "external_source_ids": {
      "type": "object",
      "description": "The external source IDs of the message"
    },
    "additional_attributes": {
      "type": "object",
      "description": "The additional attributes of the message"
    },
    "processed_message_content": {
      "type": [
        "string",
        "null"
      ],
      "description": "The processed message content"
    },
    "sentiment": {
      "type": [
        "object",
        "null"
      ],
      "description": "The sentiment of the message"
    },
    "conversation": {
      "type": [
        "object",
        "null"
      ],
      "description": "The conversation object"
    },
    "attachment": {
      "type": [
        "object",
        "null"
      ],
      "description": "The file object attached to the image"
    },
    "sender": {
      "type": "object",
      "description": "User/Agent/AgentBot object"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/chatwoot/main/json-schema/message.json",
  "title": "Message",
  "description": "Chatwoot Message schema"
}