通过备注手机号获取顾客信息
企业可通过此接口查询手机号对应的客户。
请求方式: POST(HTTPS)
请求地址: https://open.wshoto.com/openapi/customer/list/by/mobile?access_token=x
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 调用接口凭证 |
Body参数:
{
"mobile": "13000000000",
"current_index": 1,
"page_size": 20
}
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
mobile | string | 是 | 手机号 |
返回值:
{
"code": 0,
"msg": "请求成功",
"data": {
"total": 2,
"records": [
{
"external_userid": "wmJYSuBgAACVNdrAxm0461D6NvWJvTvw",
"name": "羊羊",
"corp_name": null,
"corp_full_name": "建设集团有限公司",
"type": null,
"gender": null,
"add_user_id": "YunXueWeiShengQiWeiGuanJia_1",
"loss": false,
"tag_list": [
{
"tag_id": "etJYSuBgAA9KpEgTttLB26aSZhJTargw",
"tag_name": "标签",
"type": 1,
"group_name": "测试组"
}
]
}
]
}
}
返回说明:
参数 | 类型 | 说明 |
---|---|---|
code | int | 出错返回码,为0表示成功,非0表示调用失败 |
msg | string | 返回码描述 |
data | Page | 分页对象 |
total | int | 总条数 |
records | Customer[] | 数据列表 |
external_userid | string | 外部联系人id |
name | string | 客户名称 |
corp_name | string | 企业简称 |
corp_full_name | string | 企业全称 |
type | int | 类型1:微信用户, 2:企业微信用户 |
gender | int | 性别0未知,1男性,2女性 |
add_user_id | string | 用户ID(第一添加人) |
loss | boolean | 是否被客户删除 |
tag_list | Tag[] | 标签 |
tag_id | string | 标签id |
tag_name | string | 标签名称 |
type | int | 该成员添加此外部联系人所打标签类型, 1-企业设置, 2-用户自定义 |
group_name | string | 标签组名称 |