系统级别输入参数
参数名称 | 说明 |
---|---|
appkey | 客户端标识 (由fesco技术部提供给调用方一对appkey与appsecret) |
sign | 调用方签名后的字符串 |
format | (json/jsonp)如果该参数不传递,默认返回json |
timeStamp | 时间戳(毫秒值,1534225991898) |
methodName | 方法名 |
接口概述 | |
---|---|
开发者 | 张翼 |
方法名 | app.sign.initiateSigning |
说明 |
电子签约平台方收到调用方请求,发起签署,并根据手机号推送短信给员工 接口规则说明: 1.短信模板:传模板按传入的模板走,没传的按"系统默认短信模板-电子签约邀请模板"执行 2.入参"合同过期时间":默认为空 3.入参"签署截止日期":默认为空 4.短信模板中所有变量均为电子签平台匹配替换,无必传参数 5.短信模板如果未传入,参考方式二,生成短信模板 |
应用级输入参数
名称 | 类型 | 是否必须 | 描述 | 示例值 | 默认值 |
---|---|---|---|---|---|
![]() |
|
是 | 应用级别参数对象Json序列化后的字符串 | { } | |
└ channelCode |
|
是 | 渠道编码 | 该编码按电子签平台规则生成,保证每个来源系统都有一个唯一的编码、不可修改 | |
└ bizId |
|
是 | 业务ID | 本次签署流程的业务ID | |
└ ordinal |
|
是 | 是否顺序签署 | 1顺序签 0非顺序签 |
|
└ SMSTemplate |
|
否 | 短信模板 | 模板变量 ${receiverName} 接收人姓名 ${expireTime} 合同过期时间 ${signUrl}签署链接 ${signDeadline}签署截止日期 为空时按系统默认信息发送 |
|
└ expireTime |
|
否 | 合同过期时间 | 格式为yyyy-MM-dd HH:mm:ss | |
└ signDeadline |
|
否 | 签署截止日期 | 格式为yyyy-MM-dd HH:mm:ss | |
![]() |
|
是 | 合同文档对象 | ||
![]() |
|
是 | 签署方列表 |
返回结果
名称 | 类型 | 描述 |
---|---|---|
code |
|
0为成功,FW为失败 |
errorMsg |
|
失败原因 |
![]() |
|
成功数据 |
errorResult |
|
错误数据集合 |
status |
|
1为中间库成功,2为新系统成功,3为新系统失败(新系统业务处理异常,不插入中间库) |
piCallRecId |
|
中间表主键id(根据中间表主键id查询返回正确业务数据的json串) |
errorStack |
|
错误堆栈 |
调用示列
{
"bizId": "bizid003",
"channelCode": "100001",
"documents": [
{
"templateCode": "templateCode001",
"title": "title001"
}
],
"expireTime": "2020-02-06 13:30:00",
"ordinal": 1,
"signDeadline": "2020-02-06 13:30:00",
"signatories": [
{
"isPromoter": 1,
"receiver": {
"email": "string@qq.com",
"mobile": "17810361901",
"name": "David"
},
"serialNo": 2,
"tenantName": "张三",
"tenantType": "PERSONAL"
}
],
"smstemplate": "${receiverName},您好!请您在加${expireTime}前完成背景调查电子签署和信息调查表垣写.如有同题清及时与相关HR联系;签约地址:${signUrl}"
}
错误码
错误编码 | 错误描述 | 错误原因 | 解决方案 |
---|