Send a Message

API will send a new message in current chat session to agents.

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 send - Controller method name

Headers

Parameters Mandatory Description
Accesstoken REQUIRED Access Token

POST Params

Parameters Mandatory Description
[Request parameters]
sender_id REQUIRED Sender ID
name REQUIRED Sender name
chat_session_id REQUIRED Chat Session ID
chat_message REQUIRED message
sort_order REQUIRED Time in milliseconds based on Server Time
message_status REQUIRED read or unread

Response


{
    "error": "",
    "result": "success",
    "message_row": {
        "chat_session_id": "339",
        "sender_id": "5",
        "chat_message": "Hello how can i help you.",
        "local_id": "vwb51527321864007",
        "sort_order": "1527321864007",
        "message_status": "unread",
        "created_at": "2018-05-26 09:08:54",
        "id": 4167
    }
}

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.