Authored by 张帅

增加接口

@@ -232,4 +232,119 @@ code为200即为成功,否则是失败。 @@ -232,4 +232,119 @@ code为200即为成功,否则是失败。
232 "message": "操作成功" 232 "message": "操作成功"
233 } 233 }
234 234
  235 +
  236 +## 5、微信客服获取分享码接口##
  237 +
  238 +生成唯一分享码并与微信客服uid绑定(app.passport.getWechatShareCode)
  239 +#### 公共请求参数
  240 +| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
  241 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  242 +|client_type|string|20|否|iphone/android/ipad||手机型号(不区分大小写)|
  243 +|business_line|string|20|否|miniapp||(业务线)|
  244 +|app_version|string|20|否|6.6.3||(版本号)|
  245 +|udid|string|20|否|""||(设备唯一标示)|
  246 +#### 请求参数
  247 +无| 参数名称 | 参数类型 |长度| 可否为空 | 示例 | 默认值 | 备注 |
  248 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  249 +|uid|int|11|否|12434343|0|微信客服uid|
  250 +
  251 +
  252 +| 接口说明||
  253 +|:-------| -----:|
  254 +|请求域名|http://api.yoho.cn|
  255 +|接口名|method=app.passport.getWechatShareCode|
  256 +|接口说明|微信客服获取分享码|
  257 +|http请求方式|POST/GET|
  258 +#### 返回错误
  259 +|错误code|错误提示|
  260 +|:-------| -----:|
  261 +|201|参数缺失|
  262 +注意,通用的头部没有列出。
  263 +请求示例
  264 +?method=app.passport.getWechatShareCode&uid=500031572&debug=XYZ&business_line=miniapp&client_type=miniapp
  265 +
  266 +### 响应
  267 +data 是生成的分享码,code为200且data不为空表示生成成功,否则失败
  268 +响应成功JSON()格式如下所示:
  269 +```json
  270 +
  271 +
  272 +{
  273 + "alg": "SALT_MD5",
  274 + "code": 200,
  275 + "data": "1f208688c0adbfc7d",
  276 + "message": "操作成功"
  277 +}
  278 +
  279 +
  280 +{
  281 + "alg": "SALT_MD5",
  282 + "code": 201,
  283 + "data": null,
  284 + "message": "failed"
  285 +}
  286 +
  287 +
  288 +
  289 +## 6,根据分享码,客服uid获取领取用户的信息##
  290 +
  291 +客服点击分享信息时提供用户的个人信息和分组(app.passport.getUserInfoByShareCode)
  292 +#### 公共请求参数
  293 +| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
  294 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  295 +|client_type|string|20|否|iphone/android/ipad||手机型号(不区分大小写)|
  296 +|business_line|string|20|否|miniapp||(业务线)|
  297 +|app_version|string|20|否|6.6.3||(版本号)|
  298 +|udid|string|20|否|""||(设备唯一标示)|
  299 +#### 请求参数
  300 +无| 参数名称 | 参数类型 |长度| 可否为空 | 示例 | 默认值 | 备注 |
  301 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  302 +|shareCode|String|16|否|1234567890123456|""|分享码|
  303 +|uid|int|11|否|12434343|0|客服uid|
  304 +
  305 +
  306 +| 接口说明||
  307 +|:-------| -----:|
  308 +|请求域名|http://api.yoho.cn|
  309 +|接口名|method=app.passport.getUserInfoByShareCode|
  310 +|接口说明|客服点击分享信息时提供用户的个人信息和分组|
  311 +|http请求方式|POST/GET|
  312 +#### 返回错误
  313 +|错误code|错误提示|
  314 +|:-------| -----:|
  315 +|201|参数缺失|
  316 +注意,通用的头部没有列出。
  317 +请求示例
  318 +?method=app.passport.getUserInfoByShareCode&uid=500031572&shareCode=12abcdefgh&debug=XYZ&business_line=miniapp&client_type=miniapp
  319 +### 响应
  320 +code为200即为成功,402分享码不存在,405分享码还未被用户领取。
  321 +响应成功JSON()格式如下所示:
  322 +```json
  323 +
  324 +
  325 +{
  326 + "alg": "SALT_MD5",
  327 + "code": 200,
  328 + "data": {
  329 + "uid":123456,
  330 + "userName":"test"
  331 + "vipLevel":"普通"
  332 + "tag_address":"南京",
  333 + "tag_createTime":"2017"
  334 + }
  335 + "message": "操作成功"
  336 +}
  337 +
  338 +
  339 +{
  340 + "message": "该分享码不存在",
  341 + "code": 402
  342 +}
  343 +
  344 +{
  345 + "message": "分享码还未被用户领取",
  346 + "code": 405
  347 +}
  348 +
  349 +
235 ``` 350 ```