获取会话列表

获取用户会话列表

请求说明

请求地址	https://openapi.wps.cn/v7/chats
请求方法	GET
签名方式	KSO-1
权限要求	查询和管理会话（应用授权） kso.chat.readwrite 查询会话（应用授权） kso.chat.read

请求头（Header）

Header 名称	参数类型	是否必填	说明
Content-Type	string	是	使用：application/json
X-Kso-Date	string	是	RFC1123 格式的日期，例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-Authorization	string	是	KSO-1 签名值，详见《签名方法》
Authorization	string	是	授权凭证，格式为：Bearer {access_token}

查询参数（Query）

名称	参数类型	是否必填	说明
page_size	integer	是	分页大小
page_token	string	否	分页 token

请求地址示例

[GET] https://openapi.wps.cn/v7/chats?page_size={integer}&page_token={string}

响应体

名称	参数类型	说明
code	integer	响应代码。非 0 表示失败，参照《状态码说明》
msg	string	响应信息
data	object	响应数据
∟ items	array[object]	会话列表
∟ ∟ ctime	integer	会话创建时间
∟ ∟ ext_attrs	array[object]	自定义扩展字段
∟ ∟ ∟ name	string	属性名
∟ ∟ ∟ value	string	属性值
∟ ∟ group_ext_attrs	object	群聊扩展字段，当会话类型为群聊 group 时，该字段才有值
∟ ∟ ∟ avatar	object	群聊头像
∟ ∟ ∟ owner_id	string	群主 id
∟ ∟ ∟ settings	object	群组设置
∟ ∟ id	string	会话 id
∟ ∟ name	string	会话标题，当 type=p2p 时，name 字段返回为空
∟ ∟ status	string[enum]	会话状态，默认是活跃的 active：活跃的；dismissed：已解散的
∟ ∟ type	string[enum]	会话类型 p2p：单聊会话；group：群聊会话
∟ next_page_token	string	下一页 token
more	object	更多的错误信息

响应体示例

{
  "code": 0,
  "data": {
    "items": [
      {
        "ctime": 0,
        "ext_attrs": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "group_ext_attrs": {
          "avatar": "object",
          "owner_id": "string",
          "settings": "object"
        },
        "id": "string",
        "name": "string",
        "status": "string[enum]",
        "type": "string[enum]"
      }
    ],
    "next_page_token": "string"
  },
  "msg": "string"
}