End Chat Session

API will send a request to end chat session. It will end current chat session if feedback setting is disable.

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

Headers

Parameters Mandatory Description
Accesstoken REQUIRED Access Token

POST Params

Parameters Mandatory Description
[Request parameters]
send_chat_transcript REQUIRED yes or no
visitor_email REQUIRED Visitor Email Address on where he want to get chat transcript

Response


{
    "error": "",
    "result": "success",
    "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": "closed",
        "session_type": "public"
    },
    "message": "Chat session has been closed."
}

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.