API will return agent data like recent-chats, new-requests, offline requests and anonymous_users.
Resource URL
https://Server Node Environment/index.php
Example : https://api.yourdomain.com/index.php
Request
GET Params
Parameters |
Mandatory |
Description |
[Request parameters] |
|
|
d |
REQUIRED |
desktop - Controller directory name |
c |
REQUIRED |
chat - Controller name |
m |
REQUIRED |
index - Controller method name |
token |
REQUIRED |
Application Access Token |
user_id |
REQUIRED |
Agent ID |
Response
{
"result": "success",
"language_version": 20171221061942,
"recent_chats": [],
"new_requests_counter": 0,
"new_requests": [],
"offline_requests_counter": 1,
"anonymous_users": [
{
"site_name": "Localhost",
"site_url": "localhost",
"id": "11",
"site_id": "8",
"operator_id": "0",
"chat_session_id": "0",
"name": "Jaipur",
"email": "",
"message": "Hi",
"profile_color": "#7986cb",
...............
}
]
}
Messages returned
HTTP STATUS CODE |
Description |
MESSAGE BODY |
200 |
Successfully Return |
Return Json data. |
200 |
Authorization Error |
{"result":"failed","error":"Invalid access token or Token has been expired."} |
400 |
Request is malformed |
{"error": "invalid_request", "error_description": "description"} |
403 |
Forbidden |
Directory access is forbidden. |
404 |
Resource Not found |
The page you requested was not found. |