Send a Message to Anonymous Visitor

API will send a message to anonymous visitor.

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 api - Controller directory name
c REQUIRED anonymous_chat - Controller name
m REQUIRED send - Controller method name
token REQUIRED Application Access Token

POST Params

Parameters Mandatory Description
[Request parameters]
temp_visitor_id REQUIRED Anonymous(Visiting) Visitor ID
sender_id REQUIRED Agent or Operator ID
chat_message REQUIRED Message
message_status REQUIRED unread ( read or unread )
sort_order REQUIRED Time in milliseconds based on Server Time

Response


{
    "result": "success",
    "language_version": 20171221061942,
    "initiated": true,
    "message_row": {
        "chat_message": "Are you there",
        "temp_visitor_id": "18",
        "message_status": "unread",
        "sender_id": "5",
        "sort_order": "1527576556935",
        "local_id": "ad51527576556935",
        "created_at": "2018-05-29 07:14:18"
    }
}

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.