获取会话列表

返回授权用户当前可见的会话，按最近变化排序。结果可能包含授权前以及其他
发送者或应用产生的可见消息摘要。

请求参数

Authorization

OAuth 2.0

Authorization Code

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Authorize URL: https://api.yearnstudio.cn/oauth/authorize

Token URL: https://api.yearnstudio.cn/oauth/token

Scopes:

im:read-读取可见会话、成员、历史、已读状态并增量同步

Query 参数

返回响应

🟢200

application/json

会话列表。

Bodyapplication/json

示例

{
    "code": 200,
    "msg": "ok",
    "data": {
        "conversations": [
            {
                "id": "string",
                "type": "1:1",
                "name": "string",
                "avatar": "string",
                "announcement": "string",
                "announcement_updated_at": 0,
                "announcement_editor": {
                    "uid": 0,
                    "nickname": "string",
                    "avatar": "string"
                },
                "join_policy": "invite_only",
                "invite_confirmation": true,
                "all_muted": true,
                "owner_uid": 0,
                "created_at": 0,
                "updated_at": 0,
                "pinned_at": 0,
                "pinned": true,
                "last_read_id": 0,
                "peer": {
                    "uid": 0,
                    "nickname": "string",
                    "avatar": "string"
                },
                "my_role": "string",
                "my_muted_until": 0,
                "notifications_muted": true,
                "is_system": true,
                "kind": "string",
                "read_only": true,
                "can_send": true,
                "member_count": 0,
                "online_uids": [
                    0
                ],
                "all_read_id": 0,
                "members": [
                    {
                        "uid": 0,
                        "role": "owner",
                        "muted_until": 0,
                        "info": {
                            "uid": 0,
                            "nickname": "string",
                            "avatar": "string"
                        }
                    }
                ],
                "last_message": {
                    "id": 0,
                    "conversation_id": "string",
                    "sender": {
                        "uid": 0,
                        "nickname": "string",
                        "avatar": "string"
                    },
                    "is_official": true,
                    "content": "string",
                    "msg_type": "string",
                    "mention_uids": [
                        0
                    ],
                    "mention_all": true,
                    "reply": {
                        "message_id": 0,
                        "sender": {
                            "uid": 0,
                            "nickname": "string",
                            "avatar": "string"
                        },
                        "content": "string"
                    },
                    "status": "normal",
                    "recalled_by": {
                        "uid": 0,
                        "nickname": "string",
                        "avatar": "string"
                    },
                    "created_at": 0,
                    "edited_at": 0,
                    "edit_version": 0,
                    "client_message_id": "string",
                    "title": {
                        "app_id": "string",
                        "app_name": "string"
                    },
                    "attachments": [
                        {
                            "id": "string",
                            "filename": "string",
                            "mime_type": "string",
                            "size": 0,
                            "is_image": true,
                            "download_url": "string",
                            "preview_url": "string"
                        }
                    ]
                },
                "unread": 0,
                "mentioned": true
            }
        ]
    }
}

🟠401Unauthorized

🟠403ReadForbidden

🔴500InternalError

🔴503ServiceUnavailable

请求参数

请求示例代码

返回响应