Conclude an engagement

post

/engagement/api/consumer/{fqSiteName}/v1/concludeEngagement

This operation is used by the end user to end a chat engagement with an agent.

Request

Supported Media Types
Path Parameters
Query Parameters
  • The pool ID specified in the Establish Sessions response or provided in an RNEngagementConfigurationChangedMessage system message.
Header Parameters
Body ()
The object containing the request information.
Root Schema : com.rightnow.chat.rest.consumer_api.model.requests.v1.ConcludeEngagementRequest
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

The chat session was concluded successfully.
Body ()
Root Schema : com.rightnow.chat.rest.consumer_api.model.responses.v1.ConcludeEngagementResponse
Type: object
Show Source

400 Response

The validation of the request object failed.
Body ()
Root Schema : schema
Type: object

403 Response

The consumer session identifier is unknown.
Body ()
Root Schema : schema
Type: object

404 Response

The resource was not found.
Body ()
Root Schema : schema
Type: object

500 Response

An error occurred in the chat server while processing the request.
Body ()
Root Schema : schema
Type: object
Back to Top

Examples

The following example shows how to end a chat engagement by submitting a POST request using cURL:

cURL Command Example

curl -X POST "https://chat_rest_server_domain.com/engagement/api/consumer/sdi_11_20_18_2022_21-3586727808788512-Fusion/v1/concludeEngagement?pool=353:2" -H "Accept: application/json;charset=utf-8" -H "Content-Type: application/json" -H "SessionId: 170c233dfi4gy1vkwyw6yxdq1a" -d "{\"clientRequestTime\" : \"2019-01-14T14:35:14.226Z\",\"clientTransactionId\" : 1}"

Request Body Example

The following shows an example of the request body in JSON format.

{
   "clientRequestTime" : "2019-01-14T14:35:14.226Z",
   "clientTransactionId" : 1
}

Response Header Example

The following shows an example of the response header.

Status: 200 OK
Content-Type: application/json;charset=utf-8

Response Body Example

The following shows an example of the response body in JSON format.

{
    "clientRequestTime": "2019-01-14T14:35:14.226Z",
    "serviceStartTime": "2019-01-11T10:12:48.339Z",
    "serviceFinishTime": "2019-01-11T10:12:48.362Z",
    "clientId": 246,
    "clientIdString": "246",
    "clientTransactionId": 1,
    "clientTransactionIdString": "1"
}
Back to Top