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 |
api - Controller directory name |
c |
REQUIRED |
chat - Controller name |
m |
REQUIRED |
get_lang_labels - Controller method name |
token |
REQUIRED |
Application Access Token |
Response
{
"result": "success",
"language_version": 20171221061942,
"lang_labels": {
"app_name": "Chatbull",
"app_message": "Support your customer requests wherever you are.",
"btn_login": "LOGIN",
"hint_email": "Email",
"hint_password": "Password",
"text_remember_me": "Remember Me",
"title_forgot_password": "Enter your email",
"title_home": "Home",
"title_new_request": "Request",
"title_live_chat": "Live Chat",
"title_visiting_user": "Visiting User",
"title_activity_canned_messages": "Canned Messages",
"text_cant_access": "Can't access your account?",
"menu_logout": "Logout",
"menu_recent_chat": "Recent Chat",
"menu_chat_history": "Chat History",
"menu_notification": "Notification",
"menu_online": "Online Request",
"menu_offline": "Offline Request",
"menu_profile": "Profile",
"menu_close_session": "Close session",
"menu_put_on_hold": "Put on hold",
"menu_forward_request": "Forward request",
"error_invalid_email": "This email address is invalid",
"error_invalid_password": "This password is too short",
"error_incorrect_password": "This password is incorrect",
"error_field_required": "This field is required",
"hint_write_message_here": "Write your message here...",
"title_activity_chat_screen": "Recent Chat",
"title_activity_chat_history": "Chat History",
"text_message_forgot_password": "Please enter your email address and press \"YES\". Next, check your email for the password reset code.",
"prompt_no_chat_found": "You do not have any chat history. ",
"prompt_no_conversation_found": "You do not have any Conversation. ",
"prompt_no_offline_chat_found": "You do not have any offline history. ",
"prompt_no_new_chat_request": "You do not have any new chat request. ",
"prompt_no_recent_chat_found": "You do not have any recent chat history. ",
"prompt_no_agent_found": "You do not have any agents. You can add them through the Admin panel.",
"prompt_no_department_found": "You do not have any departments. You can add them through the Admin panel.",
"prompt_no_notification_found": "You do not have any notifications. ",
"title_activity_notification": "Notifications",
"title_activity_forword_chat": "Forward Chat",
"title_close_chat": "Close session",
"title_forward_chat": "Forward Request",
"message_close_chat": "Are you sure you want to close this session?",
"message_forward_chat": "Are you sure you want to forward this request?",
"exit_message": "Press again for exit.",
"message_connection_time_out": "Connection Timeout. Please try again.",
"message_forward_to_agent": "Forward request to selected agents?",
"message_forward_to_department": "Forward request to selected department?",
"title_activity_off_line_list": "Offline Requests",
"title_activity_online_chat_list": "New Request",
"title_activity_online_accept": "New Request",
"btn_cancel": "Cancel",
"btn_confirm": "CONFIRM",
"prompt_enter_domain_url": "Enter Domain URL",
"text_agents": "Agents",
"text_department": "Departments",
"btn_validate": "GO",
"btn_okay": "OK",
"btn_yes": "YES",
"btn_no": "NO",
"btn_dismiss": "Dismiss",
"text_send_name": "Send Mail",
"hint_domain_url": "Chatbull URL",
"text_warning": "Warning",
"btn_change_domain_key": "Change Chatbull URL",
"url_hint": "Please enter your valid chat URL. If you don't have that either ask your administrator Or in case you are administrator, you can find this under Setting screen.",
"warning_premium": "Please use your web application to view chat requests and reply to them",
"message_domain_changed_successfully": "Domain name has been updated successfully",
"message_invalid_url": "The URL you have entered might be invalid. Please cross check the same to confirm.",
"text_invalid_url": "invalidUrl",
"accept": "Accept",
"navigation_drawer_open": "Open navigation drawer",
"navigation_drawer_close": "Close navigation drawer",
"prompt_no_canned_message_found": "NO canned message found",
"text_delete": "Delete",
"text_edit": "Edit",
"text_delete_confirmation": "Are you sure to delete this Message?",
"text_message_title": "Title",
"text_message": "Message",
"btn_save": "Save",
"text_visited_pages": "VISITED PAGES",
"text_no_page_title": "No page title"
}
}
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. |