Retrieve Chat Conversation by ID

get

https://{hostname}/api/talk/chat/v1/conversations/{conversationId}

This operation returns a chat conversation by ID.

Design Note

Conversations are implicitly created when messages are sent via the Chat Messages operation (POST /chat/v1/messages). The Chat Conversations API resource provides only GET and DELETE operations. There are no POST or PATCH operations for conversations as they are managed automatically through message creation.

Authorization and Permissions

An OpenAm or UKG Authentication token is required to retrieve a conversation.

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

200Successfully retrieved a conversation.

400The HTTP status code 400 Bad Request error, thrown when required parameters are not passed.

401The HTTP status code 401 Unauthorized error, thrown when the user is not authorized to access the resource.

403The HTTP status code 403 Forbidden error, thrown when the user is not authorized to access the resource.

404The HTTP status code 404 Not Found error, thrown when the conversation is not found.

405The HTTP status code 405 Method Not Allowed error, thrown when you attempt to call a URI with an unsupported HTTP method.

406The HTTP status code 406 Not Acceptable Content error, thrown when you send a request with accept header other than application/json.

413The HTTP status code 413 Payload Too Large error, thrown when you attempt to pass a request payload that exceeds the limit.

429The HTTP status code 429 Too Many Requests error, thrown when the user exceeds the allowed rate limit for the API.

500The HTTP status code 500 Internal Server error, thrown when the server is not able to process the request.