获取指定会话

📌

使用场景
此接口适合在接收到某一个会话事件推送之后，当通过事件中的chatId找不到对应的会话信息时，调用此接口获取会话信息因为这个事件大多数情况是建议在通过事件进行触发，因此这个接口有频率调用限制，当前限制为300次/30秒如果有大批量获取会话数据的需求，[获取会话列表]请使用下面的获取会话列表接口(api-73833154)

返回响应

🟢200成功

application/json

Body

code

string

返回码

必需

data

object

对应的会话数据

必需

chatId

string

系统会话id

必需

assigneeId

string

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

必需

botId

string

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

必需

type

enum<integer>

会话类型

必需

枚举值:

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\t": 0,
    "wxid": "string",
    "avatarUrl": "string",
    "name": "string",
    "extraInfo": "string",
    "contactType": 0,
    "coworker": true,
    "corporation": "string",
    "externalUserId": "string",
    "wecomChatId": "string"
  }
}

请求参数

示例代码

返回响应