POST Agents/Chat/GetChatTopicEntity

• 5 minutes to read
 • 5 minutes to read 
POST /api/v1/Agents/Chat/GetChatTopicEntity

Gets a ChatTopicEntity object.

NsApiSlow threshold: 5000 ms.

Query String Parameters

Parameter Name Type Description
chatTopicEntityId int32 Required The identifier of the ChatTopicEntity object
$select string Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields. 
POST /api/v1/Agents/Chat/GetChatTopicEntity?chatTopicEntityId=486
POST /api/v1/Agents/Chat/GetChatTopicEntity?$select=name,department,category/id

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Response:

OK

Response Description
200 OK

Response body: ChatTopicEntity

Property Name Type Description
ChatTopicId int32 The primary key (auto-incremented)
Name string The name of this chat topic
Description string The descriptiong for this topic.
WelcomeMessage string The welcome message sent to the customer when the chat session starts.
Language CustomerLanguage Customer language used in this topic. Optional.
LastAccept date-time The last time a session was accepted from the inside for this topic.
SecondsPrAccept int32 The average number of seconds per accept for this topic.
AlertRecipient string The recipient(s) for the alert template
AlertTemplate ReplyTemplate Template to use for alerts.
CollectConsent bool Collect consent to store from user
BadgeHeader string The badge header of the chat topic
CustomQueueTextEnabled bool Use the custom queue message text
CustomQueueText string A text to be used in the queue message in the chat widget. Usage is controlled by the flags field, bit number 3
WarnNewChatMinutes int32 Contains the user notify time in minutes
WarnManagerNewChatMinutes int32 Contains the manager notify time in minutes
TicketEnabled bool Enable ticket submission in offline mode
TicketCategory TicketCategory Category on ticket created from off-line request
TicketPriority TicketPriority Priority on ticket created from off-line request
OpeningHoursEnabled bool Whether to use opening hours or not.
OpeningHours ChatOpeningHours Opening hours settings
Widget ChatWidgetSettings Settings for the chat widget
BotEnabled bool Enable chatbot on this topic. Run the trigger scripts on bot events.
BotSettings ChatBotSettings Settings for chatbot: trigger script ids to run on bot events
OfflineCollectConsent bool Collect offline consent to store from user
WarnChatMessageMinutes int32 Contains the user notify time in minutes for new chat messages
WarnManagerChatMessageMinutes int32 Contains the manager notify time in minutes for new chat messages
UseQueueOfflineForm bool Use offline form capability from chat queue
OfflineFormTimeLimit int32 The number of minutes in the queue before the offline form is available
OfflineFormQueueLength int32 The number of customers in the queue before the offline form is available
WidgetEnableRating bool Enable rating functionality in the chat widgte
WidgetRatingText string The text to be displayed in the widget next to the rating stars
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

POST /api/v1/Agents/Chat/GetChatTopicEntity
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: sv

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "ChatTopicId": 12,
  "Name": "Customer Support",
  "Description": "Live chat support for product questions and order assistance",
  "WelcomeMessage": "Welcome to Acme Support! How can we help you today?",
  "Language": null,
  "LastAccept": "2024-12-15T09:23:10+01:00",
  "SecondsPrAccept": 45,
  "AlertRecipient": "support-manager@acme.com",
  "AlertTemplate": null,
  "CollectConsent": false,
  "BadgeHeader": "Chat with us!",
  "CustomQueueTextEnabled": true,
  "CustomQueueText": "All agents are currently busy. You are #3 in queue. Average wait time: 2 minutes",
  "WarnNewChatMinutes": 5,
  "WarnManagerNewChatMinutes": 10,
  "TicketEnabled": true,
  "TicketCategory": null,
  "TicketPriority": null,
  "OpeningHoursEnabled": true,
  "OpeningHours": null,
  "Widget": null,
  "BotEnabled": false,
  "BotSettings": null,
  "OfflineCollectConsent": false,
  "WarnChatMessageMinutes": 3,
  "WarnManagerChatMessageMinutes": 5,
  "UseQueueOfflineForm": false,
  "OfflineFormTimeLimit": 30,
  "OfflineFormQueueLength": 10,
  "WidgetEnableRating": true,
  "WidgetRatingText": "How would you rate your chat experience?",
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 948
    }
  }
}