zeyi / open-doc

工单回执发送短信.md 7.26 KB

12fb21996d3cec9a8a64d55607de03b7977e7ae1/boss/工单回执发送短信.md#">工单回执发送短信

工单完成之后，触发短信回执，调用以下接口。

12fb21996d3cec9a8a64d55607de03b7977e7ae1/boss/工单回执发送短信.md#">获取访问凭证

12fb21996d3cec9a8a64d55607de03b7977e7ae1/boss/工单回执发送短信.md#">概述

调用则一服务API时，都需要先获取对应权限类型的访问凭证accessToken。访问凭证（accessToken）是由则一权限系统颁发的，用来校验调用者的身份信息，确保调用者具有要执行的操作的权限。 说明： 在使用accessToken时，请注意：

  • accessToken的有效期默认为30天，有效期内重复获取会返回相同结果，过期后获取会返回新的accessToken。
  • 开发者需要缓存accessToken，用于后续接口的调用。不能频繁调用获取accessToken接口，否则会受到频率拦截。
  • 当调用业务API时，如果返回状态码为401，则说明accessToken不正确或已过期，这时需要重新获取accessToken后再调用对应的API。
12fb21996d3cec9a8a64d55607de03b7977e7ae1/boss/工单回执发送短信.md#">接口信息
12fb21996d3cec9a8a64d55607de03b7977e7ae1/boss/工单回执发送短信.md#">请求方式：

post

12fb21996d3cec9a8a64d55607de03b7977e7ae1/boss/工单回执发送短信.md#">请求地址：
Body参数
名称 类型 必填 示例值 描述
username String 是 zhangsan 用户名，则一提供
password String 是 password123 密码，则一提供
12fb21996d3cec9a8a64d55607de03b7977e7ae1/boss/工单回执发送短信.md#">返回参数
名称 类型 示例值 描述
success boolean true 成功标识: true 成功，false 失败
businessException boolean false 业务异常标识: true 业务异常，false 正常
errorCode String 200 错误码: 200 业务异常，500 系统异常， 空表示无错误
message String 订单号不能为空 错误信息，无错误则返回空
result ZYTokenDto accessToken结果数据
    accessToken String 000626f15b4b41bba6fe56216a5d2f73 accessToken
    expiresIn Integer 2060 有效期限单位秒，accessToken在2060秒后过期
    tokenType String bearer token类型
12fb21996d3cec9a8a64d55607de03b7977e7ae1/boss/工单回执发送短信.md#">请求示例
Http方式
POST /auth-service-api/login/password HTTP/1.1
Host:test.shjiuze.cn
Content-Type:application/json

{
  "username" : "zeyi",
  "password" : "test1111"
}
Java-sdk方式 下载SDK
public class Sample {
    public static void main(String[] args_) {
        String appKey = "appkey";
        String appSecret = "appSecret";
        ZYClient zyClient = new ZYClient(appKey, appSecret);
        ZYTokenRequestDto zyTokenRequest = new ZYTokenRequestDto();
        zyTokenRequest.setUsername("zeyi");
        zyTokenRequest.setPassword("test1111");
        String body = gson.toJson(zyTokenRequest);
        HttpResponseData httpResponseData = zyClient.doPost(Constants.TEST_HOST + Constants.TOKEN_PATH, body);
        if(httpResponseData == null) {
            throw new TokenException("则一Token请求失败,返回为空!");
        }
        ZYResponse<ZYTokenDto> zyResponse = gson.fromJson(httpResponseData.getBody(), new      TypeToken<ZYResponse<ZYTokenDto>>(){}.getType());
        if(!Boolean.TRUE.equals(zyResponse.isSuccess())) {    
            throw new TokenException("则一Token请求返回失败!" + zyResponse.getMessage());
        }
        if(zyResponse.getResult() == null) {    
            throw new TokenException("则一Token请求返回失败,返回结果为空!" + zyResponse.getMessage());
        }
        if(StringUtils.isBlank(zyResponse.getResult().getAccessToken())) {    
            throw new TokenException("则一Token请求返回数据异常,AccessToken为空!" + zyResponse.getMessage());
        }
        // 结果 zyResponse.getResult();
    }
}
12fb21996d3cec9a8a64d55607de03b7977e7ae1/boss/工单回执发送短信.md#">返回示例
{
    "success": true,
    "businessException": false,
    "errorCode": null,
    "message": null,
    "result": {
        "accessToken": "64d7f367-609b-4f7d-a84d-a3d2a0b5ad85",
        "expiresIn": 602105,
        "tokenType": "bearer"
    }
}

12fb21996d3cec9a8a64d55607de03b7977e7ae1/boss/工单回执发送短信.md#">工单发送短信

12fb21996d3cec9a8a64d55607de03b7977e7ae1/boss/工单回执发送短信.md#">短信模板示例

您好，本次服务已完成。完工时间：${completeTime}。我们很重视您的体验，请点击链接进行评价，感谢您的参与https://a1.xiaomilaile.com/xmdwz/${ticketLink}

12fb21996d3cec9a8a64d55607de03b7977e7ae1/boss/工单回执发送短信.md#">接口信息：

12fb21996d3cec9a8a64d55607de03b7977e7ae1/boss/工单回执发送短信.md#">请求方式：

post

12fb21996d3cec9a8a64d55607de03b7977e7ae1/boss/工单回执发送短信.md#">请求地址：

生产：https://gw.shjiuze.cn/boss-service-api/sms/ticketReceiptSendSms

测试：https://test.shjiuze.cn/boss-service-api/sms/ticketReceiptSendSms

Headers参数
名称 类型 必填 示例值 描述
Authorization String 是     Bearer a2c5680001 调用服务端API的应用凭证accessToken，通过调用获取访问凭证接口获取。
appKey String 是 0867ef5f23ef6483749e19e1692b 则一提供

Body参数

名称 类型 必填 示例值 描述
mobile String 是 17802532466 电话号码
completeTime Date 是 2023-08-08 00:00:00 完工时间
ticketLink String 是 kkkkk 工单链接

12fb21996d3cec9a8a64d55607de03b7977e7ae1/boss/工单回执发送短信.md#">返回参数

名称 类型 示例值 描述
success boolean true 成功标识: true 成功，false 失败
businessException boolean false 业务异常标识: true 业务异常，false 正常
errorCode String 200 错误码: 200 业务异常，500 系统异常， 空表示无错误
message String 错误信息 错误信息，无错误则返回空

12fb21996d3cec9a8a64d55607de03b7977e7ae1/boss/工单回执发送短信.md#">请求示例

POST /boss-service-api/sms/ticketReceiptSendSms HTTP/1.1
Host:test.shjiuze.cn
Content-Type:application/json

{
  "mobile" : "17802532499",
  "completionTime" : "2023-08-08 00:00",
  "ticketLink" : "kkkkk"
}

12fb21996d3cec9a8a64d55607de03b7977e7ae1/boss/工单回执发送短信.md#">返回示例

{
    "success": true,
    "businessException": false,
    "errorCode": null,
    "message": null
}