Links

Get a Monitor

URL
Requires Auth
HTTP Method
api/v1/livechat/monitors/:username
YES
GET

Headers

Argument
Example
Required
Description
X-User-Id
myuser-name
Required
Your username hash (returned after you log in through the API)
X-Auth-Token
myauth-token
Required
Your token (returned after you log in through the API)

Path Parameters

Argument
Example
Required
Description
username
1-agent
Required
The username of the person monitoring

Example Call

curl --location --request GET 'http://localhost:3000/api/v1/livechat/monitors/1-agent' \
--header 'X-Auth-Token: myauth-token' \
--header 'X-User-Id: myuser-name'

Result

{
"_id": "RSb7exHJsiKqwRjPF",
"username": "1-agent",
"emails": [
{
"address": "[email protected]",
"verified": false
}
],
"status": "offline",
"name": "1-agent",
"statusLivechat": "not-available",
"livechat": {
"maxNumberSimultaneousChat": "-4"
},
"success": true
}
Last modified 2mo ago
Deprecation for cloud services and apps is now extended to November 20, 2023. Rocket.Chat versions receive support for six months after release.