接口说明:获取客户详情,根据客户Id获取客户详情信息,如果该用户没有该参数值,那么将不会返回该参数字段。
限制说明:允许一秒请求一次,否则返回:操作频繁,请稍后重试
应用权限: 用户->用户资料
访问路径 : /api/audience/detail
Type: POST
Author: zhuyanpeng
Content-Type: application/json; charset=utf-8
Description: 获取客户详情
Body-parameters:
Parameter | Type | Required | Description |
---|---|---|---|
companyId | string | false | 第三方平台企业id |
audienceUserIdList | array | false | 用户档案ID集合 |
thirdIdList | array | false | 第三方客户ID集合 |
phoneList | array | false | 手机号集合 |
instanceAppid | string | false | 应用实例ID |
传参注意:
1.audienceUserIdList,thirdIdList,phoneList这3个集合参数不能同时为空。
2.如果companyId不传,会通过token校验拿到当前数据集成对应的企业信息,去查询用户信息返回。
3.如果要查询数据集成应用下面子企业的客户信息,那么companyId一定要传。
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | string | 状态码 | - |
errorCode | string | 错误状态码 | - |
msg | string | 状态描述 | - |
data | array | 数据 | - |
└─orgId | string | 兔展企业Id | - |
└─createTime | string | 创建时间,时间戳 | - |
└─audienceUserId | int64 | 客户ID | - |
└─openids | array | openid列表 "openids": [ ...... | - |
└─openid | string | 如果是企业微信,那么存的是客户联系external_userid、 userid | - |
└─unionid | string | 微信的unionid、如果是企业微信,那么存的是客户联系unionid | - |
└─fromTo | string | contentminiapp 小程序,workwechat 企业微信外部联系人,gzh 公众号、workwechatgroup 客户群 | - |
└─appid | string | 如果是小程序则小程序id,公众号则公众号ID,企业微信则企业微信ID 企业微信成员 workwechat_employee | - |
└─platform | string | 平台:gzh,workwechat (第三方的外部联系人)、selfbuilt(自建应用外部联系人)、YOUZAN、EZR、RP_LSY (兔展零售云) | - |
└─jcappid | int64 | 系统集成的应用ID | - |
└─identityId | string | 系统集成身份ID | - |
└─identityType | string | 系统集成的身份类型" //如 phone 手机、uid 用户ID,openid 微信openid | - |
└─unionid | string | 微信unionid | - |
└─mpAppid | string | 公众号appid | - |
└─phoneList | array | 手机号码列表 "phoneList": [ | - |
└─phone | string | 手机号 | - |
└─isVerify | string | 0未验证 1 验证 | - |
└─realName | string | 真实姓名 | - |
└─sex | int32 | 性别(1 男 2 女 0 未知) | - |
└─avatar | string | 头像 | - |
└─wxNickname | string | 微信昵称 | - |
└─wxCountry | string | 微信资料获取的国家名称 | - |
└─wxProvince | string | 微信资料获取的省名称 | - |
└─wxCity | string | 微信资料获取的市名称 | - |
└─province | string | 最近通过IP获取的省名称 | - |
└─city | string | 最近通过IP获取的市名称 | - |
└─lbsProvince | string | 通过地理位置授权获取的省名称 | - |
└─lbsCity | string | 通过地理位置授权获取的市名称 | - |
└─addressList | array | 地址列表 | - |
└─any object | object | - | |
└─birthday | int64 | 生日 ,时间戳 | - |
└─remark | string | 备注 | - |
└─lastActiveTime | int64 | 最近活跃时间 ,时间戳 | - |
└─gzhInteractTime | int64 | 公众号最后互动时间 ,时间戳 | - |
└─markFlag | int32 | 是否星标 1 是 0 否 | - |
└─userType | array | 用户类型列表 ["个人","商家"] | - |
└─any object | object | any object. | - |
└─payFeature | string | 付款特点 | - |
└─industry | array | 行业 ["科技服务/互联网"] | - |
└─any object | object | any object. | - |
└─subWechatList | array | 客户关注的公众号列表 [{"appid":"123456","wechatName":"兔展"}] | - |
└─any object | object | any object. | - |
└─sourceAudid | int64 | 创建客户档案时的上一层级传播客户Id | - |
└─sourceCnl | int64 | 创建客户档案时的来源渠道 | - |
└─sourceCnlName | string | 创建客户档案时来源渠道的名称(员工=姓名,自有渠道=名称,如果后续还有门店渠道则显示门店名称) | - |
└─sourceCnlDeptId | int64 | 创建客户档案时的来源渠道部门Id | - |
└─sourceCnlDeptName | string | 创建客户档案时的来源渠道部门的名称 | - |
└─sourceCnlType | string | 创建客户档案时的来源渠道类型 EMPLOYEE 员工 FIXED 自有渠道 | - |
└─sourceAppType | string | 创建客户档案时的来源作品类型: 微信 | - |
└─active | int64 | 总活跃度 | - |
└─weekActive | object | 7天活跃度 {"count":数量,"updateTime":时间戳} | - |
└─monthActive | object | 30天活跃度 {"count":数量,"updateTime":时间戳} | - |
└─spread | int64 | 传播力 | - |
└─weekSpread | object | 7天传播力 {"count":数量,"updateTime":时间戳} | - |
└─monthSpread | object | 30天传播力 {"count":数量,"updateTime":时间戳} | - |
└─phone | string | 手机号码 | - |
└─wechatList | array | 授权公众号列表,取关不会删除 | - |
└─appid | string | 公众号appid | - |
└─wechatName | string | 公众号名称 | - |
└─gzhInteractTime | int64 | 公众号互动时间 | - |
└─firstSubDate | int64 | 第一次关注时间 | - |
└─firstSubSourceCnlType | string | 第一次关注的来源渠道类型 | - |
└─firstSubSourceCnl | int64 | 第一次关注的来源渠道id | - |
└─firstSubSourceCnlDeptId | int64 | 第一次关注的来源渠道部门id | - |
└─firstSubSourceTaskId | int64 | 第一次关注的来源任务id | - |
└─thirdId | string | 第三方用户ID | - |
Request-body-example:
{
"companyId": "31",
"audienceUserIdList": [
747
],
"thirdIdList": [
"0rtxiw"
],
"phoneList": [
"ncqtyf"
],
"instanceAppid": "31"
}
Response-example:
{
"code": "28930",
"errorCode": "28930",
"msg": "l1j777",
"data": [
{
"orgId": "31",
"createTime": "2022-03-24 12:47:34",
"audienceUserId": 643,
"openids": [
{
"openid": "31",
"unionid": "31",
"fromTo": "hryywg",
"appid": "31",
"platform": "yikbqe",
"jcappid": 412,
"identityId": "31",
"identityType": "qz80ur"
}
],
"unionid": "31",
"mpAppid": "31",
"phoneList": [
{
"phone": "13339938205",
"isVerify": "h4bkzc"
}
],
"realName": "俊驰.莫",
"sex": 1,
"avatar": "xkmkv8",
"wxNickname": "jae.cronin",
"wxCountry": "37jht5",
"wxProvince": "sbka26",
"wxCity": "z1d314",
"province": "pv8rcs",
"city": "fsx43h",
"lbsProvince": "lwh51z",
"lbsCity": "ymc70x",
"addressList": [
{}
],
"birthday": 1648097250890,
"remark": "vt9tc7",
"lastActiveTime": 1648097250890,
"gzhInteractTime": 1648097250890,
"markFlag": 1,
"userType": [
{}
],
"payFeature": "xp3sds",
"industry": [
{}
],
"subWechatList": [
{}
],
"sourceAudid": 237,
"sourceCnl": 907,
"sourceCnlName": "俊驰.莫",
"sourceCnlDeptId": 481,
"sourceCnlDeptName": "俊驰.莫",
"sourceCnlType": "u9va12",
"sourceAppType": "mob8vf",
"active": 277,
"weekActive": {
"waring": "You may have used non-display generics."
},
"monthActive": {
"waring": "You may have used non-display generics."
},
"spread": 626,
"weekSpread": {
"waring": "You may have used non-display generics."
},
"monthSpread": {
"waring": "You may have used non-display generics."
},
"phone": "13339938205",
"wechatList": [
{
"appid": "31",
"wechatName": "俊驰.莫",
"gzhInteractTime": 1648097250890,
"firstSubDate": 920,
"firstSubSourceCnlType": "98nzml",
"firstSubSourceCnl": 193,
"firstSubSourceCnlDeptId": 206,
"firstSubSourceTaskId": 598
}
],
"thirdId": "31"
}
]
}
Curl-example:
curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -i https://devintegrate.rabbitpre.com/api/open/api/audience/detail --data '{ "companyId": "31", "audienceUserIdList": [ 747 ], "thirdIdList": [ "0rtxiw" ], "phoneList": [ "ncqtyf" ], "instanceAppid": "31" }'