livechat-offline-message.md

Send Livechat Offline Message

Send the offline message when no agent is available to attend the omnichannel conversation.

HTTP Method	URL	Requires Auth
POST	/api/v1/livechat/offline.message	no

Body

Key	Example Value	Description
name*	Livechat Visitor	Message name.
email*	visitor@rocket.chat	Visitor email.
message*	I need help	Message text.
department*	Support	Department name.
host*	null	User name of the agent.

Example Call

{% code overflow="wrap" %}

curl --location 'http://localrocket:3000/api/v1/livechat/offline.message' \
--header 'Content-Type: application/json' \
--data-raw '{
  "name": "Livechat Visitor",
  "email": "visitor@rocket.chat",
  "message": "I need help",
  "department": "Support",
  "host": "null"
}'

{% endcode %}

Example Result

{
  "message": "Livechat offline message sent",
  "success": true
}