This API is to change the status of the chatbox window to be maximized. So that if the page reloads or the site is opened in a new browser window, the chatbox window will stay maximized.
Resource URL
https://Server Node Environment/index.php
Example : https://api.yourdomain.com/index.php
Resource Information
Parameters |
Values |
Resource Format |
JSON |
Method |
GET |
Requires authentication? |
Yes |
Request
GET Params
Parameters |
Mandatory |
Description |
[Request parameters] |
|
|
d |
REQUIRED |
visitors - Controller directory name |
c |
REQUIRED |
chat - Controller name |
m |
REQUIRED |
maximize - Controller method name |
Headers
Parameters |
Mandatory |
Description |
Accesstoken |
REQUIRED |
Access Token |
Response
{
"error": "",
"result": "success",
"minimized": "no"
}
Messages returned
HTTP STATUS CODE |
Description |
MESSAGE BODY |
200 |
Successfully Return |
Return data in JSON format. |
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. |