最新更新时间:2020.9.15 版本说明
用于服务商开发者查询已注册的服务人员ID等信息。
个人微信商家
• 1.传入门店ID,查询该门店下的所有已注册服务人员的信息(每次查询不可超过10条)
• 2.传入服务人员的工号(服务人员注册时填写)或手机号,查询单个服务人员的信息。
企业微信商家
• 1.传入门店ID,查询该门店下的所有已注册服务人员的信息(每次查询不可超过10条)
• 2.传入服务人员的企业微信员工ID或手机号,查询单个服务人员的信息。
服务人员注册API和查询API请求URL相同,区别主要是在body和query,请注意区分。
适用对象:服务商
请求URL:https://api.mch.weixin.qq.com/v3/smartguide/guides
请求方式:GET
path 指该参数路径参数
query 指该参数需在请求URL传参
body 指该参数需在请求JSON传参
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
子商户ID | sub_mchid | string[1,64] | 否 | query服务人员所属商户的商户ID 示例值:1234567890 |
门店ID | store_id | int | 是 | query门店在微信支付商户平台的唯一标识 示例值:1234 |
企业微信的员工ID | userid | string[1,64] | 否 | query员工在商户企业微信通讯录使用的唯一标识,企业微信商家可传入该字段查询单个服务人员信息;不传则查询整个门店下的服务人员信息 示例值:robert |
手机号码 | mobile | string[1,512] | 否 | query服务人员通过小程序注册时填写的手机号码,企业微信/个人微信商家可传入该字段查询单个服务人员信息;不传则查询整个门店下的服务人员信息。 该字段需进行加密处理,加密方法详见敏感信息加密说明 特殊规则:加密前字段长度限制为32个字节 示例值:str2WoWy8uUiWM7xahvNv0lV3C+nn3t4QlKNnyr+iwlk2FoMcn/lxrR6YdKKFI6NFJkC5oyvzNwc1MDzIgjLR0W6bJKiwWeOV3Fp0x+VIoRDONal1Mgb6VTYg7lvACEqdwmVkvbt4/oEWaWP62njMGGe0fMiBSAvao3LrcsOwDvN3E9kiaw5XQZMP/rUdWTFfy5THuohcQobGMrxclHKAnwAHU8CWfkziW5crUc3Z83uMVcFQu38y9EcWR12FJ3jip5nyVKiqCF4iDSN+JRXjWsWlqTZ0Y8Q+piBCS5ACusK6nz7mKQeypi9fKjAggRfvNFPf/bNxPvork4mMVgZkA== |
工号 | work_id | string[1,20] | 否 | query服务人员通过小程序注册时填写的工号,个人微信商家可传入该字段查询单个服务人员信息;不传则查询整个门店下的服务人员信息 示例值:robert |
最大资源条数 | limit | int | 否 | query商家自定义字段,该次请求可返回的最大资源条数,不大于10 示例值:5 |
请求资源起始位置 | offset | int | 否 | query商家自定义字段,该次请求资源的起始位置,默认值为0
示例值:0 |
https://api.mch.weixin.qq.com/v3/smartguide/guides?store_id=1234&sub_mchid=1234567890
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
+服务人员列表 | data | array | 是 | 服务人员列表 |
服务人员数量 | total_count | int | 是 | 符合条件筛选的服务人员数量,当服务人员列表返回为空时,服务人员数量返回0;当服务人员列表有返回值时,服务人员数量按查询到的值返回。 示例值:10 |
最大资源条数 | limit | int | 是 | 该次请求可返回的最大资源条数,不大于10 示例值:5 |
请求资源起始位置 | offset | int | 是 | 该次请求资源的起始位置,默认值为0 示例值:0 |
{
"data": [
{
"guide_id": "LLA3WJ6DSZUfiaZDS79FH5Wm5m4X69TBic",
"store_id": 1234,
"name": "str2WUc3Z83uMVcFQu38y9EcWR12FJ3jip5nyVKiqCF4iDSN+JRXjWsWlqTZ0Y8Q+piBCS5ACusK6nz7mKQeypi9fKjAggRfvNFPf/bNxPvork4mMVgZkA==",
"mobile": "str2WoWyZ83uMVcFQu38y9EcWR12FJ3jip5nyVKiqCF4iDSN+JRXjWsWlqTZ0Y8Q+piBCS5ACusK6nz7mKQeypi9fKjAggRfvNFPf/bNxPvork4mMVgZkA==",
"userid": "robert"
},
{
"guide_id": "LLA3WJ6DSZUfiaZDS79FH5Wm5m4X69TBic",
"store_id": 1234,
"name": "str2WUc3Z83uMVcFQu38y9EcWR12FJ3jip5nyVKiqCF4iDSN+JRXjWsWlqTZ0Y8Q+piBCS5ACusK6nz7mKQeypi9fKjAggRfvNFPf/bNxPvork4mMVgZkA==",
"mobile": "str2WoWyZ83uMVcFQu38y9EcWR12FJ3jip5nyVKiqCF4iDSN+JRXjWsWlqTZ0Y8Q+piBCS5ACusK6nz7mKQeypi9fKjAggRfvNFPf/bNxPvork4mMVgZkA==",
"work_id": "robert"
}
],
"total_count": 10,
"limit": 5,
"offset": 0
}
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | PARAM_ERROR | 必填参数为空 | 根据错误提示,传入正确参数 |
门店ID格式错误 | 根据错误提示,传入正确参数 | ||
userid格式错误 | 根据错误提示,传入正确参数 | ||
手机号码格式错误 | 根据错误提示,传入正确参数 | ||
门店ID为空 | 请填写门店id | ||
个人微信商家不应填写企业微信id | 根据错误提示,传入正确参数 | ||
企业微信商家不应填写工号 | 根据错误提示,传入正确参数 | ||
最大资源条数大于10 | 根据错误提示,传入正确参数 | ||
400 | MCH_NOT_EXISTS | 子商户不存在 | 请确认商户号是否有误 |
商户号格式错误 | 请确认商户号是否有误 | ||
子商户号格式错误 | 请确认商户号是否有误 | ||
子商户号为空 | 请填写子商户号 | ||
400 | INVALID_REQUEST | 子商户未授权 | 子商户未授权,请联系子商户授权 |
子商户产品权限未开通 | 子商户产品权限未开通,请联系子商户开通 | ||
子商户产品配置未完成 | 子商户产品配置未完成,请确认子商户完成产品配置后重试 | ||
500 | SYSTEM_ERROR | 系统错误 | 请使用相同参数稍后重新调用 |
扩展父子商户票据错误 | 请使用相同参数稍后重新调用 | ||
调用云函数错误 | 请使用相同参数稍后重新调用 |