批量获取客户详情
企业可通过此接口批量获取客户详情。
请求方式: POST(HTTPS)
请求地址: https://open.wshoto.com/openapi/customer/batch/info
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 调用接口凭证 |
Body参数:
{
"external_userids" : ["woAJ2GCAAAXtWyujaWJHDDGi0mACHAAA"],
"field_map" : {
"customField" : "customValue"
}
}
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
external_userids | string[] | 是 | 外部联系人id。 一次不超过100个 |
field_map | map | 否 | 自定义字段搜索条件 |
返回值:
{
"code": 0,
"msg": "请求成功",
"data": [
{
"external_userid": "woAJ2GCAAAXtWyujaWJHDDGi0mACHAAA",
"name": "李四",
"position": "Manager",
"avatar": "http://p.qlogo.cn/bizmail/IcsdgagqefergqerhewSdage/0",
"corp_name": "极速快递",
"corp_full_name": "极速快递有限公司",
"type": 2,
"gender": 1,
"unionid": "ozynqsulJFCZ2z1aYeS8h-nuasdAAA",
"follow_user": [
{
"userid": "rocky",
"remark": "李部长",
"description": "对接采购事务",
"createtime": 1608269181797,
"tags": [
{
"group_name": "标签分组名称",
"tag_name": "标签名称",
"tag_id": "etAJ2GCAAAXtWyujaWJHDDGi0mACHAAA",
"type": 1
}
],
"field_map": {
"customField" : "customValue"
},
"remark_corp_name": "极速快递",
"remark_mobiles": "13800000001",
"remark_region_code": "110110",
"remark_region": "武汉市",
"remark_address": "中地软件园",
"remark_email": "123@164.com",
"remark_birthday": "2022-11-20",
"add_time": 1618269181797,
"oper_userid": "rocky",
"add_way": 1,
"is_del":false,
"is_loss": false
},
{
"userid": "tommy",
"remark": "李总",
"description": "采购问题咨询",
"createtime": 1608269181797,
"state": "外联二维码1",
"oper_userid": "woAJ2GCAAAXtWyujaWJHDDGi0mACHAAA",
"add_way": 3,
"is_del":false,
"is_loss": false
}
]
}
]
}
返回说明:
参数 | 类型 | 说明 |
---|---|---|
code | int | 出错返回码,为0表示成功,非0表示调用失败 |
msg | string | 返回码描述 |
data | ExtenalUser[] | 返回码描述 |
external_userid | string | 外部联系人的userid |
name | string | 外部联系人的名称 |
avatar | string | 外部联系人头像 |
type | int | 外部联系人的类型,1表示该外部联系人是微信用户,2表示该外部联系人是企业微信用户 |
gender | int | 外部联系人性别 0-未知 1-男性 2-女性 |
unionid | string | 外部联系人在微信开放平台的唯一身份标识(微信unionid),通过此字段企业可将外部联系人与公众号/小程序用户关联起来。仅当联系人类型是微信用户,且企业或第三方服务商绑定了微信开发者ID有此字段。 |
position | string | 外部联系人的职位,如果外部企业或用户选择隐藏职位,则不返回,仅当联系人类型是企业微信用户时有此字段 |
corp_name | string | 外部联系人所在企业的简称,仅当联系人类型是企业微信用户时有此字段 |
corp_full_name | string | 外部联系人所在企业的主体名称,仅当联系人类型是企业微信用户时有此字段 |
follow_user | FollowUser[] | 外部联系人的企业成员信息 |
userid | string | 添加了此外部联系人的企业成员userid |
remark | string | 该成员对此外部联系人的备注 |
description | string | 该成员对此外部联系人的描述 |
createtime | long | 该成员添加此外部联系人的时间 |
tags | Tag[] | 该成员添加此外部联系人所打标签 |
group_name | string | 该成员添加此外部联系人所打标签的分组名称 |
tag_name | string | 该成员添加此外部联系人所打标签名称 |
type | int | 该成员添加此外部联系人所打标签类型, 1-企业设置, 2-用户自定义, 3-业务标签 |
tag_id | string | 该成员添加此外部联系人所打企业标签的id |
field_map | Map | 该成员添加此外部联系人所设定自定义字段 |
is_del | bool | 是否员工删除客户 |
is_loss | bool | 是否客户删除员工 |
remark_corp_name | string | 该成员对此客户备注的企业名称 |
remark_mobiles | string | 该成员对此客户备注的手机号码 |
remark_region_code | string | 该成员对此客户备注的地区码 |
remark_region | string | 该成员对此客户备注的地区名字 |
remark_address | string | 用户被客户备注的地址 |
remark_email | string | 用户被客户备注的邮箱 |
remark_birthday | string | 用户被客户备注的客户生日 |
add_time | long | 用户添加客户的时间 |
add_way | int | 该成员添加此客户的来源 |
oper_userid | string | 发起添加的userid,如果成员主动添加,为成员的userid;如果是客户主动添加,则为客户的外部联系人userid;如果是内部成员共享/管理员分配,则为对应的成员/管理员userid |
state | string | 企业自定义的state参数,用于区分客户具体是通过哪个「联系我」添加 |