获取指定会话 - API接口文档

请求参数

Query 参数

token

string

调用接口凭证

可选

chatId

string

可选

希望获取数据的对话id

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

返回响应

🟢200成功

application/json

Body

code

string

返回码

必需

data

object

对应的会话数据

必需

chatId

string

系统会话id

必需

assigneeId

string

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

必需

botId

string

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

必需

type

enum<integer>

会话类型

必需

枚举值:

01

wxid

string

当前对象系统id

必需

avatarUrl

string

当前会话的头像链接地址

必需

name

string

当前会话的名字

必需

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

extraInfo

string

当前会话的额外信息

必需

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

contactType

enum<integer>

私聊会话类型

可选

仅私聊会话有这个值

枚举值:

0123

coworker

boolean

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

可选

仅私聊会话有这个值

corporation

string

标识当前账号所属的组织名字

可选

仅私聊会话有这个值

externalUserId

string

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

可选

仅私聊会话有这个值

wecomChatId

string

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

可选

仅群聊会话有这个值

示例

{
    "code": "string",
    "data": {
        "chatId": "string",
        "assigneeId": "string",
        "botId": "string",
        "type": 0,
        "wxid": "string",
        "avatarUrl": "string",
        "name": "string",
        "extraInfo": "string",
        "contactType": 0,
        "coworker": true,
        "corporation": "string",
        "externalUserId": "string",
        "wecomChatId": "string"
    }
}