Detailed Description

Get conversation details

Overview

This API allows client applications to retrieve the details of a single completed conversation.
This is used for Asynchronous messaging. Refer Asynchronous messaging for more details.

Since: 12.0 ES1

APIs

Method	URL	Description
GET	`/ws/v19/clientapplications/messaging/conversation/{ID}`	Retrieve conversation details by its ID.

Authentication

Authentication is required. Only authenticated client applications of type 'Chat' are allowed to access this API. This API must contain the access token returned by the Authentication API.

Permissions

The conversation must be initiated by the client application.

Licenses

N/A

Request

Request headers

Name	Description	Allowed values	Default value
Authorization	Access token for the client. The value must be "Bearer" followed by access token. To elaborate, the value must be "Bearer <access_token>"	N/A	N/A
Accept	Content type accepted by the client.	`application/xml` or `application/json`	N/A
Accept-Language	Language locale accepted by client (used for locale specific fields in resource representation and in error responses)	Supported 'Accept-Language' header codes	`default system language`

Supported API specific query parameters

None

Supported common query parameters

None

Response

Response headers

Name	Description	Possible values
Content-Type	Media type of response body	`application/xml` or `application/json`

Response body XML schemas:

v19-schema-kb-WSError - used in case of error
v19-schema-live-Conversation - used in case of success

Summary attributes always returned in server response

Supported values of some Common Query Parameters that appear in Conversation Resource APIs

HTTP status codes

Success Status codes

200 - OK

The request was successfully executed.

Failure Status codes

400 - Bad Request

Any query parameter is provided in the request.

401 - Unauthorized

Authorization header is not provided.
Authorization header format is incorrect.
Session does not exist corresponding to the provided authorization header.
The session identified through authorization header is not a client application session.

403 - Forbidden

Conversation was not initiated by the logged client application.

404 - Not Found

A conversation with the provided ID does not exist.

406 - Not Acceptable

Invalid 'Accept-Language' header value.

500 - Internal server error

Request processing failed because of internal server error.

Examples:

Example 1 - Get conversation details