Skip to content
Message Center

Get Message Group Overview

Returns the message groups of the current Client: each group's name, icon, unread count, badge style, push status, and latest message. Call it when the message center home page loads or refreshes to render the group list.

When the Client opens a group, use its group_id to page through messages with POST /v6/message/inbox/groups/{group_id}/messages, and call DELETE /v6/message/inbox/clear_unreads to mark the group as read.

GEThttps://api.lbkrs.com/v6/message/inbox/groups/summary

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get Message Group Overview” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>

Message groups

Child attributes
group_idinteger

Message group ID defined by the server. Use the returned value instead of hard-coding it

group_namestring

Group name

group_iconstring

Group icon URL for the light theme

group_icon_darkstring

Group icon URL for the dark theme

unreads_countinteger

Number of unread messages in the group

push_channel_enableboolean

Whether push notifications are turned on for the group

badgeinteger

Unread badge style:

  • 0 - Show the unread count
  • 1 - Show a dot only
Values
0
1
last_message_summaryobject

One message in the message center

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

Whale Docs