获取会话列表

📌

使用场景
此接口用来批量拉取对应小组内的所有会话数据，因为数据量比较大，且系统内的数据库是读写分离的，因此这个接口拉取到的数据可能会有延迟不准确的情况，

请求参数

Query 参数

token

string

调用接口凭证

必需

iterator

string

可选

用来遍历所有数据的迭代器，如果不传，则从最近创建出来的会话开始返回数据，这个值可以从接口的返回值里获取的

pageSize

string

可选

获取数据的页数大小，默认值 10，最大值 1000

返回响应

🟢200成功

application/json

Body

code

string

返回码

必需

nextIterator

string

下一页需要传入的迭代器，仅当下一页存在数据的时候才会返回，如果当前没有下一页数据了，则此值不存在

可选

chats

array [object {13}]

对应的会话数据数组

必需

chatId

string

系统会话id

必需

assigneeId

string

当前会话分配的人，如果为空字符串说明当前对话处于未分配状态uid

必需

botId

string

当前会话所属的托管账号id

必需

type

enum<integer>

会话类型

必需

枚举值:

wxid

string

当前对象系统id

必需

avatarUrl

string

当前会话的名字

必需

如果是私聊会话，且当前好友有备注，则这个值为备注，如果没有备注，则为昵称，如果是群聊会话，则是群名

name

string

当前会话的名字

必需

如果是私聊会话，且当前好友有备注，则这个值为备注，如果没有备注，则为昵称，如果是群聊会话，则是群名

extraInfo

string

当前会话的额外信息

可选

如果是私聊会话，且当前好友有备注，则这个值为昵称，如果没有备注，则此值为空，如果是群聊会话，这个值是当前群的成员数量

contactType

string

私聊会话类型

可选

仅私聊会话有这个值

coworker

string

当前私聊会话对象是否为企业内部成员

可选

仅私聊会话有这个值

corporation

string

当前私聊会话对象是否为企业内部成员

可选

仅私聊会话有这个值

externalUserId

string

当前对话对象的企业微信外部联系人id

可选

仅私聊会话有这个值

wecomChatId

string

当前对话对象的企业微信外部群聊id

可选

仅群聊会话有这个值

示例

{
  "code": "string",
  "nextIterator": "string",
  "chats": [
    {
      "chatId": "string",
      "assigneeId": "string",
      "botId": "string",
      "type\t": 0,
      "wxid": "string",
      "avatarUrl": "string",
      "name": "string",
      "extraInfo": "string",
      "contactType": "string",
      "coworker": "string",
      "corporation": "string",
      "externalUserId": "string",
      "wecomChatId": "string"
    }
  ]
}

请求参数

示例代码

返回响应