This API is to authenticate the agent's account during the login process.
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 |
users - Controller name |
m |
REQUIRED |
authentication - Controller method name |
POST Params
Parameters |
Mandatory |
Description |
[Request parameters] |
|
|
email |
REQUIRED |
Login Email Address |
password |
REQUIRED |
Login Password |
Response
{
"error": "",
"result": "success",
"language_version" 20171221061942,
"id": "2",
"email": "operator@yourdomain.com",
"profile_color": "#20a15d",
"display_name": "Operator",
"profile_picture": "",
"token": "RHv9lkrdUNPmOjt028Sf",
"settings": {
"enable_canned_messages": "yes",
"enable_agent_initiate_chats": "yes",
"enable_agent_file_sharing": "yes",
"agent_allowed_filetypes": ".pdf|.docx|.txt|.gif|.jpg|.png",
"agent_file_upload_size": "500",
"admin_panel_logo": "http://yourdomain.com/chatbull/assets/cmodule/images/logo.png",
"admin_panel_name": "ChatBull",
"agent_time_interwal": "4",
"operator_chat_theme": "bubbles-boom",
"admin_panel_email": "admin@yourdomain.com",
"plugin_validated": "yes"
}
}
Messages returned
HTTP STATUS CODE |
Description |
MESSAGE BODY |
200 |
Successfully Return |
Return data in JSON format. |
200 |
Authorization Error |
{"result":"failed","language_version":20171221061942,"error":"Your ID or email does not found in our records. Please try entering the correct email address again."} |
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. |