服务人员注册API

最新更新时间:2020.09.15 版本说明


用于服务商/商户开发者为商户注册服务人员使用。

注意:

• 调用接口前商家需完成支付即服务产品的开通和设置。若服务商为特约商户调用接口,需在特约商户开通并完成产品设置后,与特约商户建立产品授权关系。

接口说明

适用对象:服务商 直连商户

请求URL:https://api.mch.weixin.qq.com/v3/smartguide/guides

请求方式:POST

接口规则:https://pay.weixin.qq.com/wiki/doc/apiv3/wechatpay/wechatpay-1.shtml


path 指该参数路径参数

query 指该参数需在请求URL传参

body 指该参数需在请求JSON传参


请求参数

参数名 变量 类型[长度限制] 必填 描述
子商户ID sub_mchid string[1,32] body 服务人员所属商户的商户ID
(如果是直连商户/普通特约商户自己调用接口,不传即可;如果是服务商帮普通特约商户调用接口,传普通特约商户的商户号)
示例值:1234567890
企业ID corpid string[1,32] body 商户的企业微信唯一标识
示例值:1234567890
门店ID store_id int body 门店在微信支付商户平台的唯一标识
(查找路径:登录商户平台—>营销中心—>门店管理,若无门店则需先创建门店)
示例值:12345678
企业微信的员工ID userid string[1,64] body 员工在商户企业微信通讯录使用的唯一标识
(企业微信的员工信息可通过接口从企业微信通讯录获取,具体请参考企业微信的API文档
示例值:robert
企业微信的员工姓名 name string[1,512] body 员工在商户企业微信通讯录上的姓名,需使用微信支付平台公钥加密
该字段需进行加密处理,加密方法详见敏感信息加密说明
特殊规则:加密前字段长度限制为64个字节
示例值:pVd1HJ6v/69bDnuC4EL5Kz4jBHLiCa8MRtelw/wDa4SzfeespQO/0kjiwfqdfg==
手机号码 mobile string[5,512] 员工在商户企业微信通讯录上设置的手机号码,使用微信支付平台公钥加密
该字段需进行加密处理,加密方法详见敏感信息加密说明
特殊规则:加密前字段长度限制为32个字节
示例值:pVd1HJ6v/69bDnuC4EL5Kz4jBHLiCa8MRtelw/wDa4SzfeespQO/0kjiwfqdfg==
员工个人二维码 qr_code string[1,256] body 员工在商户企业微信通讯录上的二维码串
示例值:https://open.work.weixin.qq.com/wwopen/userQRCode?vcode=xxx
头像URL avatar string[1,256] body 员工在商户企业微信通讯录上头像的URL
示例值:http://wx.qlogo.cn/mmopen/ajNVdqHZLLA3WJ6DSZUfiakYe37PKnQhBIeOQBO4czqrnZDS79FH5Wm5m4X69TBicnHFlhiafvDwklOpZeXYQQ2icg/0
群二维码URL group_qrcode string[1,256] body 员工所在门店在企业微信配置的群活码的URL(可通过企业微信“获取客户群进群方式API”获取,请登录企业微信后查看API文档,若无查看权限可通过问卷提交需求 )
示例值:http://p.qpic.cn/wwhead/nMl9ssowtibVGyrmvBiaibzDtp/0

请求示例


{
  "store_id" : 1234,
  "corpid" : "1234567890",
  "name" : "pVd1HJ6v/69bDnuC4EL5Kz4jBHLiCa8MRtelw/wDa4SzfeespQO/0kjiwfqdfg==",
  "mobile" : "pVd1HJ6v/69bDnuC4EL5Kz4jBHLiCa8MRtelw/wDa4SzfeespQO/0kjiwfqdfg==",
  "qr_code" : "https://open.work.weixin.qq.com/wwopen/userQRCode?vcode=xxx",
  "sub_mchid" : "1234567890",
  "avatar" : "http://wx.qlogo.cn/mmopen/ajNVdqHZLLA3WJ6DSZUfiakYe37PKnQhBIeOQBO4czqrnZDS79FH5Wm5m4X69TBicnHFlhiafvDwklOpZeXYQQ2icg/0",
  "group_qrcode" : "http://p.qpic.cn/wwhead/nMl9ssowtibVGyrmvBiaibzDtp/0",
  "userid" : "robert"
}
    
{
JAVA示例代码
}
    

返回参数

参数名 变量 类型[长度限制] 必填 描述
服务人员ID guide_id string[1,32] 服务人员在服务人员系统中的唯一标识
示例值:LLA3WJ6DSZUfiaZDS79FH5Wm5m4X69TBic

返回示例


{
  "guide_id" : "LLA3WJ6DSZUfiaZDS79FH5Wm5m4X69TBic"
}
                                

{
"return_code": "INVALID_REQUEST",
"return_msg": "mch punished",
}
                                

错误码公共错误码

状态码 错误码 描述 解决方案
400 PARAM_ERROR 必填参数为空 根据错误提示,传入正确参数
corpid格式错误 根据错误提示,传入正确参数
门店ID格式错误 根据错误提示,传入正确参数
userid格式错误 根据错误提示,传入正确参数
服务人员姓名格式错误 根据错误提示,传入正确参数
服务人员姓名过长 根据错误提示,传入正确参数
手机号码格式错误 根据错误提示,传入正确参数
二维码链接格式错误 根据错误提示,传入正确参数
头像URL不是合法链接 根据错误提示,传入正确参数
非企业微信提供的头像URL 根据错误提示,传入正确参数
corpid为空 请填写corpid
门店ID为空 请填写门店id
userid为空 请填写userid
服务人员姓名为空 请填写服务人员姓名
手机号码为空 请填写服务人员手机号
二维码链接为空 请填写服务人员二维码链接
头像URL为空 请填写头像url
服务人员已注册 请检查该服务人员是否之前有注册过
群二维码URL格式错误 根据错误提示,传入正确参数
400 MCH_NOT_EXISTS 子商户不存在 请确认商户号是否有误
商户号格式错误 请确认商户号是否有误
子商户号格式错误 请确认商户号是否有误
子商户号为空 请填写子商户号
400 INVALID_REQUEST 子商户未授权 子商户未授权,请联系子商户授权
子商户产品权限未开通 子商户产品权限未开通,请联系子商户开通
子商户产品配置未完成 子商户产品配置未完成,请确认子商户完成产品配置后重试
500 SYSTEM_ERROR 系统错误 请使用相同参数稍后重新调用
系统添加GUIDE失败 请使用相同参数稍后重新调用
扩展父子商户票据错误 请使用相同参数稍后重新调用
调用云函数错误 请使用相同参数稍后重新调用

版本说明

关闭
V1.1
2020年09月15日
1. 字段userid长度限制调整为64
V1.0
2020年04月28日
1. 服务人员注册接口上线

技术咨询

文档反馈