Reference
chats
queue.routing_priority
Specifies the group’s routing priority. Effective when there are queued chats.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.
manual_routing.override
Overrides themanual_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.
queue.reopen_threshold.override
Overrides thequeue.reopen_threshold license property. -1 means that the property is not overridden.
queue.enabled.override
Overrides thequeue.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.
chat_inactive_after_min
Specifies the time in minutes after which a chat is considered inactive.archive_chat_after_min
Specifies the time in minutes after the last message, after which a chat is archived.archive_offline_chat_after_min
Specifies the time in minutes after the last message, after which a continuous chat is archived.customer_timeout_after_min
Specifies the time in minutes after which a customer is considered inactive.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.
manual_routing
Specifies if manual routing is enabled. This setting can be overridden per group by themanual_routing.override property.
max_agent_active_chats
Specifies the maximum number of chats that an agent can have at the same time.queue.enabled
Specifies if queue is enabled. This setting can be overridden per group by thequeue.enabled.override property.
queue.reopen_threshold
Specifies a threshold of queued chats after which the queue is reopened. It cannot exceed thequeue.limit. This setting can be overridden per group by the queue.reopen_threshold.override property.
prefer_recent_agent
Specifies if the agent who chatted last with the customer should be preferred when routing a new chat.queue.limit
Specifies the maximum number of concurrent queued chats on the license.formatting
Specifies the formatting of the message.resolved
Specifies whether a thread was resolved by an AI agent.auto_summary_enabled
Specifies whether the chat is automatically summarized when it ends.welcome_message_source
Specifies the source of the welcome message.core
transcript_emails
Comma-separated list of emails to which chat transcripts should be sent.ecommerce
has_sale
Specifies that a sale has happened during the chat.has_indirect_sale
Specifies that the sale occurred within 30 days after the chat ended.lc2
file_safety_confirmation
Describes if a user confirmed the safety of the received file.form_type
Specifies the form type (prechat, postchat or ticket).
greeting_id
Specifies the ID of the greeting configured within a license.greeting_unique_id
Specifies the ID of a particular greeting instance sent to the customer.welcome_message
Specifies that a given event is a welcome message.limits
access_rules.additional
Specifies the additional limit of access rules on the license.access_rules.base
Specifies the base limit of access rules on the license.access_rules.hard
Specifies the hard limit of access rules on the license. The sum of additional and base limits cannot extend this value.agents.additional
Specifies the additional limit of Agents on the license.agents.base
Specifies the base limit of Agents on the license.agents.hard
Specifies the hard limit of Agents on the license. The sum of additional and base limits cannot extend this value.archives_retention.additional
Specifies the additional limit of archives retention in months on the license.-1 means unlimited.
archives_retention.base
Specifies the base limit of archives retention in months on the license.-1 means unlimited.
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.
banned.additional
Specifies the additional limit of banned Customers on the license.banned.base
Specifies the base limit of banned Customers on the license.banned.hard
Specifies the hard limit of banned Customers on the license. The sum of additional and base limits cannot extend this value.concurrent_chats.additional
This limit is currently unused.concurrent_chats.base
This limit is currently unused.concurrent_chats.hard
This limit is currently unused.customers_retention.additional
Specifies the additional limit of stored Customers retention in months on the license.-1 means unlimited.
customers_retention.base
Specifies the base limit of stored Customers retention in months on the license.-1 means unlimited.
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.
groups.additional
Specifies the additional limit of groups on the license.groups.base
Specifies the base limit of groups on the license.groups.hard
Specifies the hard limit of groups on the license. The sum of additional and base limits cannot extend this value.groups_per_agent.additional
Specifies the additional limit of groups per agent on the license.groups_per_agent.base
Specifies the base limit of groups per agent on the license.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.group_chooser_groups.additional
Specifies the additional limit of groups in Group Chooser on the license.group_chooser_groups.base
Specifies the base limit of groups in Group Chooser on the license.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.monitored_customers.additional
Specifies the additional limit of online monitored Customers on the license.monitored_customers.base
Specifies the base limit of online monitored Customers on the license.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.queue.additional
Specifies the additional limit of queued chats on the license.queue.base
Specifies the base limit of queued chats on the license.queue.hard
Specifies the hard limit of queued chats on the license. The sum of additional and base limits cannot extend this value.queue_continuous.additional
Specifies the additional limit of queued continuous chats on the license.queue_continuous.base
Specifies the base limit of queued continuous chats on the license.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.tags.additional
Specifies the additional limit of tags on the license.tags.base
Specifies the base limit of tags on the license.tags.hard
Specifies the hard limit of tags on the license. The sum of additional and base limits cannot extend this value.monitoring
ip_mask
Specifies IP mask that’s used instead of a real customer’s IP.whitelist_enabled
Specifies if server-side domain whitelist is enabled.rating
The properties describing chat rating.comment
Contains the text message rating left by the customer.score
Describes chat rating:0 - thumbs down, 1 - thumbs up.
routing
continuous
Specifies if a chat is continuous.email_follow_up
Specifies if there should be an email follow-up of the message left by the customer.idle
Specifies if a chat is idle or active.last_transfer_timestamp
Specifies the time and date of the most recent transfer of a chat.offline_message
Specifies if a thread was initially created as an offline message.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;
was_pinned
Specifies if the chat was previously pinned.ignore_agents_routing
Specifies if automatic routing should be disabled for a given chat.ignore_bots
Specifies if the chat should not be routed to Bots during automatic routing.unassigned
Specifies if there is no agent or bot assigned to the chat.unreplied
Specifies if no agent or bot responded to a given chat.referrer
Contains the info about the web address visited by a customer prior to starting a chat.start_url
Specifies on what page a customer started a chat.transcript_email
Specifies if a customer requested a chat transcript.smart_actions
greeting.hide_when_offline
Specifies if the greetings should be hidden when the license is offline.greeting.enabled
Specifies if the greetings are enabled.greeting.max_invites
Specifies maximum number of greetings shown to a customer.source
client_id
Specifies theclient_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.
customer_client_id
Specifies theclient_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.