发送签约提醒

接口说明

[!NOTE]
文件签约提醒,通过发送手机短信方式提醒签约方签署合同。支持单个web签约合同或批量签署合同,短信中的短链接地址有效期是72小时,超过72小时后需要重新发起。

http请求方式

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

http请求地址

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

http请求参数

除公共必填参数外,还需要传以下参数

参数 类型 是否必填 默认值 说明
applyNo string + 合同编号-单个合同签约时使用(合同发起接口中返回的APL编号
businessNo string + 业务编号-批量签时通知专用(合同发起接口中自定义的业务编号
fullName string * 签约人名称(合同发起接口中传入的签署人姓名
identityCard string * 签约人证件号(合同发起接口中传入的签署人证件号
identityType int * 证件类型 1身份证, 2护照, 3台胞证, 4港澳居民来往内地通行证, 11营业执照, 12统一社会信用代码, 20子账号, 99其他
signNotifyType int * 1 提醒类型,1签字提醒,2到期前提醒,3到期后提醒,4合同到期前提醒,5合同到期后提醒
customizeName string ? 自定义接收短信中的商户名

特殊说明

[!NOTE]
短信签约链接地址有效期为72小时,过期后需要重新请求短信。该接口因涉及到短信费用,如果未购买短信服务,需要联系商务购买。

代码实现

JAVA实现
 Map<String, Object> params = bodyParams;
        String url = SERVICE_URL + "/v2/sign/notify";
        params.put("applyNo", "APL1XXXXX");
        params.put("fullName", "彭X");
        params.put("identityCard", "5001XXXXXXX");
        params.put("identityType", "1");
        params.put("signNotifyType", "1");
        String str = HttpClientUtils.init().getPost(url, null, params, true);
        System.out.println(str);
PHP实现
//构建请求工具
$requestUtils=new RequestUtils($serviceUrl, $appkey, $appSecret);
//初始化合同参数
$request=array(
    "applyNo" => "APL0000XXXXXXXXX", //TODO +
    //"businessNo" => "0000XXXXXXXXX", //TODO +
    "fullName" => "易XX", //TODO *
    "identityCard" => "5002XXXXXXXXXXXXXXXXXX", //TODO *
    "identityType" => 1, //TODO *
    //"signNotifyType" => 1 //默认为1
);
$response=$requestUtils->doPost("/v2/sign/notify",$request);

http返回参数

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

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

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

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

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

results matching ""

    No results matching ""