Certinal eSign (预览版)
Certinal eSign 使企业能够安全地发送、签名和管理具有全球合规 eSignatures 的文档。 Certinal 专为受管制行业设计,提供实时工作流跟踪、防篡改审核线索和无缝自动化。 在工作流中使用 Certinal eSign 来数字化审批、加速流程,并确保跨 70 多个国家/地区的合法有效的签名。
此连接器在以下产品和区域中可用:
| 服务 | Class | 区域 |
|---|---|---|
| Copilot Studio | 高级 | 除以下各项外的所有 Power Automate 区域 : - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| 逻辑应用程序 | 标准 | 除以下各项外的所有 逻辑应用区域 : - Azure 政府区域 - Azure 中国区域 - 美国国防部(DoD) |
| Power Apps | 高级 | 除以下各项外的所有 Power Apps 区域 : - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| Power Automate | 高级 | 除以下各项外的所有 Power Automate 区域 : - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| 联系人 | |
|---|---|
| Name | 帮助和支持 |
| URL | https://www.certinal.com/department/esignature-for-support |
| tech-support@certinal.com |
| 连接器元数据 | |
|---|---|
| 发布者 | Certinal Inc. |
| 网站 | https://www.certinal.com/ |
| 隐私策略 | https://www.certinal.com/privacy-policy |
| 类别 | 生产力;业务管理 |
Certinal eSign
概述
Certinal eSign 为全球企业提供安全、合规的 eSignature 和 eConsent 工作流-直接从 Power Automate 发送、签名、跟踪和管理文档。
先决条件
需要使用 Certinal 管理员帐户才能使用连接器触发器。 若要在此集成中使用连接器触发器,必须在 Certinal 管理员设置中启用 Power Connector。
如何获取凭据
Certinal 使用 API 密钥对服务进行身份验证。 需要从 Certinal 管理员帐户生成 API 密钥。
支持的作
连接器支持以下作:
获取事务详细信息
按事务 ID 获取事务详细信息
下载事务文档
下载给定事务 ID 的文档
创建事务
创建事务
使用模板创建事务
使用给定模板 ID 创建事务
列出用户
列出用户
获取用户详细信息
获取给定用户 ID 的用户详细信息
创建用户
创建用户
支持的触发器
连接器支持以下触发器:
事务状态更改时
为特定事务事件注册回调
API 文档:
https://certinal.stoplight.io/docs/api/72b66de24898e-introduction
https://www.postman.com/certinal/workspace/certinal-public-workspace/overview
帮助和支持
https://esign.certinal.com/esign/certinal-docs/help-support
正在创建连接
连接器支持以下身份验证类型:
| 默认 | 用于创建连接的参数。 | 所有区域 | 不可共享 |
违约
适用:所有区域
用于创建连接的参数。
这是不可共享的连接。 如果 Power App 与另一个用户共享,系统会提示其他用户显式创建新连接。
| Name | 类型 | Description | 必选 |
|---|---|---|---|
| API 密钥 | securestring | 此 API 的 API 密钥 | True |
| 基本 API 终结点 | 字符串 | API 终结点的基本 URL(例如,api.certinal.com) | True |
限制
| 名称 | 调用 | 续订期 |
|---|---|---|
| 每个连接的 API 调用数 | 100 | 60 秒 |
操作
| 下载事务文档 |
下载给定事务 ID 的文档 |
| 使用模板创建事务 |
使用给定模板 ID 创建事务 |
| 列出用户 |
列出用户 |
| 创建事务 |
创建事务 |
| 创建用户 |
创建用户 |
| 删除订阅 |
删除订阅 |
| 获取事务详细信息 |
按事务 ID 获取事务详细信息 |
| 获取用户详细信息 |
获取给定用户 ID 的用户详细信息 |
下载事务文档
下载给定事务 ID 的文档
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
交易 ID
|
transactionId | True | string |
唯一事务 ID |
|
文档类型
|
documentType | True | string |
要下载的文档的类型 |
返回
- response
- file
使用模板创建事务
使用给定模板 ID 创建事务
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
事务名称
|
name | string |
事务名称 |
|
|
事务状态
|
status | string |
事务状态 |
|
|
外部 ID
|
externalId | string |
外部 ID |
|
|
模板 ID
|
templateId | string |
模板 ID |
|
|
辅助模板 ID
|
secondaryTemplateIds | array of string |
辅助模板 ID |
|
|
Message
|
message | string |
所有参与者电子邮件的邮件。 |
|
|
回调 URL
|
url | string |
回调 URL |
|
|
事务事件
|
transactionEvents | array of string |
事务事件 |
|
|
参与者事件
|
participantEvents | array of string |
参与者事件 |
|
|
参与者序列
|
sequence | integer |
序列 |
|
|
角色
|
role | string |
角色 |
|
|
是否自动处理?
|
autoProcess | boolean |
是否自动处理? |
|
|
字段名称
|
fieldName | string |
字段名称 |
|
|
字段值
|
value | string |
字段值 |
|
|
Name
|
name | string |
候选人的姓名 |
|
|
电子邮件地址
|
emailAddress | string |
候选人的电子邮件地址 |
|
|
Message
|
message | string |
Message |
|
|
语言
|
language | string |
语言 |
|
|
传递渠道
|
deliveryChannels | array of string |
传递渠道 |
|
|
自定义短信正文
|
customSMSBody | string |
自定义短信正文 |
|
|
Name
|
name | string |
Name |
|
|
Message
|
message | string |
Message |
|
|
是否需要?
|
required | boolean |
是否需要? |
|
|
Name
|
name | string |
Name |
|
|
电子邮件地址
|
emailAddress | string |
电子邮件地址 |
|
|
语言
|
language | string |
语言 |
|
|
字段值
|
value | string |
字段值 |
|
|
字段名称
|
fieldName | string |
字段名称 |
|
|
Code
|
code | string |
Code |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
时间戳
|
timestamp | integer |
时间戳 |
|
状态代码
|
statusCode | integer |
状态代码 |
|
Message
|
message | string |
Message |
|
交易 ID
|
data.transactionId | string |
交易 ID |
列出用户
列出用户
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
页码
|
pageNo | True | integer | |
|
每页记录
|
perPageRecords | True | integer |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
时间戳
|
timestamp | integer |
时间戳 |
|
状态代码
|
statusCode | integer |
状态代码 |
|
Message
|
message | string |
Message |
|
记录总数
|
data.totalRecords | integer |
记录总数 |
|
总页数
|
data.totalPages | integer |
总页数 |
|
每页记录
|
data.perPageRecords | integer |
每页记录 |
|
页码
|
data.pageNo | integer |
页码 |
|
记录
|
data.records | array of object |
用户记录 |
|
名字
|
data.records.firstName | string |
名字 |
|
姓氏
|
data.records.lastName | string |
姓氏 |
|
公司
|
data.records.company | string |
公司 |
|
时区
|
data.records.timezone | string |
时区 |
|
语言
|
data.records.language | string |
语言 |
|
DateFormat
|
data.records.dateFormat | string |
DateFormat |
|
职务
|
data.records.jobTitle | string |
职务 |
|
电话号码
|
data.records.phoneNumber | string |
电话号码 |
|
国家/地区代码
|
data.records.phoneCountryCode | string |
国家/地区代码 |
|
角色
|
data.records.roles | array of string |
角色 |
|
最终邮件是否已禁用?
|
data.records.finalMailDisabled | boolean |
最终邮件是否已禁用? |
|
提醒邮件是否已禁用?
|
data.records.reminderMailDisabled | boolean |
提醒邮件是否已禁用? |
|
发件人邮件是否被禁用?
|
data.records.senderMailDisabled | boolean |
发件人邮件是否被禁用? |
|
集成用户吗?
|
data.records.integrationUser | boolean |
集成用户吗? |
|
Salutation
|
data.records.salutation | string |
Salutation |
|
是否处于活动状态
|
data.records.active | boolean |
是否处于活动状态 |
|
Id
|
data.records.id | string |
Id |
|
电子邮件地址
|
data.records.emailAddress | string |
电子邮件地址 |
创建事务
创建事务
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
事务名称
|
name | True | string |
事务名称 |
|
Message
|
message | string |
所有参与者电子邮件的邮件。 |
|
|
回调 URL
|
url | string |
回调 URL |
|
|
事务事件
|
transactionEvents | array of string |
事务事件 |
|
|
参与者事件
|
participantEvents | array of string |
参与者事件 |
|
|
事务状态
|
status | string |
事务状态 |
|
|
外部 ID
|
externalId | string |
外部 ID |
|
|
时间戳过期
|
expiresAtTimestamp | string |
事务在时间戳时过期 |
|
|
从时间戳提醒
|
remindFromTimestamp | string |
从时间戳提醒 |
|
|
提醒频率
|
reminderFrequency | integer |
提醒频率 |
|
|
默认字段
|
default | boolean |
默认签名块字段 |
|
|
参与者序列
|
sequence | integer |
序列 |
|
|
角色
|
role | string |
角色 |
|
|
Name
|
name | string |
候选人的姓名 |
|
|
电子邮件地址
|
emailAddress | string |
候选人的电子邮件地址 |
|
|
语言
|
language | string |
语言 |
|
|
身份验证模式
|
authenticationMode | string |
身份验证模式 |
|
|
身份验证模式值
|
authenticationModeValue | string |
身份验证模式值 |
|
|
传递渠道
|
deliveryChannels | array of string |
传递渠道 |
|
|
字段 ID
|
fieldId | string |
字段 ID |
|
|
页面
|
pages | array of string |
页面 |
|
|
文档 ID
|
documentId | string |
文档 ID |
|
|
字段宽度
|
width | float |
字段宽度 |
|
|
字段高度
|
height | float |
字段高度 |
|
|
Tooltip
|
tooltip | string |
Tooltip |
|
|
DateFormat
|
dateFormat | string |
DateFormat |
|
|
文本区域行计数
|
textareaLineCount | string |
文本区域行计数 |
|
|
字段名称
|
fieldName | string |
字段名称 |
|
|
X 位置
|
xposition | float |
字段的 X 位置 |
|
|
Y 位置
|
yposition | float |
字段的 Y 位置 |
|
|
是否需要?
|
required | boolean |
这是必填字段吗? |
|
|
是否为只读?
|
readOnly | boolean |
这是只读字段吗? |
|
|
文本区域
|
textarea | boolean |
文本区域 |
|
|
上下角
|
topBottom | boolean |
上下角 |
|
|
垂直
|
vertical | boolean |
垂直 |
|
|
单选组 ID
|
radioGroupId | string |
单选组 ID |
|
|
默认值
|
defaultValue | string |
默认值 |
|
|
价值
|
value | string |
价值 |
|
|
显示标签
|
displayLabel | string |
显示标签 |
|
|
Name
|
name | string |
Name |
|
|
电子邮件地址
|
emailAddress | string |
电子邮件地址 |
|
|
语言
|
language | string |
语言 |
|
|
文档 ID
|
id | string |
文档 ID |
|
|
序列
|
sequence | integer |
序列 |
|
|
可删除吗?
|
deletable | boolean |
可删除吗? |
|
|
专用
|
private | boolean |
专用 |
|
|
字段值
|
value | string |
字段值 |
|
|
字段名称
|
fieldName | string |
字段名称 |
|
|
Code
|
code | string |
Code |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
时间戳
|
timestamp | integer |
时间戳 |
|
状态代码
|
statusCode | integer |
状态代码 |
|
Message
|
message | string |
Message |
|
交易 ID
|
data.transactionId | string |
交易 ID |
创建用户
创建用户
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
电子邮件地址
|
emailAddress | string |
电子邮件地址 |
|
|
名字
|
firstName | string |
名字 |
|
|
姓氏
|
lastName | string |
姓氏 |
|
|
公司
|
company | string |
公司 |
|
|
时区
|
timezone | string |
时区 |
|
|
语言
|
language | string |
语言 |
|
|
DateFormat
|
dateFormat | string |
DateFormat |
|
|
Salutation
|
salutation | string |
Salutation |
|
|
职务
|
jobTitle | string |
职务 |
|
|
电话号码
|
phoneNumber | string |
电话号码 |
|
|
国家/地区代码
|
phoneCountryCode | string |
国家/地区代码 |
|
|
角色
|
roles | array of string |
角色 |
|
|
最终邮件是否已禁用?
|
finalMailDisabled | boolean |
最终邮件是否已禁用? |
|
|
提醒邮件是否已禁用?
|
reminderMailDisabled | boolean |
提醒邮件是否已禁用? |
|
|
发件人邮件是否被禁用?
|
senderMailDisabled | boolean |
发件人邮件是否被禁用? |
|
|
集成用户吗?
|
integrationUser | boolean |
集成用户吗? |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
时间戳
|
timestamp | integer |
时间戳 |
|
状态代码
|
statusCode | integer |
状态代码 |
|
Message
|
message | string |
Message |
|
用户 ID
|
data.user_id | string |
用户 ID |
删除订阅
删除订阅
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Webhook Id
|
webhookId | True | string |
要删除的 Webhook 订阅的唯一标识符 |
获取事务详细信息
按事务 ID 获取事务详细信息
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
交易 ID
|
transactionId | True | string |
唯一事务 ID |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
时间戳
|
timestamp | integer |
时间戳 |
|
状态代码
|
statusCode | integer |
状态代码 |
|
Message
|
message | string |
Message |
|
事务名称
|
data.name | string |
事务名称 |
|
事务状态
|
data.status | string |
事务状态 |
|
交易 ID
|
data.transactionId | string |
交易 ID |
|
Message
|
data.mail.message | string |
所有参与者电子邮件的邮件。 |
|
上次更新时间
|
data.lastUpdatedDate | string |
上次更新时间 |
|
创建日期
|
data.createdDate | string |
创建日期 |
|
用户 ID
|
data.createdBy.id | string |
由用户 ID 创建 |
|
用户名
|
data.createdBy.username | string |
按用户名创建 |
|
电子邮件地址
|
data.createdBy.emailAddress | string |
通过电子邮件地址创建 |
|
发送日期
|
data.sentDate | string |
发送日期 |
|
用户 ID
|
data.lastActionPerformedBy.userId | string |
用户 ID |
|
用户名
|
data.lastActionPerformedBy.userName | string |
用户名 |
|
电子邮件地址
|
data.lastActionPerformedBy.emailAddress | string |
电子邮件地址 |
|
候选 ID
|
data.lastActionPerformedBy.candidateId | string |
候选 ID |
|
参与者 ID
|
data.lastActionPerformedBy.participantId | string |
参与者 ID |
|
时间戳过期
|
data.expiryAndReminders.expiresAtTimestamp | string |
事务在时间戳时过期 |
|
到期日
|
data.expiryAndReminders.expiryDays | integer |
到期日 |
|
提醒日提醒
|
data.expiryAndReminders.remindFromReminderDays | integer |
提醒日提醒 |
|
提醒提醒时间
|
data.expiryAndReminders.remindFromReminderTime | string |
提醒提醒时间 |
|
提醒频率
|
data.expiryAndReminders.reminderFrequency | integer |
提醒频率 |
|
参与者
|
data.participants | array of object |
参与者 |
|
参与者 ID
|
data.participants.id | string |
参与者 ID |
|
参与者状态
|
data.participants.status | string |
参与者状态 |
|
上次更新时间
|
data.participants.lastUpdatedDate | string |
上次更新时间 |
|
创建日期
|
data.participants.createdDate | string |
创建日期 |
|
参与者序列
|
data.participants.sequence | integer |
序列 |
|
角色
|
data.participants.role | string |
角色 |
|
签名方法
|
data.participants.signingMethodDTO | array of string |
签名方法详细信息 |
|
由用户提交
|
data.participants.submittedBys | array of object |
由用户详细信息提交 |
|
用户 ID
|
data.participants.submittedBys.userId | string |
按用户的 ID 提交 |
|
用户名
|
data.participants.submittedBys.userName | string |
按用户名提交 |
|
电子邮件地址
|
data.participants.submittedBys.emailAddress | string |
由用户的电子邮件地址提交 |
|
候选 ID
|
data.participants.submittedBys.candidateId | string |
候选 ID |
|
候选人
|
data.participants.candidates | array of object |
候选人 |
|
候选 ID
|
data.participants.candidates.id | string |
候选 ID |
|
Name
|
data.participants.candidates.name | string |
候选人的姓名 |
|
电子邮件地址
|
data.participants.candidates.emailAddress | string |
候选人的电子邮件地址 |
|
语言
|
data.participants.candidates.language | string |
语言 |
|
类型
|
data.participants.candidates.type | string |
类型 |
|
Action
|
data.participants.candidates.action | string |
Action |
|
作日期
|
data.participants.candidates.actionDate | string |
作日期 |
|
创建日期
|
data.participants.candidates.createdDate | string |
创建日期 |
|
身份验证模式值
|
data.participants.candidates.authenticationInfo.authenticationModeValue | string |
身份验证模式值 |
|
signing 方法详细信息
|
data.participants.candidates.signingMethodDTO | array of string |
signing 方法详细信息 |
|
附件
|
data.participants.candidates.attachments | array of |
附件 |
|
传递渠道
|
data.participants.candidates.deliveryChannels | array of string |
传递渠道 |
|
Fields
|
data.participants.fields | array of object |
Fields |
|
Id
|
data.participants.fields.id | string |
Id |
|
上次更新时间
|
data.participants.fields.lastUpdatedDate | string |
上次更新时间 |
|
创建日期
|
data.participants.fields.createdDate | string |
创建日期 |
|
字段 ID
|
data.participants.fields.fieldId | string |
字段 ID |
|
页号
|
data.participants.fields.pageNo | integer |
页号 |
|
文档 ID
|
data.participants.fields.documentId | string |
文档 ID |
|
字段宽度
|
data.participants.fields.width | float |
字段宽度 |
|
字段高度
|
data.participants.fields.height | float |
字段高度 |
|
Tooltip
|
data.participants.fields.tooltip | string |
Tooltip |
|
价值
|
data.participants.fields.value | string |
价值 |
|
Validation
|
data.participants.fields.validation | string |
Validation |
|
NameStyle
|
data.participants.fields.nameStyle | string |
NameStyle |
|
DateFormat
|
data.participants.fields.dateFormat | string |
DateFormat |
|
显示标签
|
data.participants.fields.displayLabel | string |
显示标签 |
|
链接类型
|
data.participants.fields.linkType | string |
链接类型 |
|
单选 ID
|
data.participants.fields.radioId | integer |
单选 ID |
|
单选组 ID
|
data.participants.fields.radioGroupId | string |
单选组 ID |
|
复选框 ID
|
data.participants.fields.checkboxId | integer |
复选框 ID |
|
字段名称
|
data.participants.fields.fieldName | string |
字段名称 |
|
X 位置
|
data.participants.fields.xposition | float |
字段的 X 位置 |
|
Y 位置
|
data.participants.fields.yposition | float |
字段的 Y 位置 |
|
是否需要?
|
data.participants.fields.required | boolean |
这是必填字段吗? |
|
是否为只读?
|
data.participants.fields.readOnly | boolean |
这是只读字段吗? |
|
文本区域
|
data.participants.fields.textarea | boolean |
文本区域 |
|
垂直
|
data.participants.fields.vertical | boolean |
垂直 |
|
上下角
|
data.participants.fields.topBottom | boolean |
上下角 |
|
默认值
|
data.participants.fields.defaultValue | string |
默认值 |
|
Format
|
data.participants.signatureBlock.format | array of object |
Format |
|
Id
|
data.participants.signatureBlock.format.id | string |
Id |
|
序列
|
data.participants.signatureBlock.format.sequence | integer |
序列 |
|
是否需要?
|
data.participants.signatureBlock.format.required | boolean |
是否需要? |
|
违约
|
data.participants.signatureBlock.default | boolean |
违约 |
|
启用委托
|
data.participants.enableDelegate | boolean |
启用委托 |
|
自动处理
|
data.participants.autoProcess | boolean |
自动处理 |
|
CC 用户
|
data.ccUsers | array of object |
CC 用户 |
|
Name
|
data.ccUsers.name | string |
Name |
|
电子邮件地址
|
data.ccUsers.emailAddress | string |
电子邮件地址 |
|
语言
|
data.ccUsers.language | string |
语言 |
|
文档
|
data.documents | array of object |
文档 |
|
文档 ID
|
data.documents.id | string |
文档 ID |
|
序列
|
data.documents.sequence | integer |
序列 |
|
文件名
|
data.documents.fileName | string |
文件名 |
|
页计数
|
data.documents.pageCount | integer |
页计数 |
|
可删除吗?
|
data.documents.deletable | boolean |
可删除吗? |
|
专用
|
data.documents.private | boolean |
专用 |
|
自定义字段
|
data.customFields | array of object |
自定义字段 |
|
自定义字段 ID
|
data.customFields.customFieldId | string |
自定义字段 ID |
|
字段值
|
data.customFields.value | string |
字段值 |
|
字段名称
|
data.customFields.fieldName | string |
字段名称 |
|
字段类型
|
data.customFields.fieldType | string |
字段类型 |
|
通知订阅
|
data.notificationSubscriptions | array of |
通知订阅 |
|
tags
|
data.tags | array of |
tags |
|
其他文档
|
data.additionalDocuments | array of object |
其他文档 |
|
Id
|
data.additionalDocuments.id | string |
Id |
|
文件名
|
data.additionalDocuments.fileName | string |
文件名 |
|
类型
|
data.additionalDocuments.type | string |
类型 |
|
候选 ID
|
data.additionalDocuments.candidateId | string |
候选 ID |
|
单独的协议
|
data.separateAgreements | boolean |
单独的协议 |
获取用户详细信息
获取给定用户 ID 的用户详细信息
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
用户 ID
|
userId | True | string |
唯一用户 ID |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
时间戳
|
timestamp | integer |
时间戳 |
|
状态代码
|
statusCode | integer |
状态代码 |
|
Message
|
message | string |
Message |
|
名字
|
data.firstName | string |
名字 |
|
姓氏
|
data.lastName | string |
姓氏 |
|
公司
|
data.company | string |
公司 |
|
时区
|
data.timezone | string |
时区 |
|
语言
|
data.language | string |
语言 |
|
DateFormat
|
data.dateFormat | string |
DateFormat |
|
职务
|
data.jobTitle | string |
职务 |
|
电话号码
|
data.phoneNumber | string |
电话号码 |
|
国家/地区代码
|
data.phoneCountryCode | string |
国家/地区代码 |
|
角色
|
data.roles | array of string |
角色 |
|
最终邮件是否已禁用?
|
data.finalMailDisabled | boolean |
最终邮件是否已禁用? |
|
提醒邮件是否已禁用?
|
data.reminderMailDisabled | boolean |
提醒邮件是否已禁用? |
|
发件人邮件是否被禁用?
|
data.senderMailDisabled | boolean |
发件人邮件是否被禁用? |
|
集成用户吗?
|
data.integrationUser | boolean |
集成用户吗? |
|
Salutation
|
data.salutation | string |
Salutation |
|
是否处于活动状态
|
data.active | boolean |
是否处于活动状态 |
|
Id
|
data.id | string |
Id |
|
电子邮件地址
|
data.emailAddress | string |
电子邮件地址 |
触发器
| 事务状态更改时 |
为特定事务事件注册回调 |
事务状态更改时
为特定事务事件注册回调
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
事件类型
|
eventType | True | array |
要注册的事务事件类型 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
时间戳
|
timestamp | integer |
时间戳 |
|
状态代码
|
statusCode | integer |
状态代码 |
|
Message
|
message | string |
Message |
|
事务名称
|
data.name | string |
事务名称 |
|
事务状态
|
data.status | string |
事务状态 |
|
交易 ID
|
data.transactionId | string |
交易 ID |
|
Message
|
data.mail.message | string |
所有参与者电子邮件的邮件。 |
|
上次更新时间
|
data.lastUpdatedDate | string |
上次更新时间 |
|
创建日期
|
data.createdDate | string |
创建日期 |
|
用户 ID
|
data.createdBy.id | string |
由用户 ID 创建 |
|
用户名
|
data.createdBy.username | string |
按用户名创建 |
|
电子邮件地址
|
data.createdBy.emailAddress | string |
通过电子邮件地址创建 |
|
发送日期
|
data.sentDate | string |
发送日期 |
|
用户 ID
|
data.lastActionPerformedBy.userId | string |
用户 ID |
|
用户名
|
data.lastActionPerformedBy.userName | string |
用户名 |
|
电子邮件地址
|
data.lastActionPerformedBy.emailAddress | string |
电子邮件地址 |
|
候选 ID
|
data.lastActionPerformedBy.candidateId | string |
候选 ID |
|
参与者 ID
|
data.lastActionPerformedBy.participantId | string |
参与者 ID |
|
时间戳过期
|
data.expiryAndReminders.expiresAtTimestamp | string |
事务在时间戳时过期 |
|
到期日
|
data.expiryAndReminders.expiryDays | integer |
到期日 |
|
提醒日提醒
|
data.expiryAndReminders.remindFromReminderDays | integer |
提醒日提醒 |
|
提醒提醒时间
|
data.expiryAndReminders.remindFromReminderTime | string |
提醒提醒时间 |
|
提醒频率
|
data.expiryAndReminders.reminderFrequency | integer |
提醒频率 |
|
参与者
|
data.participants | array of object |
参与者 |
|
参与者 ID
|
data.participants.id | string |
参与者 ID |
|
参与者状态
|
data.participants.status | string |
参与者状态 |
|
上次更新时间
|
data.participants.lastUpdatedDate | string |
上次更新时间 |
|
创建日期
|
data.participants.createdDate | string |
创建日期 |
|
参与者序列
|
data.participants.sequence | integer |
序列 |
|
角色
|
data.participants.role | string |
角色 |
|
签名方法
|
data.participants.signingMethodDTO | array of string |
签名方法详细信息 |
|
由用户提交
|
data.participants.submittedBys | array of object |
由用户详细信息提交 |
|
用户 ID
|
data.participants.submittedBys.userId | string |
按用户的 ID 提交 |
|
用户名
|
data.participants.submittedBys.userName | string |
按用户名提交 |
|
电子邮件地址
|
data.participants.submittedBys.emailAddress | string |
由用户的电子邮件地址提交 |
|
候选 ID
|
data.participants.submittedBys.candidateId | string |
候选 ID |
|
候选人
|
data.participants.candidates | array of object |
候选人 |
|
候选 ID
|
data.participants.candidates.id | string |
候选 ID |
|
Name
|
data.participants.candidates.name | string |
候选人的姓名 |
|
电子邮件地址
|
data.participants.candidates.emailAddress | string |
候选人的电子邮件地址 |
|
语言
|
data.participants.candidates.language | string |
语言 |
|
类型
|
data.participants.candidates.type | string |
类型 |
|
Action
|
data.participants.candidates.action | string |
Action |
|
作日期
|
data.participants.candidates.actionDate | string |
作日期 |
|
创建日期
|
data.participants.candidates.createdDate | string |
创建日期 |
|
身份验证模式值
|
data.participants.candidates.authenticationInfo.authenticationModeValue | string |
身份验证模式值 |
|
signing 方法详细信息
|
data.participants.candidates.signingMethodDTO | array of string |
signing 方法详细信息 |
|
附件
|
data.participants.candidates.attachments | array of |
附件 |
|
传递渠道
|
data.participants.candidates.deliveryChannels | array of string |
传递渠道 |
|
Fields
|
data.participants.fields | array of object |
Fields |
|
Id
|
data.participants.fields.id | string |
Id |
|
上次更新时间
|
data.participants.fields.lastUpdatedDate | string |
上次更新时间 |
|
创建日期
|
data.participants.fields.createdDate | string |
创建日期 |
|
字段 ID
|
data.participants.fields.fieldId | string |
字段 ID |
|
页号
|
data.participants.fields.pageNo | integer |
页号 |
|
文档 ID
|
data.participants.fields.documentId | string |
文档 ID |
|
字段宽度
|
data.participants.fields.width | float |
字段宽度 |
|
字段高度
|
data.participants.fields.height | float |
字段高度 |
|
Tooltip
|
data.participants.fields.tooltip | string |
Tooltip |
|
价值
|
data.participants.fields.value | string |
价值 |
|
Validation
|
data.participants.fields.validation | string |
Validation |
|
NameStyle
|
data.participants.fields.nameStyle | string |
NameStyle |
|
DateFormat
|
data.participants.fields.dateFormat | string |
DateFormat |
|
显示标签
|
data.participants.fields.displayLabel | string |
显示标签 |
|
链接类型
|
data.participants.fields.linkType | string |
链接类型 |
|
单选 ID
|
data.participants.fields.radioId | integer |
单选 ID |
|
单选组 ID
|
data.participants.fields.radioGroupId | string |
单选组 ID |
|
复选框 ID
|
data.participants.fields.checkboxId | integer |
复选框 ID |
|
字段名称
|
data.participants.fields.fieldName | string |
字段名称 |
|
X 位置
|
data.participants.fields.xposition | float |
字段的 X 位置 |
|
Y 位置
|
data.participants.fields.yposition | float |
字段的 Y 位置 |
|
是否需要?
|
data.participants.fields.required | boolean |
这是必填字段吗? |
|
是否为只读?
|
data.participants.fields.readOnly | boolean |
这是只读字段吗? |
|
文本区域
|
data.participants.fields.textarea | boolean |
文本区域 |
|
垂直
|
data.participants.fields.vertical | boolean |
垂直 |
|
上下角
|
data.participants.fields.topBottom | boolean |
上下角 |
|
默认值
|
data.participants.fields.defaultValue | string |
默认值 |
|
Format
|
data.participants.signatureBlock.format | array of object |
Format |
|
Id
|
data.participants.signatureBlock.format.id | string |
Id |
|
序列
|
data.participants.signatureBlock.format.sequence | integer |
序列 |
|
是否需要?
|
data.participants.signatureBlock.format.required | boolean |
是否需要? |
|
违约
|
data.participants.signatureBlock.default | boolean |
违约 |
|
启用委托
|
data.participants.enableDelegate | boolean |
启用委托 |
|
自动处理
|
data.participants.autoProcess | boolean |
自动处理 |
|
CC 用户
|
data.ccUsers | array of object |
CC 用户 |
|
Name
|
data.ccUsers.name | string |
Name |
|
电子邮件地址
|
data.ccUsers.emailAddress | string |
电子邮件地址 |
|
语言
|
data.ccUsers.language | string |
语言 |
|
文档
|
data.documents | array of object |
文档 |
|
文档 ID
|
data.documents.id | string |
文档 ID |
|
序列
|
data.documents.sequence | integer |
序列 |
|
文件名
|
data.documents.fileName | string |
文件名 |
|
页计数
|
data.documents.pageCount | integer |
页计数 |
|
可删除吗?
|
data.documents.deletable | boolean |
可删除吗? |
|
专用
|
data.documents.private | boolean |
专用 |
|
自定义字段
|
data.customFields | array of object |
自定义字段 |
|
自定义字段 ID
|
data.customFields.customFieldId | string |
自定义字段 ID |
|
字段值
|
data.customFields.value | string |
字段值 |
|
字段名称
|
data.customFields.fieldName | string |
字段名称 |
|
字段类型
|
data.customFields.fieldType | string |
字段类型 |
|
通知订阅
|
data.notificationSubscriptions | array of |
通知订阅 |
|
tags
|
data.tags | array of |
tags |
|
其他文档
|
data.additionalDocuments | array of object |
其他文档 |
|
Id
|
data.additionalDocuments.id | string |
Id |
|
文件名
|
data.additionalDocuments.fileName | string |
文件名 |
|
类型
|
data.additionalDocuments.type | string |
类型 |
|
候选 ID
|
data.additionalDocuments.candidateId | string |
候选 ID |
|
单独的协议
|
data.separateAgreements | boolean |
单独的协议 |
定义
文件
这是基本数据类型“file”。