合同到期提醒

服务说明

[!NOTE] 设置合同到期提醒,调用成功后,会在设置的合同到期日当天早上9:09分给用户发送到期提醒通知

http请求方式

[!NOTE] POST application/x-www-form-urlencoded

http请求地址

[!NOTE] $SERVICE_URL/v2/sign/expiredNotify #其中$SERVICE_URL为生产或测试的地址

http请求参数

参数 类型 是否必填 默认值 说明
applyNo string + 调合同发起接口返回的APL开头的合同编号
promptJson string + 短信接收人信息

promptJson字段说明

[!NOTE] promptJson是短信接收人信息,promptJson为JSONArray数组格式的字符串。参数说明如下:

http请求参数

参数 类型 是否必填 默认值 说明
mobile string + 接收合同到期提醒人的手机号
promptTime string + 合同到期提醒日期(YYYY-MM-DD)

代码实现

JAVA实现
RequestUtils requestUtils= RequestUtils.init(SERVICE_URL,APP_KEY,APP_SECRET);
        JSONObject jsonObject = new JSONObject();
        //接收人手机号码
        jsonObject.put("mobile","138XXXXXXXX");
        //promptTime为提醒时间;格式为yyyy-MM-dd
        jsonObject.put("promptTime","2020-12-12");
        JSONArray array = new JSONArray();
        array.add(jsonObject);
        //构建请求参数
        Map<String,Object> params=new HashMap<>();
        params.put("applyNo","XXX"); //TODO +
        params.put("promptJson",array.toJSONString());
        ResultInfo<Void> ri= requestUtils.doPost("/v2/sign/expiredNotify",params);

http返回参数

[!NOTE] 返回response为application/json的数据,其字段说明如下

参数 类型 是否必返回 说明
success bool * 成功true;异常false
msg string ? 异常时,返回异常原因
resultCode int * 成功0,其它参考附录

[!NOTE] 返回结果,参考:

//正确响应:
{"success":true}

//错误响应:
{"msg":"app_secret不可用","resultCode":"HTTP_PARAM_ERROR","success":false}

results matching ""

    No results matching ""