Retrieve Chat Messages

get

https://{hostname}/api/talk/chat/v1/messages

This operation returns chat messages for a user. The response may include both one-to-one and group messages. The response can be paginated using the index and count query parameters.

Query Params

count

integer

≤ 100

Defaults to 100

The count of a paginated response, which specifies the number of chat messages to return per page. If not specified, a default of 100 messages is returned. The count cannot exceed 100.

target-user

string

The unique ID of the target user for one-to-one chat messages. Either target-user or target-group must be provided.

target-group

string

The unique ID of the target group for group chat messages. Either target-user or target-group must be provided.

page-token

string

page-token is used to retrieve the next page of results. It is a string that represents the continuation token for pagination. If not specified, the first page of results is returned.

Headers

x-correlation-id

string

A UUID value to track the request, used for debugging and tracing.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

200Successfully retrieved chat messages.

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.

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.

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.