Skip to main content

​
Authentication

All API requests require authentication using your API key in the Authorization header: 
Authorization: Bearer YOUR_API_KEY

​
Base URL

​
Endpoints

​
Get Conversations

Retrieve all conversations for a customer session.

GET {api_base_url}/api/v1/helpdesk/customer/{session_id}/conversations/

​
Parameters

​
session_id
string
required
Unique identifier for the customer session

​
Query Parameters

​
closed
boolean
Filter conversations by status. Accepts: true, t, yes, 1 (true), anything else is false

​
Response

​
conversations
array
Array of conversation objects
Conversation Object:
​
id
string
Unique conversation identifier
​
date_created
string
ISO timestamp of creation
​
date_updated
string
ISO timestamp of last update
​
closed
boolean
Whether the conversation is closed
​
close_support
boolean
Whether support closure was requested
​
read_by_customer
boolean
Customer read status
​
read_by_agent
boolean
Agent read status
​
responder
string
Current responder: "agent" or "sate"
​
ticket
string
Ticket identifier
​
ticket_slug
string
Ticket slug for URLs
​
latest_message
object
Most recent message in the conversation

​
Example Response

[
  {
    "id": "conv_123",
    "date_created": "2024-01-15T10:30:00Z",
    "date_updated": "2024-01-15T11:45:00Z",
    "closed": false,
    "close_support": false,
    "read_by_customer": true,
    "read_by_agent": false,
    "responder": "sate",
    "ticket": "ticket_456",
    "ticket_slug": "customer-inquiry-456",
    "latest_message": {
      "id": "msg_789",
      "date_created": "2024-01-15T11:45:00Z",
      "date_updated": "2024-01-15T11:45:00Z",
      "message": "I can help you with that issue.",
      "sender": "sate",
      "is_attachment": false,
      "attachment_metadata": null,
      "ticket_chat": "conv_123"
    }
  }
]

​
Status Codes

​
200
Success
Conversations retrieved successfully
​
400
Bad Request
Invalid parameters or malformed request
​
401
Unauthorized
Invalid or missing API key
​
403
Forbidden
Access denied for this resource

​
Get Conversation Messages

Retrieve all messages for a specific conversation.

GET {api_base_url}/api/v1/helpdesk/customer/{session_id}/conversations/{conversation_id}/messages/

​
Parameters

​
session_id
string
required
Unique identifier for the customer session
​
conversation_id
string
required
Unique identifier for the conversation

​
Response

​
id
string
Conversation identifier
​
date_created
string
ISO timestamp of creation
​
date_updated
string
ISO timestamp of last update
​
closed
boolean
Whether the conversation is closed
​
close_support
boolean
Whether support closure was requested
​
read_by_customer
boolean
Customer read status
​
read_by_agent
boolean
Agent read status
​
responder
string
Current responder: "agent" or "sate"
​
ticket
string
Ticket identifier
​
messages
array
Array of message objects in chronological order
Message Object:
​
id
string
Unique message identifier
​
date_created
string
ISO timestamp of creation
​
date_updated
string
ISO timestamp of last update
​
message
string
Message content
​
sender
string
Message sender: "sate", "agent", or "customer"
​
is_attachment
boolean
Whether this message contains an attachment
​
attachment_metadata
object
Attachment details (if is_attachment is true)
​
ticket_chat
string
Associated conversation ID

​
Example Response

{
  "id": "conv_123",
  "date_created": "2024-01-15T10:30:00Z",
  "date_updated": "2024-01-15T11:45:00Z",
  "closed": false,
  "close_support": false,
  "read_by_customer": true,
  "read_by_agent": false,
  "responder": "sate",
  "ticket": "ticket_456",
  "messages": [
    {
      "id": "msg_001",
      "date_created": "2024-01-15T10:30:00Z",
      "date_updated": "2024-01-15T10:30:00Z",
      "message": "Hello, I need help with my order",
      "sender": "customer",
      "is_attachment": false,
      "attachment_metadata": null,
      "ticket_chat": "conv_123"
    },
    {
      "id": "msg_002",
      "date_created": "2024-01-15T10:31:00Z",
      "date_updated": "2024-01-15T10:31:00Z",
      "message": "I'd be happy to help you with your order. Could you provide your order number?",
      "sender": "sate",
      "is_attachment": false,
      "attachment_metadata": null,
      "ticket_chat": "conv_123"
    }
  ]
}

​
Status Codes

​
200
Success
Messages retrieved successfully
​
400
Bad Request
Invalid parameters or malformed request
​
401
Unauthorized
Invalid or missing API key
​
403
Forbidden
Access denied for this resource

​
Error Responses

All error responses follow this format: 
{
  "detail": "Error description explaining what went wrong"
}

​
Next Steps