Default Chat Topic Entity

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/ChatTopic/default");
var client = new RestClient(options);
var request = new RestRequest("");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "56350",
  CURLOPT_URL => "http://localhost:56350/api/v1/ChatTopic/default",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "ChatTopicId": 123,
  "Name": "<string>",
  "Description": "<string>",
  "WelcomeMessage": "<string>",
  "Language": {
    "Id": 123,
    "Value": "<string>",
    "Tooltip": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "LastAccept": "2023-11-07T05:31:56Z",
  "SecondsPrAccept": 123,
  "AlertRecipient": "<string>",
  "AlertTemplate": {
    "ReplyTemplateId": 123,
    "Name": "<string>",
    "Description": "<string>",
    "FolderId": 123
  },
  "CollectConsent": true,
  "BadgeHeader": "<string>",
  "CustomQueueTextEnabled": true,
  "CustomQueueText": "<string>",
  "WarnNewChatMinutes": 123,
  "WarnManagerNewChatMinutes": 123,
  "TicketEnabled": true,
  "TicketCategory": {
    "Id": 123,
    "Value": "<string>",
    "Tooltip": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "TicketPriority": {
    "Id": 123,
    "Value": "<string>",
    "Tooltip": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "OpeningHoursEnabled": true,
  "OpeningHours": {
    "TzLocation": {
      "TZLocationID": 123,
      "Name": "<string>",
      "TZLocationCode": "<string>",
      "TZLocationCities": "<string>",
      "IsoNumber": 123,
      "TimeZoneSTDRules": {},
      "TimeZoneDSTRules": {}
    },
    "MonEnabled": true,
    "MonStart": "<string>",
    "MonStop": "<string>",
    "TueEnabled": true,
    "TueStart": "<string>",
    "TueStop": "<string>",
    "WedEnabled": true,
    "WedStart": "<string>",
    "WedStop": "<string>",
    "ThuEnabled": true,
    "ThuStart": "<string>",
    "ThuStop": "<string>",
    "FriEnabled": true,
    "FriStart": "<string>",
    "FriStop": "<string>",
    "SatEnabled": true,
    "SatStart": "<string>",
    "SatStop": "<string>",
    "SunEnabled": true,
    "SunStart": "<string>",
    "SunStop": "<string>",
    "UseLunchHours": true,
    "LunchStart": "<string>",
    "LunchStop": "<string>"
  },
  "Widget": {
    "AutoFaqEnabled": true,
    "AutoFaqCategory": {
      "KbCategoryId": 123,
      "Name": "<string>",
      "Description": "<string>",
      "Fullname": "<string>",
      "ParentId": 123,
      "SortOrder": 123
    },
    "PreFormEnabled": true,
    "PreFormMessage": "<string>",
    "RequiredFields": "None",
    "PostFormEnabled": true,
    "PostFormHeader": "<string>",
    "PostFormMessage": "<string>",
    "PostTranscriptEnabled": true,
    "LanguageIsoCode": "<string>",
    "Size": "Normal",
    "Theme": "Classic",
    "Color": "<string>",
    "BadgeColor": "<string>",
    "BadgeTextColor": "<string>",
    "CustMsgColor": "<string>",
    "CustMsgTextColor": "<string>",
    "AgentMsgColor": "<string>",
    "AgentMsgTextColor": "<string>",
    "ButtonColor": "<string>",
    "ButtonTextColor": "<string>",
    "Font": "<string>",
    "FontSize": "<string>",
    "LogoEnabled": true,
    "LogoBlobId": 123,
    "LogoName": "<string>",
    "ShowAgentPhoto": true,
    "WelcomeTitle": "<string>",
    "WelcomeMessage": "<string>",
    "OfflineHeader": "<string>",
    "OfflineMessage": "<string>",
    "OfflineFields": "None",
    "UseAgentFirstname": true
  },
  "BotEnabled": true,
  "BotSettings": {
    "BotName": "<string>",
    "BotRegisterScriptId": 123,
    "BotSessionCreatedScriptId": 123,
    "BotSessionChangedScriptId": 123,
    "BotMessageReceivedScriptId": 123
  },
  "OfflineCollectConsent": true,
  "WarnChatMessageMinutes": 123,
  "WarnManagerChatMessageMinutes": 123,
  "UseQueueOfflineForm": true,
  "OfflineFormTimeLimit": 123,
  "OfflineFormQueueLength": 123,
  "WidgetEnableRating": true,
  "WidgetRatingText": "<string>",
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {}
}

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/ChatTopic/default");
var client = new RestClient(options);
var request = new RestRequest("");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "56350",
  CURLOPT_URL => "http://localhost:56350/api/v1/ChatTopic/default",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "ChatTopicId": 123,
  "Name": "<string>",
  "Description": "<string>",
  "WelcomeMessage": "<string>",
  "Language": {
    "Id": 123,
    "Value": "<string>",
    "Tooltip": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "LastAccept": "2023-11-07T05:31:56Z",
  "SecondsPrAccept": 123,
  "AlertRecipient": "<string>",
  "AlertTemplate": {
    "ReplyTemplateId": 123,
    "Name": "<string>",
    "Description": "<string>",
    "FolderId": 123
  },
  "CollectConsent": true,
  "BadgeHeader": "<string>",
  "CustomQueueTextEnabled": true,
  "CustomQueueText": "<string>",
  "WarnNewChatMinutes": 123,
  "WarnManagerNewChatMinutes": 123,
  "TicketEnabled": true,
  "TicketCategory": {
    "Id": 123,
    "Value": "<string>",
    "Tooltip": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "TicketPriority": {
    "Id": 123,
    "Value": "<string>",
    "Tooltip": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "OpeningHoursEnabled": true,
  "OpeningHours": {
    "TzLocation": {
      "TZLocationID": 123,
      "Name": "<string>",
      "TZLocationCode": "<string>",
      "TZLocationCities": "<string>",
      "IsoNumber": 123,
      "TimeZoneSTDRules": {},
      "TimeZoneDSTRules": {}
    },
    "MonEnabled": true,
    "MonStart": "<string>",
    "MonStop": "<string>",
    "TueEnabled": true,
    "TueStart": "<string>",
    "TueStop": "<string>",
    "WedEnabled": true,
    "WedStart": "<string>",
    "WedStop": "<string>",
    "ThuEnabled": true,
    "ThuStart": "<string>",
    "ThuStop": "<string>",
    "FriEnabled": true,
    "FriStart": "<string>",
    "FriStop": "<string>",
    "SatEnabled": true,
    "SatStart": "<string>",
    "SatStop": "<string>",
    "SunEnabled": true,
    "SunStart": "<string>",
    "SunStop": "<string>",
    "UseLunchHours": true,
    "LunchStart": "<string>",
    "LunchStop": "<string>"
  },
  "Widget": {
    "AutoFaqEnabled": true,
    "AutoFaqCategory": {
      "KbCategoryId": 123,
      "Name": "<string>",
      "Description": "<string>",
      "Fullname": "<string>",
      "ParentId": 123,
      "SortOrder": 123
    },
    "PreFormEnabled": true,
    "PreFormMessage": "<string>",
    "RequiredFields": "None",
    "PostFormEnabled": true,
    "PostFormHeader": "<string>",
    "PostFormMessage": "<string>",
    "PostTranscriptEnabled": true,
    "LanguageIsoCode": "<string>",
    "Size": "Normal",
    "Theme": "Classic",
    "Color": "<string>",
    "BadgeColor": "<string>",
    "BadgeTextColor": "<string>",
    "CustMsgColor": "<string>",
    "CustMsgTextColor": "<string>",
    "AgentMsgColor": "<string>",
    "AgentMsgTextColor": "<string>",
    "ButtonColor": "<string>",
    "ButtonTextColor": "<string>",
    "Font": "<string>",
    "FontSize": "<string>",
    "LogoEnabled": true,
    "LogoBlobId": 123,
    "LogoName": "<string>",
    "ShowAgentPhoto": true,
    "WelcomeTitle": "<string>",
    "WelcomeMessage": "<string>",
    "OfflineHeader": "<string>",
    "OfflineMessage": "<string>",
    "OfflineFields": "None",
    "UseAgentFirstname": true
  },
  "BotEnabled": true,
  "BotSettings": {
    "BotName": "<string>",
    "BotRegisterScriptId": 123,
    "BotSessionCreatedScriptId": 123,
    "BotSessionChangedScriptId": 123,
    "BotMessageReceivedScriptId": 123
  },
  "OfflineCollectConsent": true,
  "WarnChatMessageMinutes": 123,
  "WarnManagerChatMessageMinutes": 123,
  "UseQueueOfflineForm": true,
  "OfflineFormTimeLimit": 123,
  "OfflineFormQueueLength": 123,
  "WidgetEnableRating": true,
  "WidgetRatingText": "<string>",
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {}
}

Headers

Accept-Language

string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language

string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture

string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone

string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken

string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Response

Chat topics define who is assigned, when the channel is open for business, and look of the chat widget. Carrier object for ChatTopicEntity. Services for the ChatTopicEntity Carrier is available from the Chat Agent.

ChatTopicId

integer<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

object

Customer languages that customer center supports. Carrier object for CustomerLanguage. Services for the CustomerLanguage Carrier is available from the List Agent.

Show child attributes

LastAccept

string<date-time>

The last time a session was accepted from the inside for this topic.

SecondsPrAccept

integer<int32>

The average number of seconds per accept for this topic.

AlertRecipient

string

The recipient(s) for the alert template

AlertTemplate

object

Reply template item Carrier object for ReplyTemplate. Services for the ReplyTemplate Carrier is available from the CustomerService Agent.

Show child attributes

Collect consent to store from user

BadgeHeader

string

The badge header of the chat topic

CustomQueueTextEnabled

boolean

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

integer<int32>

Contains the user notify time in minutes

WarnManagerNewChatMinutes

integer<int32>

Contains the manager notify time in minutes

TicketEnabled

boolean

Enable ticket submission in offline mode

TicketCategory

object

Ticket Category - light read-only version of TicketCategoryEntity. Carrier object for TicketCategory. Services for the TicketCategory Carrier is available from the List Agent.

Show child attributes

TicketPriority

object

Carrier object for TicketPriority. Services for the TicketPriority Carrier is available from the List Agent.

Show child attributes

OpeningHoursEnabled

boolean

Whether to use opening hours or not.

OpeningHours

object

Chat Topic Opening Hours Carrier object for ChatOpeningHours. Services for the ChatOpeningHours Carrier is available from the Chat Agent.

Show child attributes

Defines the look of the chat widget. Carrier object for ChatWidgetSettings. Services for the ChatWidgetSettings Carrier is available from the Chat Agent.

Show child attributes

BotEnabled

boolean

Enable chatbot on this topic. Run the trigger scripts on bot events.

BotSettings

object

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.

Show child attributes

Collect offline consent to store from user

WarnChatMessageMinutes

integer<int32>

Contains the user notify time in minutes for new chat messages

WarnManagerChatMessageMinutes

integer<int32>

Contains the manager notify time in minutes for new chat messages

UseQueueOfflineForm

boolean

Use offline form capability from chat queue

OfflineFormTimeLimit

integer<int32>

The number of minutes in the queue before the offline form is available

OfflineFormQueueLength

integer<int32>

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

TableRight

object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

Show child attributes

FieldProperties

object

Field property dictionary mapping field names to field access rights.

Show child attributes