Retrieve Completed Bulk Chat Response by ID

get

https://{hostname}/api/talk/chat/v1/messages/async/{id}/response

This operation returns the final response body of a completed asynchronous bulk chat request and includes the same payload as the original synchronous operation would have returned, including success, partial success, or failure details.

Authorization and Permissions

An OpenAM or UKG Authentication token is required to retrieve the response.
The user must have permission to access the bulk chat operation results.

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

200Successfully retrieved the completed bulk chat operation results with all messages delivered successfully.

207The HTTP status code 207 Partial Success response. Some messages were delivered successfully while others failed.

400Bad Request - The bulk chat operation failed completely.

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

404The HTTP status code 404 Not Found error, thrown when the request id is not found or has expired.

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.