Home//
- Conversation
GetUserRequest
UpdateUserRequest
CreateUserRequest
GetConversationRequest
UpdateConversationRequest
CreateConversationRequest
GetMessagesRequest
CreateMessageRequest
WebhookConversationEventRequest
EndUserResponse
AgentsResponse
ConversationResponse
CreateConversationResponse
MessagesResponse
MessageResponse
EndUser
Agent
Message
Attachment
ProblemDetails
CustomAttributes
ConversationAttributes
ConversationStatus
MessageType
MessageVisibility
HtmlMessageBody
UserBasic
MessageInput
MessageAuthor
Conversation
Current conversation status:
open- Conversation is actively ongoing with the end-userresolved- Conversation is resolved by Finclosed- Conversation is finished/archivedended- Conversation is ended by the end-user or agent
Enum:"open""resolved""closed""ended"
Example:"resolved"
attributesobject(ConversationAttributes)
Attributes associated with the conversation
Example:
{ "issue_type": "Billing", "priority": "High" }
assigneeobject or null(Agent)
Agent having a conversation with an end-user.
When the conversation was created (ISO 8601 UTC)
Example:"2025-10-27T14:30:00.000Z"
{ "id": "conv_456", "status": "resolved", "user": { "id": "user_123456", "user_type": "end_user", "name": "Jane Doe", "email": "jane.doe@example.com", "photo_url": "https://example.com/avatars/jane.jpg", "attributes": { … } }, "title": "Question about pricing plans", "tags": [ "pricing", "sales" ], "attributes": { "issue_type": "Billing", "priority": "High" }, "assignee": { "id": "agent_123456", "user_type": "agent", "name": "Jane Doe", "email": "jane.doe@example.com", "photo_url": "https://example.com/avatars/jane.jpg", "alias_name": "Support Jane" }, "created_at": "2025-10-27T14:30:00.000Z", "updated_at": "2025-10-27T15:45:00.000Z" }