第三方应用开发 服务端API 微信客服 其他基础信息获取 获取客户基础信息
获取客户基础信息

请求方式: 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_listexternal_userid列表
可填充个数:1 ~ 100。超过100个需分批调用。
need_enter_session_context是否需要返回客户48小时内最后一次进入会话的上下文信息。
0-不返回 1-返回。默认不返回

 

权限说明:

  • 企业需要使用“微信客服”secret所获取的accesstoken来调用(accesstoken如何获取?
  • 第三方应用需具有“微信客服权限->获取基础信息”权限
  • 代开发自建应用需具有“微信客服权限->获取基础信息”权限

 

返回结果:

{
    "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"
	]
}

参数说明:

参数类型说明
errcodeint返回码
errmsgstring错误码描述
customer_listarray返回结果
customer_list.external_useridstring微信客户的external_userid
customer_list.nicknamestring微信昵称
customer_list.avatarstring微信头像。第三方不可获取
customer_list.genderint性别
customer_list.unionidstringunionid,需要绑定微信开发者帐号才能获取到,查看绑定方法。第三方不可获取
customer_list.enter_session_contextobj48小时内最后一次进入会话的上下文信息。
请求的need_enter_session_context参数设置为1才返回
customer_list.enter_session_context.scenestring进入会话的场景值,获取客服帐号链接开发者自定义的场景值
customer_list.enter_session_context.scene_paramstring进入会话的自定义参数,获取客服帐号链接返回的url,开发者按规范拼接的scene_param参数
customer_list.enter_session_context.wechat_channelsobj进入会话的视频号信息,从视频号进入会话才有值
customer_list.enter_session_context.wechat_channels.nicknamestring视频号名称

如何获取微信客户的unionid

  1. 在企业微信管理后台“应用管理-微信客服-通过API管理微信客服”处,点击“绑定”去到微信公众平台进行授权,支持绑定公众号和小程序(需要同时绑定微信开放平台);绑定的公众号或小程序主体需与企业微信主体一致,暂且支持绑定一个
  2. 绑定完成后,即可通过此接口获取微信客服所对应的微信unionid

上一篇
「升级服务」配置
下一篇
获取企业状态信息