[对话]获取对话列表

请求参数

Query 参数

isPin

integer

可选

是否 Pin （留空输出全部）

whitelistKeys

string

可选

白名单键名，只返回给定键名的键值对
多个以英文逗号隔开，支持「点表示法」表示多维数组
仅对 user 参数有效

blacklistKeys

string

可选

黑名单键名，从返回数据中删除指定的键值对
多个以英文逗号隔开，支持「点表示法」表示多维数组
仅对 user 参数有效

pageSize

number

可选

每页显示条数（默认 15 条）

page

number

页码（默认 1）

可选

Header 参数

X-Fresns-App-Id

string

必需

密钥 App ID
密钥位置：控制面板->应用中心->应用密钥

默认值:

X-Fresns-Client-Platform-Id

integer

必需

平台编号，与密钥的「平台」匹配

默认值:

X-Fresns-Client-Version

string

必需

你的客户端版本号，推荐使用语义化版本号

默认值:

X-Fresns-Client-Device-Info

string

必需

交互设备信息 session_logs > device_info
压缩 Object 信息为字符串传参

默认值:

X-Fresns-Aid

string

可选

账号参数（留空则视为未登录账号）

默认值:

X-Fresns-Aid-Token

string

可选

账号身份凭证（传参 aid 时必传）

默认值:

X-Fresns-Uid

integer

可选

用户参数（留空则视为未登录用户）

默认值:

X-Fresns-Uid-Token

string

可选

用户身份凭证（传参 uid 时必传）

默认值:

X-Fresns-Signature

string

签名

必需

X-Fresns-Signature-Timestamp

string

必需

签名生成时间（当前 Unix 时间戳，精确到秒或毫秒都支持）

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'http://localhost:8080/api/v2/conversation/list?isPin=&whitelistKeys=&blacklistKeys=&pageSize	=&page	=' \
--header 'X-Fresns-App-Id;' \
--header 'X-Fresns-Client-Platform-Id;' \
--header 'X-Fresns-Client-Version;' \
--header 'X-Fresns-Client-Device-Info;' \
--header 'X-Fresns-Aid: ' \
--header 'X-Fresns-Aid-Token: ' \
--header 'X-Fresns-Uid: ' \
--header 'X-Fresns-Uid-Token: ' \
--header 'X-Fresns-Signature;' \
--header 'X-Fresns-Signature-Timestamp;'

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

data

object

必需

pagination

object (Pagination)

必需

list

array [object {6}]

必需

示例

{
    "code": 0,
    "message": "ok",
    "data": {
        "pagination": {
            "total": "Number / 一共有多少条数据",
            "pageSize": "Number / 每页有多少条数据",
            "currentPage": "Number / 当前页码",
            "lastPage": "Number / 最后一页页码"
        },
        "list": [
            {
                "id": "Number / 对话 ID",
                "user": {
                    // 与我对话的用户信息，为空表示用户已注销
                    // 通用数据结构->用户信息
                },
                "latestMessage": {
                    "id": "Number / 最新一条消息 ID",
                    "type": "Number / 1.文本消息 2.文件消息",
                    "message": "String / 最新一条消息内容",
                    "datetime": "String / 最新一条消息的时间",
                    "datetimeFormat": "String / 最新一条消息的时间格式化",
                },
                "isPin": "Boolean / 是否置顶",
                "messageCount": "Number / 全部消息数",
                "unreadCount": "Number / 对话框未读消息数"
            }
        ]
    }
}