Get User(Agent) Notifications

API will update agent activity on server to show he is online.

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 users - Controller name
m REQUIRED notifications - Controller method name
token REQUIRED Application Access Token
user_id REQUIRED Agent ID

Response


{
    "result": "success",
    "language_version": 20171221061942,
    "notifications": [
        {
            "id": "2551",
            "chatSessionId": "349",
            "requestId": "1159",
            "message": "Hi, I am getting issue to manage my wallet.",
            "displayMessage": "Site Visitor sent you new request.",
            "senderId": "143",
            "notificationType": "online_request",
            "name": "Site Visitor",
            "profile_color": "#2093cd",
            "email": "site-visitor@vgamil.com",
            "profilePic": null
        },
        {
            "id": "2540",
            "chatSessionId": "346",
            "requestId": "1157",
            "message": "Hi, I need your help",
            "displayMessage": "Site Visitor2 sent you new request.",
            "senderId": "140",
            "notificationType": "online_request",
            "name": "Site Visitor2",
            "profile_color": "#ba68c8",
            "email": "site-visitor2@vgamil.com",
            "profilePic": null
        }
    ]
}

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.