Get Online Requests

API will return online requests sending.

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 api - Controller directory name
c REQUIRED chat - Controller name
m REQUIRED get_online_requests - Controller method name
token REQUIRED Application Access Token
user_id REQUIRED Agent ID

Response


{
    "result": "success",
    "language_version": 20171221061942,
    "new_requests": [
        {
            "id": "1160",
            "chat_session_id": "350",
            "message": "Hi, I am getting issue to manage my wallet.",
            "request_type": "new",
            "tag_name": "Accounts",
            "sender_id": "143",
            "name": "Site Visitor",
            "email": "site-visitor@vgamil.com",
            "profile_color": "#2093cd",
            "profile_pic": "",
            "profile_picture": null,
            "agent_id": null,
            "agent_name": null,
            "agent_email": null,
            "agent_profile_color": null,
            "agent_profile_pic": null,
            "agent_profile_picture": null,
            "ip_address": "::1",
            "page_title": "Visitor Chatbox",
            "page_url": "http://localhost/chatbull/chatbox/"
        }
    ]
}

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.