1.1. 客户unionid查询接口
企业可通过客户unionid查询客户相关信息
1.1.1. 请求方法
GET /externalContact/unionid/:unionid?openid=xxx
1.1.2. 请求参数
参数名 |
必填 |
类型 |
说明 |
unionid |
是 |
String |
微信开放平台唯一标识 unionid |
openid |
否 |
String |
企微客户openid |
1.1.3. 返回数据
属性名 |
类型 |
说明 |
code |
整型 |
执行结果码,200表示成功,其他表示错误 |
message |
字符串 |
执行结果说明 |
data |
对象 |
对象数组,每个元素详见上自定义data数据表 |
data(自定义字段列表)
参数名 |
类型 |
说明 |
isExternalUser |
Boolean |
是否是企业的外部联系人(true:是,false:否) |
isGroupUser |
Boolean |
是否是企业的客户群客户(true:是,false:否,这种情况不返回客户群信息) |
externalUserId |
String |
外部联系人 id 或 客户群成员id |
groupList |
对象List |
客户群信息List |
-roomId |
String |
群id |
-roomName |
String |
群名称 |
1.1.4. 请求示例
curl --location --request GET 'https://[子域名].wefeng360.com/api/v1/externalContact/unionid/obLjYs8oDSkHKDDDPUZ6ZlUPS2dY?sign=fbdd2e45e3bd9d1f1e4915863cff62c2d6f901490070741b821ad55d7e231552×tamp=1619143576' --header 'Content-Type: application/json'
返回示例
{
"succeed": true,
"code": 200,
"bizCode": "000000",
"message": "OK",
"visible": false,
"data": {
"isExternalUser": true,
"externalUserId": "wm_3b_EAAAeuh24ce2cDKoCzzmi-wCng",
"isGroupUser": true,
"groupList": [
{
"roomId": "wr_3b_EAAA8idyiNXBGuVm7XP2CkHP-g",
"roomName": "未命名群聊"
},
{
"roomId": "wr_3b_EAAA91axIHB1YQTWBA6AMp9ZSg",
"roomName": "测试3"
},
{
"roomId": "wr_3b_EAAAzV5YTQbo5gOmjNZDqQet3w",
"roomName": "兰博基尼车主群"
}
]
}
}