zeyi / open-doc

Download as
Browse Code »

Commit 7839776878b83c3156ec803c151e2992787e0f63

Authored by wujiahao
1 parent 57f82dc0
Exists in master

工单回执发送短信文档

Showing 1 changed file with 121 additions and 7 deletions   Show diff stats
boss/工单回执发送短信.md
  Diff comments   View file @7839776
... ... @@ -2,6 +2,114 @@
2 2  
3 3 工单完成之后，触发短信回执，调用以下接口。
4 4  
  5 +#### 获取访问凭证
  6 +
  7 +##### 概述
  8 +
  9 +调用则一服务API时，都需要先获取对应权限类型的访问凭证accessToken。访问凭证（accessToken）是由则一权限系统颁发的，用来校验调用者的身份信息，确保调用者具有要执行的操作的权限。
  10 +**说明**： 在使用accessToken时，请注意：
  11 +
  12 +* accessToken的有效期默认为30天，有效期内重复获取会返回相同结果，过期后获取会返回新的accessToken。
  13 +* 开发者需要缓存accessToken，用于后续接口的调用。不能频繁调用获取accessToken接口，否则会受到频率拦截。
  14 +* 当调用业务API时，如果返回状态码为401，则说明accessToken不正确或已过期，这时需要重新获取accessToken后再调用对应的API。
  15 +
  16 +##### 接口信息
  17 +
  18 +###### 请求方式：
  19 +
  20 +post
  21 +
  22 +###### 请求地址：
  23 +
  24 +* 生产：https://gw.shjiuze.cn/auth-service-api/login/password
  25 +* 测试：https://test.shjiuze.cn/auth-service-api/login/password
  26 +
  27 +###### Body参数
  28 +
  29 +| 名称 | 类型 | 必填 | 示例值 | 描述 |
  30 +| -------- | ------ | ---- | ----------- | ---------------- |
  31 +| username | String | 是 | zhangsan | 用户名，则一提供 |
  32 +| password | String | 是 | password123 | 密码，则一提供 |
  33 +
  34 +###### 返回参数
  35 +
  36 +| 名称 | 类型 | 示例值 | 描述 |
  37 +| ------------------------------ | ---------- | -------------------------------- | -------------------------------------------------- |
  38 +| success | boolean | true | 成功标识: true 成功，false 失败 |
  39 +| businessException | boolean | false | 业务异常标识: true 业务异常，false 正常 |
  40 +| errorCode | String | 200 | 错误码: 200 业务异常，500 系统异常， 空表示无错误 |
  41 +| message | String | 订单号不能为空 | 错误信息，无错误则返回空 |
  42 +| result | ZYTokenDto | | accessToken结果数据 |
  43 +|     accessToken | String | 000626f15b4b41bba6fe56216a5d2f73 | accessToken |
  44 +|     expiresIn | Integer | 2060 | 有效期限单位秒，accessToken在2060秒后过期 |
  45 +|     tokenType | String | bearer | token类型 |
  46 +
  47 +##### 请求示例
  48 +
  49 +###### Http方式
  50 +
  51 +```http
  52 +POST /auth-service-api/login/password HTTP/1.1
  53 +Host:test.shjiuze.cn
  54 +Content-Type:application/json
  55 +
  56 +{
  57 + "username" : "zeyi",
  58 + "password" : "test1111"
  59 +}
  60 +```
  61 +
  62 +###### Java-sdk方式 [下载SDK](https://zeyi-tms-product.oss-cn-hangzhou.aliyuncs.com/file/jar/java-sdk/zy-java-sdk-1.0.0.jar)
  63 +
  64 +```java
  65 +public class Sample {
  66 + public static void main(String[] args_) {
  67 + String appKey = "appkey";
  68 + String appSecret = "appSecret";
  69 + ZYClient zyClient = new ZYClient(appKey, appSecret);
  70 + ZYTokenRequestDto zyTokenRequest = new ZYTokenRequestDto();
  71 + zyTokenRequest.setUsername("zeyi");
  72 + zyTokenRequest.setPassword("test1111");
  73 + String body = gson.toJson(zyTokenRequest);
  74 + HttpResponseData httpResponseData = zyClient.doPost(Constants.TEST_HOST + Constants.TOKEN_PATH, body);
  75 + if(httpResponseData == null) {
  76 + throw new TokenException("则一Token请求失败,返回为空!");
  77 + }
  78 + ZYResponse<ZYTokenDto> zyResponse = gson.fromJson(httpResponseData.getBody(), new TypeToken<ZYResponse<ZYTokenDto>>(){}.getType());
  79 + if(!Boolean.TRUE.equals(zyResponse.isSuccess())) {
  80 + throw new TokenException("则一Token请求返回失败!" + zyResponse.getMessage());
  81 + }
  82 + if(zyResponse.getResult() == null) {
  83 + throw new TokenException("则一Token请求返回失败,返回结果为空!" + zyResponse.getMessage());
  84 + }
  85 + if(StringUtils.isBlank(zyResponse.getResult().getAccessToken())) {
  86 + throw new TokenException("则一Token请求返回数据异常,AccessToken为空!" + zyResponse.getMessage());
  87 + }
  88 + // 结果 zyResponse.getResult();
  89 + }
  90 +}
  91 +```
  92 +
  93 +##### 返回示例
  94 +
  95 +```json
  96 +{
  97 + "success": true,
  98 + "businessException": false,
  99 + "errorCode": null,
  100 + "message": null,
  101 + "result": {
  102 + "accessToken": "64d7f367-609b-4f7d-a84d-a3d2a0b5ad85",
  103 + "expiresIn": 602105,
  104 + "tokenType": "bearer"
  105 + }
  106 +}
  107 +```
  108 +
  109 +
  110 +
  111 +## **工单发送短信**
  112 +
