Skip to navigation

Get live agent message broker

View as Markdown

Returns your organization’s live agent message broker. There is one per organization, so there is no id.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Response

Your organization's live agent message broker
agent_always_available_enabledbooleanOptional
If true, agents are always treated as available and availability is not fetched from the agent's system.
pre_chat_sys_msg_limit_enabledbooleanOptional
If true, limits the number of system messages sent to the user before an agent connects.
pre_chat_sys_msg_limitintegerOptional
Maximum number of system messages sent to the user before an agent connects.
agent_languagestringOptional

Language agents communicate in, as a two- or three-letter language code such as EN, ES or FR.

on_demand_machine_translation_enabledbooleanOptional
If true, messages are translated on demand based on the user's locale and the agent's language.
transcript_date_formatstringOptional

Date format used in live agent transcripts: ISO (YYYY/MM/DD), US (MM/DD/YYYY) or European (DD/MM/YYYY).

file_attachment_size_limit_enabledbooleanOptional
If true, limits the size of a single file attachment.
file_attachment_size_limitlongOptional
Maximum file size, in MB, allowed for a single attachment.
total_file_attachment_allowed_per_session_enabledbooleanOptional
If true, limits the number of attachments allowed per live agent session.
total_file_attachment_allowed_per_sessionlongOptional
Maximum number of attachments allowed per live agent session.
pass_chat_history_disabledbooleanOptional
If true, the chat history is not passed to the agent when the live agent chat starts.
post_session_trigger_creator_studio_event_enabledbooleanOptional
If true, a custom event runs after the live agent session completes.
custom_event_uuidstringOptional

Custom event that runs after the live agent session completes. ID of an existing EventConfig; not available through the Configuration API.

history_passing_optionobjectOptional
Options for how chat history is passed to the agent. Applies only when chat history passing is not disabled.
live_agent_transcript_enabled_dslstringOptional

Moveworks 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_actionobjectOptional
Webhook action that runs after a live agent session ends to collect CSAT data.
updated_timedatetimeOptionalRead-only
When the configuration was last updated.
updated_bystringOptionalRead-only
Who last updated the configuration.
versionobjectOptional
Document version. On update, send back the num from your last read.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error