Welcome

Dealing with Livechat messages

Send a new Livechat message

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

Payload

Argument Example Required Description
token iNKE8a6k6cjbqWhWd Required Visitor token.
rid zRAeTszXor8CCPceB Required Room _id.
msg sending livechat message.. Required Message text.
_id   Optional Message _id.
agent   Optional Room agent.

Example payload

{
  "token": "iNKE8a6k6cjbqWhWd",
  "rid": "zRAeTszXor8CCPceB",
  "msg": "sending livechat message.."
}

Example Call

curl -X POST \
     -H "Content-type:application/json" \
     http://localhost:3000/api/v1/livechat/message \
     -d '{"token": "iNKE8a6k6cjbqWhWd", "rid": "zRAeTszXor8CCPceB", "msg": "sending livechat message.."}'

Example Result

{
  "message": {
    "_id": "ZKWP8LfGnRHQ3ozWa",
    "msg": "sending livechat message..",
    "u": {
      "_id": "iNKE8a6k6cjbqWhWd",
      "username": "guest-4",
      "name": "Livechat Visitor"
    },
    "ts": "2018-09-14T13:31:33.201Z"
  },
  "success": true
}

Change Log

Version Description
0.70.0 Added

Updates a Livechat message

URL Requires Auth HTTP Method
/api/v1/livechat/message/:_id no PUT

Payload

Argument Example Required Description
_id ZKWP8LfGnRHQ3ozWa Required Message _id.
token iNKE8a6k6cjbqWhWd Required Visitor token.
rid zRAeTszXor8CCPceB Required Room _id.
msg editing a livechat message.. Required Message text.

Example payload

{
  "token": "iNKE8a6k6cjbqWhWd",
  "rid": "zRAeTszXor8CCPceB",
  "msg": "editing a livechat message.."
}

Example Call

curl -X PUT \
     -H "Content-type:application/json" \
     http://localhost:3000/api/v1/livechat/message/ZKWP8LfGnRHQ3ozWa \
     -d '{"token": "iNKE8a6k6cjbqWhWd", "rid": "zRAeTszXor8CCPceB", "msg": "editing a livechat message.."}'

Example Result

{
  "message": {
    "_id": "ZKWP8LfGnRHQ3ozWa",
    "msg": "editing livechat message..",
    "u": {
      "_id": "YgEoq2djbGdjjZnsL",
      "username": "guest-4",
      "name": "Livechat Visitor"
    },
    "ts": "2018-09-14T13:31:33.201Z"
  },
  "success": true
}

Change Log

Version Description
0.70.0 Added

Removes a Livechat message

URL Requires Auth HTTP Method
/api/v1/livechat/message/:_id no DELETE

Payload

Argument Example Required Descriptio
_id ZKWP8LfGnRHQ3ozWa Required Message _id.

Example Call

curl -X DELETE \
     http://localhost:3000/api/v1/livechat/message/ZKWP8LfGnRHQ3ozWa

Example Result

{
  "message": {
    "_id": "ZKWP8LfGnRHQ3ozWa",
    "ts": "2018-09-14T13:31:33.279Z"
  },
  "success": true
}

Change Log

Version Description
0.70.0 Added

Load Livechat messages history

URL Requires Auth HTTP Method
/api/v1/livechat/messages.history/:rid no GET

Payload

Argument Example Required Description
rid KuACMJ5MpN6SfAFWg Required The room _id.

Query Parameters

Argument Example Required Description
token iNKE8a6k6cjbqWhWd Required The visitor token.
ts   Optional The timestamp to start loading.
end   Optional The timestamp limit to load.
limit   Optional The number of messages to load.

Example Call

curl http://localhost:3000/api/v1/livechat/messages.history/KuACMJ5MpN6SfAFWg?token=iNKE8a6k6cjbqWhWd

Example Result

{
  "messages": [{
    "_id": "ZKWP8LfGnRHQ3ozWa",
    "rid": "KuACMJ5MpN6SfAFWg",
    "msg": "editing livechat message..",
    "token": "iNKE8a6k6cjbqWhWd",
    "alias": "Livechat Visitor",
    "ts": "2018-09-14T13:31:33.201Z",
    "u": {
      "_id": "YgEoq2djbGdjjZnsL",
      "username": "guest-4",
      "name": "Livechat Visitor"
    },
    "mentions": [],
    "channels": [],
    "_updatedAt": "2018-09-14T13:31:33.222Z",
    "editedAt": "2018-09-14T13:31:33.219Z",
    "editedBy": {
      "_id": "YgEoq2djbGdjjZnsL",
      "username": "guest-4"
    },
    "urls": []
  }],
  "unreadNotLoaded": 0,
  "success": true
}

Change Log

Version Description
0.70.0 Added

Send a new Livechat offline message.

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

Payload

Argument Example Required Description
name Livechat Visitor Required Message name.
email visitor@rocket.chat Required Message email.
message I need help Required Message text.

Example payload

{
  "name": "Livechat Visitor",
  "email": "visitor@rocket.chat",
  "message": "I need help"
}

Example Call

curl -X POST \
     -H "Content-type:application/json" \
     http://localhost:3000/api/v1/livechat/offline.message \
     -d '{"name": "Livechat Visitor", "email": "visitor@rocket.chat", "message": "I need help"}'

Example Result

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

Change Log

Version Description
0.70.0 Added