> ## Documentation Index > Fetch the complete documentation index at: https://www.text.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Default properties > Default properties are created for each new Text license. You can use them in applications to extract important info about chats, threads, and events. This document is a reference listing all the existing default properties. You can make use of them in your applications, by extracting important info about customer behavior, chats, threads, and events. By default, they're created for each new Text license. With the right access, you can change the values of the property instances. You cannot add or remove properties in a namespace. Neither can you change the access of a given property or rename a namespace. ## Reference | Namespace | Properties | | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **chats** | [`queue.routing_priority`](#queue-routing_priority) [`agent_timeout_inactivity_form_min`](#agent_timeout_inactivity_form_min) [`manual_routing.override`](#manual_routing-override) [`queue.reopen_threshold.override`](#queue-reopen_threshold-override) [`queue.enabled.override`](#queue-enabled-override) [`chat_inactive_after_min`](#chat_inactive_after_min) [`archive_chat_after_min`](#archive_chat_after_min) [`archive_offline_chat_after_min`](#archive_offline_chat_after_min) [`customer_timeout_after_min`](#customer_timeout_after_min) [`transfer_chat_after_min`](#transfer_chat_after_min) [`manual_routing`](#manual_routing) [`max_agent_active_chats`](#max_agent_active_chats) [`queue.enabled`](#queue-enabled) [`queue.reopen_threshold`](#queue-reopen_threshold) [`prefer_recent_agent`](#prefer_recent_agent) [`queue.limit`](#queue-limit) [`formatting`](#formatting) [`resolved`](#resolved) [`auto_summary_enabled`](#auto_summary_enabled) [`welcome_message_source`](#welcome_message_source) | | **core** | [`transcript_emails`](#transcript_emails) | | **ecommerce** | [`has_sale`](#has_sale) [`has_indirect_sale`](#has_indirect_sale) | | **lc2** | [`file_safety_confirmation`](#file_safety_confirmation) [`form_type`](#form_type) [`greeting_id`](#greeting_id) [`greeting_unique_id`](#greeting_unique_id) [`welcome_message`](#welcome_message) | | **limits** | [`access_rules.additional`](#access_rules-additional) [`access_rules.base`](#access_rules-base) [`access_rules.hard`](#access_rules-hard) [`agents.additional`](#agents-additional) [`agents.base`](#agents-base) [`agents.hard`](#agents-hard) [`archives_retention.additional`](#archives_retention-additional) [`archives_retention.base`](#archives_retention-base) [`archives_retention.hard`](#archives_retention-hard) [`banned.additional`](#banned-additional) [`banned.base`](#banned-base) [`banned.hard`](#banned-hard) [`concurrent_chats.additional`](#concurrent_chats-additional) [`concurrent_chats.base`](#concurrent_chats-base) [`concurrent_chats.hard`](#concurrent_chats-hard) [`customers_retention.additional`](#customers_retention-additional) [`customers_retention.base`](#customers_retention-base) [`customers_retention.hard`](#customers_retention-hard) [`groups.additional`](#groups-additional) [`groups.base`](#groups-base) [`groups.hard`](#groups-hard) [`groups_per_agent.additional`](#groups_per_agent-additional) [`groups_per_agent.base`](#groups_per_agent-base) [`groups_per_agent.hard`](#groups_per_agent-hard) [`group_chooser_groups.additional`](#group_chooser_groups-additional) [`group_chooser_groups.base`](#group_chooser_groups-base) [`group_chooser_groups.hard`](#group_chooser_groups-hard) [`monitored_customers.additional`](#monitored_customers-additional) [`monitored_customers.base`](#monitored_customers-base) [`monitored_customers.hard`](#monitored_customers-hard) [`queue.additional`](#queue-additional) [`queue.base`](#queue-base) [`queue.hard`](#queue-hard) [`queue_continuous.additional`](#queue_continuous-additional) [`queue_continuous.base`](#queue_continuous-base) [`queue_continuous.hard`](#queue_continuous-hard) [`tags.additional`](#tags-additional) [`tags.base`](#tags-base) [`tags.hard`](#tags-hard) | | **monitoring** | [`ip_mask`](#ip_mask) [`whitelist_enabled`](#whitelist_enabled) | | **rating** | [`comment`](#comment) [`score`](#score) | | **routing** | [`continuous`](#continuous) [`email_follow_up`](#email_follow_up) [`idle`](#idle) [`last_transfer_timestamp`](#last_transfer_timestamp) [`pinned`](#pinned) [`was_pinned`](#was_pinned) [`ignore_agents_routing`](#ignore_agents_routing) [`ignore_bots`](#ignore_bots) [`unassigned`](#unassigned) [`unreplied`](#unreplied) [`referrer`](#referrer) [`start_url`](#start_url) [`transcript_email`](#transcript_email) [`offline_message`](#offline_message) | | **smart\_actions** | [`greeting.hide_when_offline`](#greeting-hide_when_offline) [`greeting.enabled`](#greeting-enabled) [`greeting.max_invites`](#greeting-max_invites) | | **source** | [`client_id`](#client_id) [`customer_client_id`](#customer_client_id) | | **statistics** | [`first_chat_date`](#first_chat_date) [`website_last_activity`](#website_last_activity) | | **status** | [`delivered`](#delivered) | | **test** | [`bool_property`](#bool_property) [`int_property`](#int_property) [`string_property`](#string_property) [`tokenized_string_property`](#tokenized_string_property) | | **translation** | [`source_lang_code`](#source_lang_code) [`target_lang_code`](#target_lang_code) [`target_message`](#target_message) | | **url\_details** | [`description`](#description) [`image_height`](#image_height) [`image_width`](#image_width) [`image_url`](#image_url) [`title`](#title) [`url`](#url) | ## chats ### queue.routing\_priority Specifies the group's routing priority. Effective when there are queued chats. | | | | ------------- | ------------------------ | | **Access** | `rw` for Agents in group | | **Data type** | `int` | ### agent\_timeout\_inactivity\_form\_min Specifies the time in minutes after which the agent inactivity form will be displayed if the agent is inactive. `-1` means that the timeout is disabled. | | | | ------------- | ------------------------ | | **Access** | `rw` for Agents in group | | **Data type** | `int` | ### manual\_routing.override Overrides the [`manual_routing`](#manual_routing) license property. `-1` means that the property is not overridden. `0` means that the manual routing is disabled. `1` means that the manual routing is enabled. | | | | ------------- | ------------------------ | | **Access** | `rw` for Agents in group | | **Data type** | `int` | ### queue.reopen\_threshold.override Overrides the [`queue.reopen_threshold`](#queue-reopen_threshold) license property. `-1` means that the property is not overridden. | | | | ------------- | ------------------------ | | **Access** | `rw` for Agents in group | | **Data type** | `int` | ### queue.enabled.override Overrides the [`queue.enabled`](#queue-enabled) license property. `-1` means that the property is not overridden. `0` means that the queue is disabled. `1` means that the queue is enabled. | | | | ------------- | ------------------------ | | **Access** | `rw` for Agents in group | | **Data type** | `int` | ### chat\_inactive\_after\_min Specifies the time in minutes after which a chat is considered inactive. | | | | ------------- | -------------------------- | | **Access** | `rw` for Agents in license | | **Data type** | `int` | ### archive\_chat\_after\_min Specifies the time in minutes after the last message, after which a chat is archived. | | | | ------------- | -------------------------- | | **Access** | `rw` for Agents in license | | **Data type** | `int` | ### archive\_offline\_chat\_after\_min Specifies the time in minutes after the last message, after which a continuous chat is archived. | | | | ------------- | -------------------------- | | **Access** | `rw` for Agents in license | | **Data type** | `int` | ### customer\_timeout\_after\_min Specifies the time in minutes after which a customer is considered inactive. | | | | ------------- | -------------------------- | | **Access** | `rw` for Agents in license | | **Data type** | `int` | ### transfer\_chat\_after\_min Specifies the time in minutes after which a chat is transferred to another agent if the previous one didn't show any activity in the chat. `0` means that the chat is not transferred. | | | | ------------- | -------------------------- | | **Access** | `rw` for Agents in license | | **Data type** | `int` | ### manual\_routing Specifies if manual routing is enabled. This setting can be overridden per group by the [`manual_routing.override`](#manual_routing-override) property. | | | | ------------- | -------------------------- | | **Access** | `rw` for Agents in license | | **Data type** | `bool` | ### max\_agent\_active\_chats Specifies the maximum number of chats that an agent can have at the same time. | | | | ------------- | -------------------------- | | **Access** | `rw` for Agents in license | | **Data type** | `int` | ### queue.enabled Specifies if queue is enabled. This setting can be overridden per group by the [`queue.enabled.override`](#queue-enabled-override) property. | | | | ------------- | -------------------------- | | **Access** | `rw` for Agents in license | | **Data type** | `bool` | ### queue.reopen\_threshold Specifies a threshold of queued chats after which the queue is reopened. It cannot exceed the [`queue.limit`](#queue-limit). This setting can be overridden per group by the [`queue.reopen_threshold.override`](#queue-reopen_threshold-override) property. | | | | ------------- | -------------------------- | | **Access** | `rw` for Agents in license | | **Data type** | `int` | ### prefer\_recent\_agent Specifies if the agent who chatted last with the customer should be preferred when routing a new chat. | | | | ------------- | -------------------------- | | **Access** | `rw` for Agents in license | | **Data type** | `bool` | ### queue.limit Specifies the maximum number of concurrent queued chats on the license. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### formatting Specifies the formatting of the message. | | | | ------------- | --------------------------------------- | | **Access** | `rw` for Agents and Customers in events | | **Data type** | `string` | | **Values** | `commonmark` | ### resolved Specifies whether a thread was resolved by an AI agent. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in threads | | **Data type** | `bool` | ### auto\_summary\_enabled Specifies whether the chat is automatically summarized when it ends. | | | | ------------- | -------------------------- | | **Access** | `rw` for Agents in license | | **Data type** | `bool` | ### welcome\_message\_source Specifies the source of the welcome message. | | | | ------------- | -------------------------------------- | | **Access** | `r` for Agents and Customers in events | | **Data type** | `string` | | **Values** | `ai_agent` `welcome_phrase` | ```json theme={null} { "properties": { "chats": { "queue.routing_priority": 1, "agent_timeout_inactivity_form_min": -1, "manual_routing.override": -1, "queue.reopen_threshold.override": 80, "queue.enabled.override": 1, "chat_inactive_after_min": 10, "archive_chat_after_min": 15, "archive_offline_chat_after_min": 10, "customer_timeout_after_min": 900, "transfer_chat_after_min": 0, "manual_routing": true, "max_agent_active_chats": 6, "queue.reopen_threshold": 90, "prefer_recent_agent": true, "queue.limit": 100, "formatting": "commonmark", "resolved": true, "auto_summary_enabled": true, "welcome_message_source": "ai_agent" } } } ``` ## core ### transcript\_emails Comma-separated list of emails to which chat transcripts should be sent. | | | | ------------- | -------------------------- | | **Access** | `rw` for Agents in license | | **Data type** | `string` | ```json theme={null} { "properties": { "core": { "transcript_emails": "smith@agent.com,brown@agent.com" } } } ``` ## ecommerce ### has\_sale Specifies that a sale has happened during the chat. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in threads | | **Data type** | `bool` | ### has\_indirect\_sale Specifies that the sale occurred within 30 days after the chat ended. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in threads | | **Data type** | `bool` | ```json theme={null} { "properties": { "ecommerce": { "has_sale": true, "has_indirect_sale": true } } } ``` ## lc2 ### file\_safety\_confirmation Describes if a user confirmed the safety of the received file. | | | | ------------- | ------------------------- | | **Access** | `rw` for Agents in events | | **Data type** | `bool` | ### form\_type Specifies the form type (`prechat`, `postchat` or `ticket`). | | | | ------------- | --------------------------------------------------------------------------------- | | **Access** | | | **Data type** | `string` | | **Values** | `prechat` `postchat` | ### greeting\_id Specifies the ID of the greeting configured within a license. | | | | ------------- | ---------------------------------------------------------------------------------------------------------------- | | **Access** | | | **Data type** | `int` | ### greeting\_unique\_id Specifies the ID of a particular greeting instance sent to the customer. | | | | ------------- | ---------------------------------------------------------------------------------------------------------------- | | **Access** | | | **Data type** | `string` | ### welcome\_message Specifies that a given event is a welcome message. | | | | ------------- | -------------------------------------- | | **Access** | `r` for Agents and Customers in events | | **Data type** | `bool` | ```json theme={null} { "properties": { "lc2": { "file_safety_confirmation": true, "form_type": "prechat", "greeting_id": 2, "greeting_unique_id": "Q10X0W041P", "welcome_message": true } } } ``` ## limits ### access\_rules.additional Specifies the additional limit of access rules on the license. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### access\_rules.base Specifies the base limit of access rules on the license. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### access\_rules.hard Specifies the hard limit of access rules on the license. The sum of additional and base limits cannot extend this value. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### agents.additional Specifies the additional limit of Agents on the license. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### agents.base Specifies the base limit of Agents on the license. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### agents.hard Specifies the hard limit of Agents on the license. The sum of additional and base limits cannot extend this value. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### archives\_retention.additional Specifies the additional limit of archives retention in months on the license. `-1` means unlimited. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### archives\_retention.base Specifies the base limit of archives retention in months on the license. `-1` means unlimited. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### archives\_retention.hard Specifies the hard limit of archives retention in months on the license. The sum of additional and base limits cannot extend this value. `-1` means unlimited. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### banned.additional Specifies the additional limit of banned Customers on the license. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### banned.base Specifies the base limit of banned Customers on the license. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### banned.hard Specifies the hard limit of banned Customers on the license. The sum of additional and base limits cannot extend this value. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### concurrent\_chats.additional This limit is currently unused. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### concurrent\_chats.base This limit is currently unused. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### concurrent\_chats.hard This limit is currently unused. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### customers\_retention.additional Specifies the additional limit of stored Customers retention in months on the license. `-1` means unlimited. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### customers\_retention.base Specifies the base limit of stored Customers retention in months on the license. `-1` means unlimited. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### customers\_retention.hard Specifies the hard limit of stored Customers retention in months on the license. The sum of additional and base limits cannot extend this value. `-1` means unlimited. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### groups.additional Specifies the additional limit of groups on the license. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### groups.base Specifies the base limit of groups on the license. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### groups.hard Specifies the hard limit of groups on the license. The sum of additional and base limits cannot extend this value. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### groups\_per\_agent.additional Specifies the additional limit of groups per agent on the license. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### groups\_per\_agent.base Specifies the base limit of groups per agent on the license. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### groups\_per\_agent.hard Specifies the hard limit of groups per agent on the license. The sum of additional and base limits cannot extend this value. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### group\_chooser\_groups.additional Specifies the additional limit of groups in Group Chooser on the license. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### group\_chooser\_groups.base Specifies the base limit of groups in Group Chooser on the license. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### group\_chooser\_groups.hard Specifies the hard limit of groups in Group Chooser on the license. The sum of additional and base limits cannot extend this value. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### monitored\_customers.additional Specifies the additional limit of online monitored Customers on the license. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### monitored\_customers.base Specifies the base limit of online monitored Customers on the license. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### monitored\_customers.hard Specifies the hard limit of online monitored Customers on the license. The sum of additional and base limits cannot extend this value. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### queue.additional Specifies the additional limit of queued chats on the license. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### queue.base Specifies the base limit of queued chats on the license. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### queue.hard Specifies the hard limit of queued chats on the license. The sum of additional and base limits cannot extend this value. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### queue\_continuous.additional Specifies the additional limit of queued continuous chats on the license. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### queue\_continuous.base Specifies the base limit of queued continuous chats on the license. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### queue\_continuous.hard Specifies the hard limit of queued continuous chats on the license. The sum of additional and base limits cannot extend this value. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### tags.additional Specifies the additional limit of tags on the license. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### tags.base Specifies the base limit of tags on the license. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ### tags.hard Specifies the hard limit of tags on the license. The sum of additional and base limits cannot extend this value. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `int` | ```json theme={null} { "properties": { "limits": { "access_rules.additional": 0, "access_rules.base": 200, "access_rules.hard": 500, "agents.additional": 0, "agents.base": 400, "agents.hard": 400, "archives_retention.additional": 0, "archives_retention.base": -1, "archives_retention.hard": -1, "banned.additional": 0, "banned.base": 100, "banned.hard": 400, "concurrent_chats.additional": 0, "concurrent_chats.base": 100, "concurrent_chats.hard": 300, "customers_retention.additional": 0, "customers_retention.base": 2, "customers_retention.hard": -1, "groups.additional": 0, "groups.base": 1, "groups.hard": 400, "groups_per_agent.additional": 0, "groups_per_agent.base": 100, "groups_per_agent.hard": 40, "group_chooser_groups.additional": 0, "group_chooser_groups.base": 10, "group_chooser_groups.hard": 25, "monitored_customers.additional": 0, "monitored_customers.base": 100, "monitored_customers.hard": 2000, "queue.additional": 0, "queue.base": 100, "queue.hard": 200, "queue_continuous.additional": 0, "queue_continuous.base": 150, "queue_continuous.hard": 150, "tags.additional": 0, "tags.base": 1000, "tags.hard": 2000 } } } ``` ## monitoring ### ip\_mask Specifies IP mask that's used instead of a real customer's IP. | | | | ------------- | -------------------------- | | **Access** | `rw` for Agents in license | | **Data type** | `string` | ### whitelist\_enabled Specifies if server-side domain whitelist is enabled. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `bool` | ```json theme={null} { "properties": { "monitoring": { "ip_mask": "10.0.0.1", "whitelist_enabled": false } } } ``` ## rating The properties describing chat rating. ### comment Contains the text message rating left by the customer. | | | | ------------- | ------------------------------------------------------------------------------------------------------------------------- | | **Access** | | | **Data type** | `string` | ### score Describes chat rating: `0` - thumbs down, `1` - thumbs up. | | | | ------------- | ----------------------------------------------------------------------------------------------------------------------- | | **Access** | | | **Data type** | `int` | | **Values** | `0` `1` | ```json theme={null} { "properties": { "rating": { "comment": "Action completed", "score": 0 } } } ``` ## routing ### continuous Specifies if a chat is continuous. | | | | ------------- | ------------------------------------------------- | | **Access** | `r` for Agents and Customers in chats and threads | | **Data type** | `bool` | ### email\_follow\_up Specifies if there should be an email follow-up of the message left by the customer. | | | | ------------- | ------------------------------------------------------------------------------- | | **Access** | | | **Data type** | `bool` | ### idle Specifies if a chat is idle or active. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in threads | | **Data type** | `bool` | ### last\_transfer\_timestamp Specifies the time and date of the most recent transfer of a chat. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in threads | | **Data type** | `int` | ### offline\_message Specifies if a thread was initially created as an offline message. | | | | ------------- | ----------------------------------------------------------------------------------- | | **Access** | | | **Data type** | `bool` | ### pinned Indicates the chat status. `true`: * for each active, unassigned chat; `false`: * when a chat is closed by an agent; * when the chat that's being closed by a customer is in a state different than *unassigned*; | | | | ------------- | ------------------------------------------- | | **Access** | `r` for Agents in threads and `rw` in chats | | **Data type** | `bool` | ### was\_pinned Specifies if the chat was previously [pinned](#pinned). | | | | ------------- | ----------------------- | | **Access** | `r` for Agents in chats | | **Data type** | `bool` | ### ignore\_agents\_routing Specifies if automatic routing should be disabled for a given chat. | | | | ------------- | -------------------------------------- | | **Access** | `rw` for Agents and Customers in chats | | **Data type** | `bool` | ### ignore\_bots Specifies if the chat should not be routed to Bots during automatic routing. | | | | ------------- | ---------------------------- | | **Access** | `w` for Customers in threads | | **Data type** | `bool` | ### unassigned Specifies if there is no agent or bot assigned to the chat. | | | | ------------- | ----------------------------------- | | **Access** | `r` for Agents in threads and chats | | **Data type** | `bool` | ### unreplied Specifies if no agent or bot responded to a given chat. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in threads | | **Data type** | `bool` | ### referrer Contains the info about the web address visited by a customer prior to starting a chat. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in threads | | **Data type** | `string` | ### start\_url Specifies on what page a customer started a chat. | | | | ------------- | --------------------------------------- | | **Access** | `r` for Agents and Customers in threads | | **Data type** | `string` | ### transcript\_email Specifies if a customer requested a chat transcript. | | | | ------------- | ----------------------------------------------------------------------------------- | | **Access** | | | **Data type** | `string` | ```json theme={null} { "properties": { "routing": { "continuous": true, "email_follow_up": false, "idle": false, "last_transfer_timestamp": 83765782567, "pinned": false, "was_pinned": true, "ignore_agents_routing": true, "ignore_bots": false, "unassigned": false, "unreplied": false, "referrer": "https://www.text.com/features", "start_url": "https://www.text.com", "transcript_email": "t.anderson@example.com", "offline_message": true } } } ``` ## smart\_actions ### greeting.hide\_when\_offline Specifies if the greetings should be hidden when the license is offline. | | | | ------------- | ------------------------------------------------------------------------------- | | **Access** | | | **Data type** | `bool` | ### greeting.enabled Specifies if the greetings are enabled. | | | | ------------- | --------------------------- | | **Access** | for Agents, `rw` in license | | **Data type** | `bool` | ### greeting.max\_invites Specifies maximum number of greetings shown to a customer. | | | | ------------- | -------------------------- | | **Access** | for Agents, `r` in license | | **Data type** | `int` | ```json theme={null} { "properties": { "smart_actions": { "greeting.hide_when_offline": false, "greeting.enabled": true, "greeting.max_invites": 5 } } } ``` ## source ### client\_id Specifies the `client_id` of the application an agent is chatting from. The `client_id` and `customer_client_id` properties might have different values when it's the agent who started the chat. | | | | ------------- | ---------------------------------------------------------- | | **Access** | `r` for Agents and Customers in chats, threads, and events | | **Data type** | `string` | ### customer\_client\_id Specifies the `client_id` of the application the customer is using to chat. The `client_id` and `customer_client_id` properties have the same values when the chat was started by the customer. | | | | ------------- | ------------------------------------------------- | | **Access** | `r` for Agents and Customers in chats and threads | | **Data type** | `string` | ```json theme={null} { "properties": { "source": { "client_id": "0805e283233042b37f460ed8fbf22160", "customer_client_id": "0805e283233042b37f460ed8fbf22160" } } } ``` ## statistics ### first\_chat\_date Specifies the date of the first chat on the license. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `string` | ### website\_last\_activity Specifies the date of the last recorded activity of the chat widget. | | | | ------------- | ------------------------- | | **Access** | `r` for Agents in license | | **Data type** | `string` | ```json theme={null} { "properties": { "statistics": { "first_chat_date": "2020-01-01", "website_last_activity": "2021-02-02" } } } ``` ## status ### delivered This property is used to mark events transported from Text to an integration and vice versa. | | | | ------------- | --------------------------------------- | | **Access** | `rw` for Agents and Customers in events | | **Data type** | `bool` | ```json theme={null} { "properties": { "status": { "delivered": true } } } ``` ## test Use these properties to test things out and learn how properties work. ### bool\_property | | | | ------------- | ----------------------------------- | | **Access** | `rw` for all roles in all locations | | **Data type** | `bool` | ### int\_property | | | | ------------- | ----------------------------------- | | **Access** | `rw` for all roles in all locations | | **Data type** | `int` | ### string\_property | | | | ------------- | ----------------------------------- | | **Access** | `rw` for all roles in all locations | | **Data type** | `string` | ### tokenized\_string\_property | | | | ------------- | ----------------------------------- | | **Access** | `rw` for all roles in all locations | | **Data type** | `tokenized string` | ```json theme={null} { "properties": { "test": { "bool_property": true, "int_property": 1234, "string_property": "Lorem ipsum dolor olet", "tokenized_string_property": "Lorem ipsum dolor olet" } } } ``` ## translation These properties are used for storing translated text in message events. ### source\_lang\_code Specifies the source language code. | | | | ------------- | --------------------------------------------------------------------------------- | | **Access** | | | **Data type** | `string` | ### target\_lang\_code Specifies the target language code. | | | | ------------- | --------------------------------------------------------------------------------- | | **Access** | | | **Data type** | `string` | ### target\_message Contains message text in the target language. | | | | ------------- | --------------------------------------------------------------------------------- | | **Access** | | | **Data type** | `tokenized string` | ```json theme={null} { "properties": { "translation": { "source_lang_code": "en", "target_lang_code": "pl", "target_message": "Witaj Świecie!" } } } ``` ## url\_details These properties are used to store URL info in events. ### description | | | | ------------- | --------------------------------------- | | **Access** | `rw` for Agents and Customers in events | | **Data type** | `string` | ### image\_height | | | | ------------- | --------------------------------------- | | **Access** | `rw` for Agents and Customers in events | | **Data type** | `int` | ### image\_width | | | | ------------- | --------------------------------------- | | **Access** | `rw` for Agents and Customers in events | | **Data type** | `int` | ### image\_url | | | | ------------- | --------------------------------------- | | **Access** | `rw` for Agents and Customers in events | | **Data type** | `string` | ### title | | | | ------------- | --------------------------------------- | | **Access** | `rw` for Agents and Customers in events | | **Data type** | `string` | ### url | | | | ------------- | --------------------------------------- | | **Access** | `rw` for Agents and Customers in events | | **Data type** | `string` | ```json theme={null} { "properties": { "url_details": { "description": "The flow between services", "image_height": 480, "image_width": 640, "image_url": "https://example.com/image25.png", "title": "The flow", "url": "https://example-url.com/" } } } ```