# 获取未接入会话列表
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:getwaitcase
本接口用于获取未接入的客户会话列表
# 1. 调用方式
# HTTPS 调用
GET https://api.weixin.qq.com/customservice/kfsession/getwaitcase?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:1、6、100-101
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
无
# 3. 返回参数
# 返回体 Response Payload
参数名 | 类型 | 说明 |
---|---|---|
count | number | 未接入会话数量 |
waitcaselist | objarray | 未接入会话列表,最多返回100条数据,按照来访顺序 |
# Res.waitcaselist(Array) Object Payload
未接入会话列表,最多返回100条数据,按照来访顺序
参数名 | 类型 | 说明 |
---|---|---|
latest_time | number | 用户的最后一条消息的时间 |
openid | string | 用户openid |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
{}
返回示例
{
"count": 150,
"waitcaselist": [
{
"latest_time": 123456789,
"openid": "OPENID"
}
]
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
0 | ok或者in a normal state | ok是指从不正常变成正常 in a normal state是指本来就正常 |
65400 | please enable new custom service or wait for a while if you have enabled | API不可用,即没有开通或升级到新版客服功能 |
# 7. 适用范围
本接口在不同账号类型下的可调用情况:
公众号 | 服务号 |
---|---|
仅认证 | 仅认证 |
- 仅认证:表示仅允许企业主体已认证账号调用,未认证或不支持认证的账号无法调用
- 其他未明确声明的账号类型,如无特殊说明,均不可调用此接口;