Skip to navigation

Live Agent Message Broker

View as Markdown

tool.live-agent.message-broker

In-bot chat (agent-broker) behaviour: availability hours (set both start AND end), history passing, CSAT.

  • Endpoint: /tool/live-agent/message-broker | Methods: GET, PATCH
  • Request shape: one per organization, so there is no id. It already exists: read it with GET, then PATCH the fields you want to change. Fields go at the top level of the JSON body, with no resource wrapper.
  • Updates: a JSON merge-patch. Send only the fields you change, plus version: {num, change_description} with the num from your last read. Lists and maps you send replace the stored ones whole.

Endpoints

All paths are relative to https://api.moveworks.ai/configurations/v1alpha1. Each endpoint page lists the request and response schema, an example, and the errors it can return.

MethodPathEndpoint reference
GET/tool/live-agent/message-brokerGet live agent message broker
PATCH/tool/live-agent/message-brokerUpdate live agent message broker

Fields

FieldTypeRequiredNotes
agent_always_available_enabledbooleanIf true, agents are always treated as available and availability is not fetched from the agent’s system.
pre_chat_sys_msg_limit_enabledbooleanIf true, limits the number of system messages sent to the user before an agent connects.
pre_chat_sys_msg_limitintegerMaximum number of system messages sent to the user before an agent connects.
agent_languagestringLanguage agents communicate in, as a two- or three-letter language code such as EN, ES or FR.
on_demand_machine_translation_enabledbooleanIf true, messages are translated on demand based on the user’s locale and the agent’s language.
transcript_date_formatstringDate format used in live agent transcripts: ISO (YYYY/MM/DD), US (MM/DD/YYYY) or European (DD/MM/YYYY).
file_attachment_size_limit_enabledbooleanIf true, limits the size of a single file attachment.
file_attachment_size_limitintegerMaximum file size, in MB, allowed for a single attachment.
total_file_attachment_allowed_per_session_enabledbooleanIf true, limits the number of attachments allowed per live agent session.
total_file_attachment_allowed_per_sessionintegerMaximum number of attachments allowed per live agent session.
pass_chat_history_disabledbooleanIf true, the chat history is not passed to the agent when the live agent chat starts.
post_session_trigger_creator_studio_event_enabledbooleanIf true, a custom event runs after the live agent session completes.
custom_event_uuidstringCustom event that runs after the live agent session completes. ID of an existing EventConfig; not available through the Configuration API.
history_passing_optionLiveAgentHistoryPassingOptionsOptions for how chat history is passed to the agent. Applies only when chat history passing is not disabled.
live_agent_transcript_enabled_dslstringMoveworks DSL rule for which users can download a plain-text transcript after a live agent chat. Use ‘true’ to enable for all users.
csat_webhook_actionCSATWebhookActionWebhook action that runs after a live agent session ends to collect CSAT data.
updated_timestringread-onlyWhen the configuration was last updated.
updated_bystringread-onlyWho last updated the configuration.
versionVersionDocument version. On update, send back the num from your last read.

Document fields (example)

The document as GET returns it. To change any of these, send only the fields you want to change in the PATCH body.

{
"agent_always_available_enabled": true,
"pre_chat_sys_msg_limit_enabled": true,
"pre_chat_sys_msg_limit": 1,
"agent_language": "AF",
"on_demand_machine_translation_enabled": true,
"transcript_date_format": "ISO",
"file_attachment_size_limit_enabled": true,
"file_attachment_size_limit": 1
}