Send Livechat Offline Message

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

HTTP MethodURLRequires Auth

POST

/api/v1/livechat/offline.message

no

Body

KeyExample ValueDescription

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

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"
}'

Example Result

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

Last updated

Rocket.Chat versions receive support for six months after release.