Create new Online Request

API will create a new online request.

Resource URL

https://Server Node Environment/index.php

Example : https://api.yourdomain.com/index.php

Resource Information

Parameters Values
Resource Format JSON
Method POST
Requires authentication? Yes

Request

GET Params

Parameters Mandatory Description
[Request parameters]
d REQUIRED visitors - Controller directory name
c REQUIRED chat - Controller name
m REQUIRED request - Controller method name

Headers

Parameters Mandatory Description
Accesstoken REQUIRED Access Token

POST Params

Parameters Mandatory Description
[Request parameters]
page_title REQUIRED Site page title where chatbox is showing
page_url REQUIRED Site page URL where chatbox is showing
name REQUIRED customer(visitor) name
email REQUIRED customer email address
message REQUIRED customer message
sort_order REQUIRED Time in milliseconds based on Server Time
requested_tag OPTIONAL Tag (Department) ID
agent_id OPTIONAL Agent ID which will handle request and return agent detail in response
initiate_bypass_chat OPTIONAL yes or no will define user detail is real or randomly generated

Response


{
    "error": "",
    "result": "success",
    "data": {
        "visitor": {
            "id": "131",
            "email": "site-visitor@pkpwssib.com",
            "pass": "",
            "name": "Site Visitor",
            "display_name": "Visitor",
            "profile_pic": "",
            "profile_color": "#e4c62e",
            "role": "visitor",
            "created_at": "2018-05-26 07:06:53",
            "modified_at": "2018-05-26 07:06:53",
            "contact_number": "",
            "remember_token": "",
            "last_activity_time": "0000-00-00 00:00:00",
            "mobile_last_activity_time": "0000-00-00 00:00:00",
            "desktop_last_activity_time": "0000-00-00 00:00:00",
            "last_login": "0000-00-00 00:00:00",
            "user_status": "active",
            "profilePic": ""
        },
        "agent": {
            "id": 0,
            "name": 0,
            "profilePic": ""
        },
        "chat_session": {
            "id": "338",
            "site_id": "8",
            "user_agent": "Mozilla\/5.0 (Windows NT 10.0; Win64; x64; rv:60.0) Gecko\/20100101 Firefox\/60.0",
            "port": "",
            "requested_tag": "0",
            "supported_tags": null,
            "session_status": "requested",
            "session_type": "public"
        },
        "chatHistory": [
            {
                "id": 4166,
                "chat_session_id": 338,
                "chat_message": "I am a new customer.",
                "sender_id": "131",
                "name": "Visitor",
                "sort_order": "1527318412724"
            }
        ],
        "last_id": 4166,
        "message_stored": [4166]
    }
}

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.