Jump to

• Request
• Response
• Examples

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

• application/json; charset=utf-8

Path Parameters

• fqSiteName: string
  The name of the site returned by the call to establish a session.

Query Parameters

• pool: string
  The pool ID specified in the Establish Sessions response or provided in an RNEngagementConfigurationChangedMessage system message.

Header Parameters

• SessionId: string
  The unique identifier of the consumer session.

Body ()

The object containing the request information.

Root Schema : com.rightnow.chat.rest.consumer_api.model.requests.v1.ConcludeEngagementRequest

Type: object

Show Source

• clientRequestTime(optional): string
  The local time of the requesting client in yyyy-MM-dd'T'HH:mm:ssXXX format.
• clientTransactionId(optional): integer(int64)
  The unique identifier of the client transaction. The value specified in this field is echoed back in the response object. It is used to link requests to responses.

{
    "properties":{
        "clientRequestTime":{
            "type":"string",
            "description":"The local time of the requesting client in yyyy-MM-dd'T'HH:mm:ssXXX format."
        },
        "clientTransactionId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of the client transaction. The value specified in this field is echoed back in the response object. It is used to link requests to responses."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json; charset=utf-8

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

• clientId(optional): integer(int64)
  The unique identifier of the client.
• clientIdString(optional): string
  The unique identifier of the client as a String.
• clientRequestTime(optional): string
  The local time of the requesting client in yyyy-MM-dd'T'HH:mm:ssXXX format.
• clientTransactionId(optional): integer(int64)
  The unique identifier of the client transaction. The value specified in this field is echoed back in the response object. It is used to link requests to responses.
• clientTransactionIdString(optional): string
  The unique identifier of the client transaction as a String.
• serviceFinishTime(optional): string
  The time when the request processing completed in yyyy-MM-dd'T'HH:mm:ssXXX format.
• serviceStartTime(optional): string
  The time when the request processing started in yyyy-MM-dd'T'HH:mm:ssXXX format.

{
    "properties":{
        "clientRequestTime":{
            "type":"string",
            "description":"The local time of the requesting client in yyyy-MM-dd'T'HH:mm:ssXXX format."
        },
        "clientTransactionId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of the client transaction. The value specified in this field is echoed back in the response object. It is used to link requests to responses."
        },
        "clientTransactionIdString":{
            "type":"string",
            "description":"The unique identifier of the client transaction as a String."
        },
        "serviceStartTime":{
            "type":"string",
            "description":"The time when the request processing started in yyyy-MM-dd'T'HH:mm:ssXXX format."
        },
        "serviceFinishTime":{
            "type":"string",
            "description":"The time when the request processing completed in yyyy-MM-dd'T'HH:mm:ssXXX format."
        },
        "clientId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of the client."
        },
        "clientIdString":{
            "type":"string",
            "description":"The unique identifier of the client as a String."
        }
    }
}

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/day119_181100_sql_238h/v1/concludeEngagement?pool=297:1 -H 'Content-Type: application/json; charset=UTF-8' -H 'SessionId: 192hyto5qomm8r8rpzzmuzsa6' -d '{}'

Request Body Example

The following shows an example of the request body in JSON format. For this operation it is an empty payload.

{}

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": null,
    "serviceStartTime": "2018-10-23T14:14:48.063Z",
    "serviceFinishTime": "2018-10-23T14:14:48.081Z",
    "clientId": 34,
    "clientIdString": "34",
    "clientTransactionId": 0,
    "clientTransactionIdString": "0"
}

Back to Top