Skip to content
Message Center

List Messages in a Group

Returns the messages in one message group with cursor pagination. Call it when the Client opens a group or scrolls to load more. Pass 0 as page_query.tail_mark for the first page, then pass next_page_query.tail_mark from the previous response. An empty list, or fewer items than page_size, means there are no more messages.

Reading messages does not change their read status. To clear the group's unread messages, call DELETE /v6/message/inbox/clear_unreads.

The price alert history page also uses this operation to read the alert message group and show triggered price alerts.

POSThttps://api.lbkrs.com/v6/message/inbox/groups/{group_id}/messages

Parameters

group_idintegerpathRequired

Message group ID from list[].group_id of GET /v6/message/inbox/groups/summary

Request body application/json

group_idintegerrequired

Message group ID. Use the same value as the group_id path parameter

page_queryobjectrequired

Cursor pagination parameters

Child attributes
page_sizeintegerrequired

Number of messages per page

tail_markintegerrequired

Pagination cursor. Pass 0 for the first page. For the next page, pass next_page_query.tail_mark from the previous response

Responses

HTTP 200The request succeeded. The response body contains the result of the “List Messages in a Group” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>

Messages on this page

Child attributes
idinteger

Message ID. Use it in ids of DELETE /v6/message/inbox/clear_unreads

titlestring

Message title

bodystring

Message body

coverstring

Cover image URL. When it is empty, show the message as text without a cover

linkstring

Destination opened when the Client selects the message. An empty value means the message has no destination

statusinteger

Message status. 1 means read

send_timeinteger

Send time as a Unix timestamp in milliseconds

next_page_queryobject

Cursor pagination parameters

Child attributes
page_sizeintegerrequired

Number of messages per page

tail_markintegerrequired

Pagination cursor. Pass 0 for the first page. For the next page, pass next_page_query.tail_mark from the previous response

Whale Docs