5 113 ### **短信模板示例**
6 114  
7 115 您好，本次服务已完成。完工时间：${completeTime}。我们很重视您的体验，请点击链接进行评价，感谢您的参与https://a1.xiaomilaile.com/xmdwz/${ticketLink}
... ... @@ -18,13 +126,19 @@ post
18 126  
19 127 测试：https://test.shjiuze.cn/boss-service-api/sms/ticketReceiptSendSms
20 128  
  129 +###### Headers参数
  130 +
  131 +| 名称 | 类型 | 必填 | 示例值 | 描述 |
  132 +| ------------- | ------ | -------------------------- | ----------------- | ------------------------------------------------------------ |
  133 +| Authorization | String | 是&nbsp;&nbsp;&nbsp;&nbsp; | Bearer a2c5680001 | 调用服务端API的应用凭证accessToken，通过调用获取访问凭证接口获取。 |
  134 +
21 135 #### Body参数
22 136  
23   -| 名称 | 类型 | 必填 | 示例值 | 描述 |
24   -| -------------- | ------ | ---- | :------------------ | -------- |
25   -| mobile | String | 是 | 17802532466 | 电话号码 |
26   -| completionTime | Date | 是 | 2023-08-08 00:00:00 | 完工时间 |
27   -| ticketLink | String | 是 | kkkkk | 工单链接 |
  137 +| 名称 | 类型 | 必填 | 示例值 | 描述 |
  138 +| -------------- | ------ | ---- | :--------------- | -------- |
  139 +| mobile | String | 是 | 17802532466 | 电话号码 |
  140 +| completionTime | Date | 是 | 2023-08-08 00:00 | 完工时间 |
  141 +| ticketLink | String | 是 | kkkkk | 工单链接 |
28 142  
29 143 #### 返回参数
30 144  
... ... @@ -44,12 +158,12 @@ Content-Type:application/json
44 158  
45 159 {
46 160 "mobile" : "17802532499",
47   - "completionTime" : "2023-08-08 00:00:00",
  161 + "completionTime" : "2023-08-08 00:00",
48 162 "ticketLink" : "kkkkk"
49 163 }
50 164 ```
51 165  
52   -**返回示例**
  166 +#### **返回示例**
53 167  
54 168 ```
55 169 {
... ...