请求方式: POST(HTTPS)
请求地址: https://qyapi.weixin.qq.com/cgi-bin/kf/customer/batchget?access_token=ACCESS_TOKEN
请求实例:
{
"external_userid_list": [
"wmxxxxxxxxxxxxxxxxxxxxxx",
"zhangsan"
],
"need_enter_session_context": 0
}
参数说明:
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
external_userid_list | 是 | external_userid列表 可填充个数:1 ~ 100。超过100个需分批调用。 |
need_enter_session_context | 否 | 是否需要返回客户48小时内最后一次进入会话的上下文信息。 0-不返回 1-返回。默认不返回 |
权限说明:
返回结果:
{
"errcode": 0,
"errmsg": "ok",
"customer_list": [
{
"external_userid": "wmxxxxxxxxxxxxxxxxxxxxxx",
"nickname": "张三",
"avatar": "http://xxxxx",
"gender": 1,
"unionid": "oxasdaosaosdasdasdasd",
"enter_session_context": {
"scene": "123",
"scene_param": "abc",
"wechat_channels": {
"nickname": "进入会话的视频号名称"
}
}
}
],
"invalid_external_userid": [
"zhangsan"
]
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
errcode | int | 返回码 |
errmsg | string | 错误码描述 |
customer_list | array | 返回结果 |
customer_list.external_userid | string | 微信客户的external_userid |
customer_list.nickname | string | 微信昵称 |
customer_list.avatar | string | 微信头像。第三方不可获取 |
customer_list.gender | int | 性别 |
customer_list.unionid | string | unionid,需要绑定微信开发者帐号才能获取到,查看绑定方法。第三方不可获取 |
customer_list.enter_session_context | obj | 48小时内最后一次进入会话的上下文信息。 请求的need_enter_session_context参数设置为1才返回 |
customer_list.enter_session_context.scene | string | 进入会话的场景值,获取客服帐号链接开发者自定义的场景值 |
customer_list.enter_session_context.scene_param | string | 进入会话的自定义参数,获取客服帐号链接返回的url,开发者按规范拼接的scene_param参数 |
customer_list.enter_session_context.wechat_channels | obj | 进入会话的视频号信息,从视频号进入会话才有值 |
customer_list.enter_session_context.wechat_channels.nickname | string | 视频号名称 |