Get Chat Topic Entity
Gets a ChatTopicEntity object.
Calls the Chat agent service GetChatTopicEntity. NsApiSlow threshold: 5000 ms.
Headers
Convert string references and multi-language values into a specified language (iso2) code.
Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
Specify the timezone code that you would like date/time responses converted to.
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Path Parameters
The id of the ChatTopicEntity to return.
Query Parameters
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.
Response
ChatTopicEntity found.
Chat topics define who is assigned, when the channel is open for business, and look of the chat widget. ChatTopicEntity entity with API _Links added.
The primary key (auto-incremented)
The name of this chat topic
The descriptiong for this topic.
The welcome message sent to the customer when the chat session starts.
Customer languages that customer center supports. Carrier object for CustomerLanguage. Services for the CustomerLanguage Carrier is available from the List Agent.
The last time a session was accepted from the inside for this topic.
The average number of seconds per accept for this topic.
The recipient(s) for the alert template
Reply template item Carrier object for ReplyTemplate. Services for the ReplyTemplate Carrier is available from the CustomerService Agent.
Collect consent to store from user
The badge header of the chat topic
Use the custom queue message text
A text to be used in the queue message in the chat widget. Usage is controlled by the flags field, bit number 3
Contains the user notify time in minutes
Contains the manager notify time in minutes
Enable ticket submission in offline mode
Ticket Category - light read-only version of TicketCategoryEntity. Carrier object for TicketCategory. Services for the TicketCategory Carrier is available from the List Agent.
Carrier object for TicketPriority. Services for the TicketPriority Carrier is available from the List Agent.
Whether to use opening hours or not.
Chat Topic Opening Hours Carrier object for ChatOpeningHours. Services for the ChatOpeningHours Carrier is available from the Chat Agent.
Defines the look of the chat widget. Carrier object for ChatWidgetSettings. Services for the ChatWidgetSettings Carrier is available from the Chat Agent.
Enable chatbot on this topic. Run the trigger scripts on bot events.
Chat Topic bot settings. Trigger script ids to run on bot events Carrier object for ChatBotSettings. Services for the ChatBotSettings Carrier is available from the Chat Agent.
Collect offline consent to store from user
Contains the user notify time in minutes for new chat messages
Contains the manager notify time in minutes for new chat messages
Use offline form capability from chat queue
The number of minutes in the queue before the offline form is available
The number of customers in the queue before the offline form is available
Enable rating functionality in the chat widgte
The text to be displayed in the widget next to the rating stars
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Field property dictionary mapping field names to field access rights.
Related topics
Get Chat Topic EntityNSChatAgentNSChatTopicEntityDelete Chat Topic EntityPost Chat Topic EntityDefault Chat Topic Entity