/

Docs
History
Schema
Generate

Filter operations

Announcement7

AuditLog1

Automation6

CallCenter61

CallTag5

Category5

Chat26

get/v1/chat/widgetGet the current chat widget information (status, settings, etc.)
get/v1/chat/widget/historiesLists all chat histories
post/v1/chat/widget/sendOtpCreates and sends an OTP to the visitor.
post/v1/chat/widget/verifyOtpVerifies the OTP and returns a secure token for chat authentication.
get/v1/chat/roomsList all chat rooms
get/v1/chat/rooms/{roomId}/intentsGet the intents detected for a chat room (AI intent classification), oldest first. Powers the header intent badges in the dashboard; live additions are pushed separately via the `newChatIntent` SignalR event.
get/v1/chat/rooms/{roomId}/sentimentGet the current sentiment detected for a chat room (AI sentiment classification). Powers the header sentiment badge in the dashboard; live updates are pushed separately via the `newChatSentiment` SignalR event. Returns `null` when no sentiment has been detected for the room yet.
get/v1/chat/rooms/{roomId}/customer-contextGet the current customer context generated for a chat room (AI customer-context). Powers the dashboard's customer-context panel (initial load); live updates are pushed separately via the `newCustomerContext` SignalR event. Returns `null` when no customer context has been generated for the room yet.
get/v1/chat/rooms/{roomId}/suggestionsGet the streaming suggestion snapshot (`{inFlight, last}`) for a chat room, proxied from copilot-service. Powers the initial load of the composer suggestion card (mid-stream join + post-refresh render); live updates are pushed separately via the `copilotStreamEvent` SignalR event. FAIL-OPEN: copilot-service being unconfigured, slow or down yields an empty snapshot (200 with both fields null), never an error — the dashboard degrades to "no suggestion yet".
post/v1/chat/rooms/{roomId}/suggestions/regenerateQueue an on-demand regeneration of the room's AI suggestion. Throttled by a per-room 30s Redis SETNX cooldown so agents (across pods) cannot flood the copilot side. Progress reaches the dashboard through the normal `copilotStreamEvent` pushes. Returns the raw response object — NOT wrapped in `ApiResponse` — to mirror the ticket summary refresh endpoint: `{queued:true}` or `{queued:false, cooldownSeconds:N}`.
post/v1/chat/rooms/{roomId}/suggestions/{suggestionId}/feedbackQueue the current agent's approval (👍) or disapproval (👎) of one AI suggestion. `rating` is `up` | `down` | `none` (none withdraws). One vote per agent per suggestion — re-voting overwrites. Returns the raw object, NOT wrapped in `ApiResponse`, mirroring the sibling suggestion endpoints.
post/v1/chat/rooms/{roomId}/tagsAdd tags to a chat room
delete/v1/chat/rooms/{roomId}/tagsRemove tags from a chat room
delete/v1/chat/rooms/{roomId}Delete chat room
put/v1/chat/rooms/{roomId}/openOpen an archived chat room
put/v1/chat/rooms/{roomId}/close
get/v1/chat/messagesList all chat messages
post/v1/chat/messages
post/v1/chat/messages/translateTranslates visitor's messages in the room to agent's target lang
put/v1/chat/messages/{id}Edit a chat message
delete/v1/chat/messages/{id}Delete a chat message
get/v1/chat/logs
post/v1/chat/transfer
post/v1/chat/transcriptReturns the chat transcript for a given room id
get/v1/chat/{id}/automationRunLogs
get/v1/chat/{id}/routingRunLogs

Chatbot21

ChatbotConnection6

ChatRoomMetadata1

ChatRoomThread1

ChatTag7

ChatWidget5

Company19

Contact23

ContactGroup5

ContactInfo1

CopilotConfig4

Country1

CustomerContext3

CustomField5

CustomReport10

Dashboard8

Deal19

Dialer11

Email7

Event4

ForbiddenWordConfig4

GenAiChatOwnership1

GenAiConfig1

GenAiHandoff1

GenAiResolve1

GenAiTyping1

HelpCenter16

IntegrationCapabilities2

Intent1

KbSyncPlan1

Login3

Notification5

OutboundMessage7

PermissionProfile16

Pipeline5

Plan3

Reaction1

Report106

ReportVisibility4

RoutingQueue5

SavedFilter5

SavedReply5

Sentiment1

Setting14

SipServer7

Sla6

SmsLog1

Stage5

Survey11

Template5

Ticket33

Todo5

User17

UserGroup7

UserRating5

UserState3

Chat

Changes to Lists all chat histories

get/v1/chat/widget/histories

Oct 2, 2026709c8123f593 Revision changes
- info
  added the new optional query request parameter RoomTokens