签署详情
GET
{{host}}/matrix/signLink/detail/{signLinkId}
接口描述
签署详情
请求头
参数名
类型
描述
必填
token
string
{{token}}
必填
url参数
参数名
类型
描述
必填
signLinkId
int
签署链接id
必填
type
int
场景类型 1.签署详情页面获取签署详情信息 2.获取签字链接信息 3.获取关闭和撤回时需要退回的份数 4.获取扩充时的数据信息 5.获取提交时需要扣除的份数 6.点击签字链接获取对应数据 8.短信、邮件发送签署时转发链接
必填
objectId
string
filed表的objectId (只有type=1,且是已完成单人签查看签署详情时才需传参数，其他情况下勿传，否则会对签署详情数据造成干扰)
可选
tabType
int
提交签署列表（2：待他人签表，3：待我签表，默认为3）type为5时才需传此参数
可选
响应参数
参数名
类型
描述
必填
name
string
主题
必填
ccEmailList
list
抄送的邮箱地址
必填
userId
int
发起人userId
必填
nickName
String
昵称
必填
headImageUrl
String
用户头像存放路径
必填
createDateTime
String
创建时间，格式 yyyy-MM-dd HH:mm
必填
signLinkSignatoryJsonList
list
已签和未签等签署状态的用户信息。二维数组，得到的顺序就是级别顺序，单个级别下的签署人未进行排序，是按照添加时间来的，如果需要根据签署状态排序的话，则需要客户端自行根据需求排序
必填
nickName
String
昵称
必填
updateDateTime
String
更新时间，格式 yyyy-MM-dd HH:mm
必填
headImageUrl
String
用户头像存放路径
必填
status
int
签署状态：0接收，1保存，2提交但需要实名认证，3打回，4提交,5实名但未签署
必填
userId
int
用户id
必填
comment
String
留言
必填
linkContent
String
短信和邮件通知内容
必填
receiverType
int
1微信、3APP、4短信、5邮箱
必填
signedSignerNum
int
已签签署人数
必填
totalSignerNum
int
总签署人数
必填
writeSign
boolean
是否可以圈批，true 为可以圈批
必填
sendUserSignatoryType
int
发起人签署状态 0:发起人不是签署人 1:发起人是签署人，但未签署 2:发起人是签署人，已签署
必填
expireDateTime
string
签字链接过期时间，格式为 yyyy-MM-dd HH:mm:ss
必填
sendUser
boolean
是否是发送人
必填
name
string
签署名称
必填
consumeCoin
int
签字链接消耗份数
必填
signLinkStatus
int
签字链接状态：1发出，2撤回，3关闭
必填
type
int
签署模式：1单人签，2多人签
必填
needPaid
boolean
当前用户需要支付份数
必填
signLinkSignatoryStatus
int
签字人签署状态：0接收，1保存，3打回，4提交，5实名但未签署
必填
payType
int
支付方式：1发送人付费，2接收人付费，3会员发送
必填
raSign
boolean
实名签署
必填
destSignUserNums
int
设定的签署人数
必填
validitySignUserNums
int
剩余人数
必填
validityCoin
int
剩余份数
必填
receiverType
int
接收类型：1微信、2钉钉、3APP
必填
sendUserName
string
发送用户昵称
必填
sendUserId
string
发送用户id
必填
downLoadPermit
boolean
是否允许下载
必填
workflow
boolean
是否是审批多级流程
必填
fileSize
int
文件大小
必填
ossUrl
string
文件ossUrl
必填
buildNo
int
文件buildNo
必填
boxModeNumber
int
签字格子数量
必填
sequenceId
string
文件sequenceId
必填
fileName
string
文件名称
必填
name
string
签署主题
必填
writeSign
boolean
是否可以圈批，true 为可以圈批
必填
corpUserStatus
boolean
false：当前链接使用用户份数，true：当前链接使用团队份数发送，
必填
validityCoin
int
用户或团队的剩余份数
必填
payType
int
支付方式：1发送人付费，2接收人付费
必填
paidAccount
string
个人用户份数返回“个人账号”，团队份数返回团队名
必填
consumeTeamId
int
消费份数的团队id
必填
signerCount
int
签署人数
必填
paraSign
boolean
是否是联名签署
必填
sendUser
boolean
是否是发送人
必填
signLinkStatus
int
签字链接状态：1发出，2撤回，3关闭
必填
signLinkSignatoryStatus
int
签字人签署状态：0接收，1保存，3打回，4提交，5实名但未签署
必填
type
int
签署模式：1单人签，2多人签
必填
msg
string
错误信息
必填
code
int
响应码。0：成功；其他代表错误
必填