/

/Infoset REST API

Changes Docs Sign in

APIs
Generators
Stacks
Projects

Docs
History
Schema

Checked 17h ago · Updated 17h ago

Filter operations

Announcement7

AuditLog1

Automation6

CallCenter61

CallTag5

Category5

Chat27

getGet the current chat widget information (status, settings, etc.)
getLists all chat histories
get/v1/chat/newUserHash
postCreates and sends an OTP to the visitor.
postVerifies the OTP and returns a secure token for chat authentication.
getList all chat rooms
getGet 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.
getGet 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.
getGet 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.
getGet 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".
postQueue 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}`.
postQueue 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.
postAdd tags to a chat room
deleteRemove tags from a chat room
deleteDelete chat room
putOpen an archived chat room
put/v1/chat/rooms/{roomId}/close
getList all chat messages
post/v1/chat/messages
postTranslates visitor's messages in the room to agent's target lang
putEdit a chat message
deleteDelete a chat message
get/v1/chat/logs
post/v1/chat/transfer
postReturns 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

Contact24

ContactGroup5

ContactInfo1

CopilotConfig4

Country1

CustomerContext3

CustomField5

CustomReport10

Dashboard8

Deal19

Dialer11

Email7

Event4

ForbiddenWordConfig4

GenAiChatOwnership1

GenAiConfig3

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

Delete a chat message

delete/v1/chat/messages/{id}

Path parameters

idstring required

Response

OK

totalItemsinteger

Changes

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