Send Visitor navigation history

Prev Next
Post
/api/v1/livechat/page.visited

Retrieves the pages your omnichannel user navigated on your website.

Body parameters
Example 1
{
  "token": "iNKE8a6k6cjbqWhWd",
  "rid": "vp3D9H8ud6HYvRpvq",
  "pageInfo": {
    "change": "url",
    "title": "",
    "location": {
      "href": "http://localhost:3000/packages/rocketchat_livechat/assets/demo.html#page-4"
    }
  }
}
Expand All
object
token
string Required

Enter the visitor token.

rid
string

Enter the room ID.

pageInfo
object Required

Enter the page information

change
string Required
title
string Required
location
object Required
href
string Required
Responses
200

OK

Success Example
{
  "page": {
    "msg": " - file:///C:/Users/xyz/livechat/helloWorld.html",
    "navigation": {
      "page": {
        "change": "url",
        "title": "",
        "location": {
          "href": "file:///C:/Users/xyz/livechat/helloWorld.html"
        }
      },
      "token": "38cc8c765bf77e943f6e4319c5891f6c40d8538ce83473c8987562ea1d762d04"
    }
  },
  "success": true
}
Expand All
object
page
object
msg
string
navigation
object
page
object
change
string
title
string
location
object
href
string
token
string
success
boolean
400

Bad Request

Example 1
{
  "success": false,
  "error": "must have required property 'token' [invalid-params]",
  "errorType": "invalid-params"
}
Example 2
{
  "success": false,
  "error": "must have required property 'pageInfo' [invalid-params]",
  "errorType": "invalid-params"
}
object
success
boolean
error
string
errorType
string