SIsignalshq
MESSAGE

Get message details with conversation context

Retrieve detailed information about a specific message including conversation context.

get/internal/api/chat/conversation/message/{message_id}

Request

  • Base URL
    https://api.signalshq.io (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Password
    Token URL: /auth/login

Path parameters

message_idstring uuid required

The message ID

Response

Successful Response

statusstring required

Response status

message_idstring uuid required

Unique identifier for the message

conversation_idstring uuid required

Conversation this message belongs to

sender'USER' | 'SYSTEM' required
message_type'USER' | 'SYSTEM' required
messagestring nullable

Plain text message content

markdown_messagestring nullable

Markdown formatted message content

sequence_numberinteger required

Message sequence number in conversation

created_atstring date-time required

When the message was created

updated_atstring date-time required

When the message was last updated

ratingstring nullable

User rating (UP/DOWN) if rated

commentstring nullable

User comment with rating if provided

citationsobject nullable

Citations and references for the message

conversation_type'TAX_RESEARCH' | 'STATE_TAX_RESEARCH' | 'GENERAL' | 'INVOICE_HELP' | 'TEMPLATE_HELP' required
conversation_status'ACTIVE' | 'ARCHIVED' | 'DELETED' required

Example response

{
  "citations": {
    "irs_gov": {
      "title": "IRS Publication",
      "url": "https://www.irs.gov/..."
    }
  },
  "comment": "Very helpful response",
  "conversation_id": "123e4567-e89b-12d3-a456-426614174001",
  "conversation_status": "ACTIVE",
  "conversation_type": "TAX_RESEARCH",
  "created_at": "2024-01-15T10:30:00Z",
  "message": "Here's the answer to your tax question...",
  "message_id": "123e4567-e89b-12d3-a456-426614174000",
  "message_type": "SYSTEM",
  "rating": "UP",
  "sender": "SYSTEM",
  "sequence_number": 2,
  "status": "success",
  "updated_at": "2024-01-15T10:30:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.