Skip to content

[Conversation] List

  • Endpoint Path: /api/fresns/v1/conversation/list
  • Method: GET
  • Request: Query

Headers Optional Parameter

KeyPublic Mode (Required)Private Mode (Required)
X-Fresns-Aidrequiredrequired
X-Fresns-Aid-Tokenrequiredrequired
X-Fresns-Uidrequiredrequired
X-Fresns-Uid-Tokenrequiredrequired

Query Params

KeyTypeRequiredDescription
pinnedBooleanoptionalPin or not (Null to output all)
filterUserTypeStringoptionalwhitelist only returns key-value pairs for the given key names
blacklist removes specified key-value pairs from the returned data
Applies only to the user parameter in the returned result
filterUserKeysStringoptionalMultiple separated by English commas, supports "dot notation" for multi-dimensional arrays
pageSizeNumberoptionalNumber of items per page (default 15 items)
pageNumberoptionalPage number (default 1)

Return

json
{
    "code": 0,
    "message": "ok",
    "data": {
        "pagination": {
            "total": "Number / How much data in total",
            "pageSize": "Number / How much data on each page",
            "currentPage": "Number / Current page number",
            "lastPage": "Number / Last page number"
        },
        "list": [
            {
                "user": {
                    // User information for the conversation with me, empty if the user has been deactivated.
                    // Common Data Structure -> User Info
                },
                "latestMessage": {
                    "cmid": "String / Latest message ID",
                    "type": "String / text or file",
                    "message": "String / Latest message content",
                    "datetime": "String / Time of the latest message",
                    "datetimeFormat": "String / Formatted time of the latest message",
                    "timeAgo": "String / Humanization time",
                },
                "pinned": "Boolean / Whether pinned",
                "messageCount": "Number / Total message count",
                "unreadCount": "Number / Unread message count in the conversation"
            }
        ]
    }
}

Released under the Apache-2.0 License