获取聊天工具上下文
最后更新：2026/11/02企业可通过此接口，使用自定义聊天工具跳转地址中的一次性 launch_code，获取当前客户单聊或客户群聊的上下文信息。仅适用于已开启上下文传参且使用 CODE 模式的聊天工具，返回字段以兑换时的最新工具配置为准。
请求方式： POST（HTTPS）
请求地址： https://open.wshoto.com/openapi/chat/tool/context?access_token=ACCESS_TOKEN
Query参数：
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token | string | 是 | 调用接口凭证，获取方式见获取access_token |
| tenant_id | string | 条件必填 | 服务商或内建应用调用时必填，取聊天工具跳转地址中的 tenantId；普通企业应用由接口凭证确定企业 |
Body参数：
{
"launch_code": "LAUNCH_CODE"
}
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| launch_code | string | 是 | 打开聊天工具时，跳转地址中携带的一次性兑换码。需原样提交，不能为空或纯空白字符串；自签发起有效期为60秒，消费后立即失效 |
返回值：
客户单聊场景示例（已开启员工ID、客户ID及unionId传参，且可获取到unionId）：
{
"code": 0,
"sub_code": "00000",
"msg": "请求成功",
"data": {
"scene": "external_contact",
"user_id": "woDkH9EAAAQ4Hd2W7oxKMw4j0HkQMI4w",
"external_user_id": "wmDkH9EAAAQ4Hd2W7oxKMw4j0HkQMI4w",
"chat_id": null,
"union_id": "oDkH9EAAAQ4Hd2W7oxKMw4j0HkQMI4w"
}
}
客户群聊场景示例（已开启员工ID及客户群ID传参）：
{
"code": 0,
"sub_code": "00000",
"msg": "请求成功",
"data": {
"scene": "external_group",
"user_id": "woDkH9EAAAQ4Hd2W7oxKMw4j0HkQMI4w",
"external_user_id": null,
"chat_id": "wrvvCXcAAA3e7J0cJ8DOtWBalgJfIqxg",
"union_id": null
}
}
参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| code | int | 出错返回码，为0表示成功，非0表示调用失败 |
| sub_code | string | 业务返回码 |
| msg | string | 对返回码的文本描述内容 |
| data | object | 聊天上下文信息 |
| scene | string | 会话场景，成功时始终返回：external_contact-客户单聊，external_group-客户群聊 |
| user_id | string | 当前企微员工ID，关闭员工ID传参开关时为空 |
| external_user_id | string | 当前单聊客户的externalUserId，群聊场景或关闭客户ID传参开关时为空 |
| chat_id | string | 当前客户群的chatId，单聊场景或关闭客户群ID传参开关时为空 |
| union_id | string | 当前单聊客户的unionId，未获取到unionId、群聊场景或关闭unionId传参开关时为空 |
注意事项：
- 接口鉴权确定的企业需与签发
launch_code的企业一致。 launch_code只能消费一次。兑换过程中一旦消费，即使后续校验或业务处理失败也不会恢复；兑换码过期、已使用或调用结果不确定时，应重新打开聊天工具获取新的兑换码。- 每次兑换均按聊天工具的最新配置校验。工具已删除、关闭上下文传参或改为 QUERY 模式时，原兑换码无法再兑换上下文。
scene始终返回，其余字段由对应传参开关及会话场景决定；关闭传参开关、不适用当前场景或无值的字段为空。