发起签署
POST
{{host}}/matrix/signLink
接口描述
发起签署
请求头
参数名
类型
描述
必填
token
string
{{token}}
必填
请求参数
参数名
类型
描述
必填
name
String
签署主题
必填
wxUserCount
Int
发送的微信好友数量（选择微信好友的时候传）（2024.01.04后逐渐弃用，改用userCount字段）
可选
hqUserStr
String
好签好友，示例：[ [123,55, 98],[122,54, 97] ] 里面是userId （选择好签好友的时候传）
可选
ccUserStr
String
抄送的好签好友，示例：[123,234,456]
可选
ccEmailStr
String
抄送的邮箱地址，示例 ['343243@qq.com','wangweiguo@wellsign.cn']
可选
fileStr
String
发送的文件数据json，例如：[{"cn":"fileList","oi":"erewrwe"},{"cn":"fileList","oi":"rewrewxzc"}] cn代表parse对应的className，oi代表那个文件的objectId。已完成文件发签署示例见下方
必填
senderType
Int
发送类型：1微信、2企业微信、3钉钉、4APP、5web、6签字码
必填
raSign
boolean
是否实名签署，默认false
可选
joinSign
boolean
是否联名签署，默认true（多级签署，必然传true；单个人必然传false;其他情况根据实际用户选择传参）
可选
sendUserSignedNumber
Int
签字人签署的当前发送的文件份数,默认0
可选
signDL
boolean
签署人能够下载文件，默认true
可选
sendUserPay
boolean
是否发起人付费，默认true
可选
teamId
Int
团队id（选择使用团队份数支付的时候传）
可选
copyFile
boolean
是否保留文件副本，默认false
可选
wxTmplIds
string
小程序通知模板id（小程序单人签 时传）
可选
comment
string
留言
可选
saveTemplate
boolean
自动保存本次签署至签署模板（需注意模板的必填项 hqUserStr 必须不为空）
可选
templateId
int
如果发起签署时使用的是模板，则传入相关的模板id
可选
closeType
int
多人签关闭类型（0：用户手动关闭 1：最后一人签完后自动关闭）
可选
smsId
string
短信认证id。只有客户端进行保存提交时有密码校验/短信校验时才传。注意如果是密码验证则传-1，短信验证则传对应的id（获取参考接口 https://easydoc.net/doc/32125166/iuoIDZTO/cSZ3q2a3 里面返回的 verifyId ），没有密码验证或者短信验证则此参数不用传
可选
userCount
int
签署人数量（支持微信、短信、邮件发送方式，不支持好签好友）
可选
receivePhoneStr
接收人手机号码，多手机号按照逗号分隔，示例 19811100111,13912312123
可选
receiveEmailStr
接收人邮箱，多邮箱按照逗号分隔，示例 343243@qq.com,wangweiguo@wellsign.cn
可选
expireDate
string
签字链接过期时间，不传则默认当前时间加 30 天。格式为 yyyy-MM-dd，示例 2024-03-29。自定义的过期时间，实际过期时间为当天的 23 点 59 分 59 秒。
可选