Foxit eSign （预览版）

Foxit eSign 是一种电子签名解决方案，可让你在线发送、签名和管理文档，而无需打印、扫描或邮寄。 上传文档、定义签名字段，并将其发送给收件人，以便快速、合法地绑定 eSignatures。

此连接器在以下产品和区域中可用：

Service 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 Foxit eSign 支持
URL https://www.foxit.com
Email api@foxit.com
连接器元数据
Publisher Foxit Software Inc.
网站 https://www.foxit.com/esign-pdf/
隐私策略 https://www.foxit.com/company/privacy-policy.html
类别 生产力;内容和文件

Foxit eSign

Foxit eSign 是一种企业级电子签名解决方案，使企业能够完全在线发送、签名和管理具有法律约束力的文档，而无需打印、扫描或邮件。 上传文档、定义签名字段并将其发送给收件人，以便快速、安全的 eSignatures。 Foxit eSign 完全符合包括 ESIGN 和 UETA 在内的主要电子签名法律，使用加密来保护传输中的文档和静态文档，并支持多重身份验证，以确保只有授权的签名者可以访问和签名文档。

使用适用于 Microsoft Power Automate 的 Foxit eSign 连接器，可以自动完成文档签名工作流，从创建信封并将其发送到签名、跟踪状态、下载已完成的文档、管理模板，以及当信封事件发生时触发下游操作。

Publisher：Foxit Corporation

先决条件

若要使用此连接器，需要：

  • 具有自定义连接器或高级连接器访问权限的Microsoft Power Apps或Power Automate计划
  • Foxit eSign 帐户 - 在此处创建一个
  • 在 Foxit eSign 帐户上启用 API 访问（请参阅以下获取凭据）

获取凭据

  1. 如果还没有 Foxit eSign 帐户，请创建一个帐户。
  2. 请联系 Foxit 销售团队，请求在帐户上启用 API 访问权限。 批准后，API 访问权限将在帐户上激活。
  3. 在Power Automate中，在连接器列表中搜索 Foxit eSign，然后选择“创建连接”。
  4. 你将重定向到 Foxit eSign 登录页。 使用 Foxit eSign 凭据登录以授权连接。
  5. 授权后，连接即可在流中使用。

入门

创建连接后，可以使用 Foxit eSign 连接器开始生成流：

  • 使用 触发器 在信封事件发生时自动启动流（例如，当各方已签名时）。
  • 使用 操作 创建信封、发送签名提醒、下载已完成的文档、管理模板等。
  • 将多个操作链接在一起 - 例如，从模板创建信封，等待完全执行的触发器，然后下载签名的文档并将其存储在SharePoint中。

支持的触发器

触发器 Description
发送信封时 向收件人发送信封时触发。 要求将 Webhook 级别设置为 “帐户”。
查看信封时 当收件人打开并查看信封时触发。
签名信封时 当收件人签署信封时触发。
取消信封时 当收件人或发件人取消信封时触发。
完全执行信封时 当所有收件人已签名且信封已完全完成时触发。
删除信封时 删除信封时触发。

支持的操作

信封

Action Description
从 URL 创建信封 使用可公开访问的 PDF URL 创建和发送信封。
从 Base64 创建信封 使用 Base64 编码的 PDF 文档创建和发送信封。
从模板创建信封 从现有的 Foxit eSign 模板创建并发送信封。
获取信封详细信息 检索信封的完整详细信息和当前状态。
获取信封 ID 根据筛选器条件检索信封 ID 列表。
发送签名提醒 向信封的挂起签名者发送提醒通知。
下载信封文件 将信封中的所有已签名文档下载为 zip 文件。
下载单个文档 PDF 以 PDF 格式从信封下载单个文档。
将信封移动到回收站 将一个或多个信封移动到回收站。
取消信封 取消信封并通知收件人。
删除信封 永久删除一个或多个信封。
获取信封活动历史记录 检索信封的完整活动日志。
获取已删除的信封历史记录 检索帐户中已删除信封的历史记录。

模板

Action Description
从 URL 创建模板 使用可公开访问的 PDF URL 创建可重用的签名模板。
从 Base64 创建模板 使用 Base64 编码的 PDF 文档创建可重用的签名模板。
获取模板详细信息 检索特定模板的完整详细信息，包括字段定义。
按模板 ID 获取模板 按 ID 检索一个或多个模板的详细信息。
获取所有模板的列表 检索帐户中可用的所有模板。

网络钩子

Action Description
列出所有 Webhook 通道 返回帐户中配置的所有 Webhook 通道的列表。
获取 Webhook 通道详细信息 检索特定 Webhook 通道的详细信息。

电子邮件组

Action Description
创建电子邮件组 创建一个新的电子邮件组，用作信封中的收件人。
获取电子邮件组详细信息 检索电子邮件组的详细信息和成员。

报表

Action Description
下载报表 以Microsoft Excel格式下载帐户活动报告。

已知问题和限制

  • 速率限制：Foxit eSign API 允许 每个帐户每 5 分钟最多 4,000 个请求。 超出此限制的请求会收到 429 Too Many Requests 响应。 建议在流中使用指数退避实现重试逻辑，以正常处理此逻辑。

  • 文件大小限制：每个文档的最大文件大小为 25 MB。 此限制适用于单个文件，不适用于总信封大小。

  • Webhook 自动取消订阅：由于 Foxit eSign webhook 删除 API 中存在限制（使用 POST 方法而不是 DELETE），Power Automate删除或修改基于触发器的流时无法自动清理 Webhook 通道订阅。 使用 “列出所有 Webhook 通道” 操作来标识活动通道，使用 Foxit eSign 门户在解除流授权时删除订阅。

  • 发送信封时 - 仅帐户级别：“发送信封时”触发器仅在 Webhook 级别设置为 “帐户”时触发。 它不会针对 在 API 应用 级别创建的信封触发。 确保在配置此触发器时选择帐户级别。

  • 区域可用性：连接器适用于北美（NA1）和欧盟区域帐户。 配置连接时，请选择相应的服务器区域。 连接到错误区域将导致身份验证失败。

  • Base64 文档大小：使用 Base64 创建信封或从 Base64 操作创建模板时，Base64 编码的字符串必须对应于不超过 25 MB 的源文件。

支持

有关开发人员支持，请联系 Foxit eSign 团队。devsupport@foxitsoftware.com

若要提交支持案例，请访问 https://kb.foxit.com/s/submit-a-case。

限制

名称 调用 续订期
每个连接的 API 调用数 100 60 秒

操作

下载信封文件

以文件的形式从信封下载已完成的文档。
下载单个文档 PDF

将单个文档从信封下载为 PDF 文件。
下载报表

将信封活动报告下载为Microsoft Excel文件。 使用筛选器按状态、日期范围、信封名称、作者或签名者缩小结果范围。
从 Base64 创建信封

使用 Base64 编码的 PDF 文档创建和发送信封。
从 Base64 创建模板

使用 Base64 编码的 PDF 字符串创建新模板。 当 PDF 文件已作为流中的 Base64 字符串提供（例如，从SharePoint文件或OneDrive文档）中可用时，请使用此功能。
从 URL 创建信封

使用可公开访问的 PDF URL 创建和发送信封。 提供文档 URL 和收件人详细信息以启动签名过程。
从 URL 创建模板

使用可公开访问的 PDF URL 创建新模板。
从模板创建信封

使用现有模板创建和发送信封。 可以自定义收件人详细信息。
列出所有 Webhook 通道

返回帐户中配置的所有 Webhook 通道的列表。
创建电子邮件组

创建一个新的电子邮件组，该组可用于一次性向多个收件人发送信封。
删除信封

永久删除一个或多个信封。
发送签名提醒

向信封的挂起收件人发送提醒通知，提示他们完成签名。
取消信封

取消已发送的信封。 收件人将无法再对文档进行签名。
取消订阅 Webhook 触发器

按其通道 ID 删除活动的 Webhook 通道订阅。 使用此操作清理不再需要的 Webhook 订阅。
将信封移动到回收站

将一个或多个信封移动到回收站。 回收站中的信封不会永久删除。
按模板 ID 获取模板

按 ID 检索一个或多个模板的详细信息。
获取 Webhook 通道详细信息

检索特定 Webhook 通道的详细信息。
获取信封 ID

返回按状态筛选的信封 ID 列表。 使用此方法可查找处于特定状态的信封。
获取信封活动历史记录

检索信封的完整活动日志，其中显示了收件人和发件人执行的所有操作。
获取信封详细信息

检索信封的完整详细信息，包括其状态、收件人和文档。
获取已删除的信封历史记录

检索已删除或移动到回收站的信封的历史记录。
获取所有模板的列表

返回帐户中可用的所有模板的列表。
获取模板详细信息

检索特定模板的完整详细信息，包括其字段和收件人。
获取电子邮件组详细信息

检索现有电子邮件组的详细信息。

下载信封文件

操作 ID:
DownloadEnvelopeFiles

以文件的形式从信封下载已完成的文档。

参数

名称 密钥 必需 类型 说明
信封 ID
 folderId True string

要下载其文档的信封的唯一标识符。

返回

响应
binary

下载单个文档 PDF

操作 ID:
DownloadSingleDocumentPDF

将单个文档从信封下载为 PDF 文件。

参数

名称 密钥 必需 类型 说明
信封 ID
 folderId True string

包含要下载的文档的信封的唯一标识符。
文档编号
 docNumber True string

要下载的文档的索引，从 1 开始。

返回

响应
binary

下载报表

操作 ID:
DownloadReport

将信封活动报告下载为Microsoft Excel文件。 使用筛选器按状态、日期范围、信封名称、作者或签名者缩小结果范围。

参数

名称 密钥 必需 类型 说明
envelopeStatus
 status string

我们将筛选报表的文件夹的状态
创建日期
 creationDateFrom string

“创建日期”范围的开始。 接受的格式：YYYY-MM-DD。
创建日期到
 creationDateTo string

创建日期范围的结束。 接受的格式：YYYY-MM-DD。
信封名称
 folderName string

包含此字符串的任何文件夹。
包括字段
 includeFields string

设置为“true”以在报表中包含信封字段值。 默认值为“false”。
创作Email
 authorEmail string

筛选报表以仅包含此作者电子邮件地址创建的信封。
签名者电子邮件
 signerEmail string

筛选报表以仅包含此电子邮件地址是签名者的信封。

返回

报表文件
binary

从 Base64 创建信封

操作 ID:
CreateEnvelopefromBase64

使用 Base64 编码的 PDF 文档创建和发送信封。

参数

名称 密钥 必需 类型 说明
信封名称
 folderName True string

此信封的名称。
输入类型
 inputType string

文档源的输入类型。 修复了此操作的 base64。
Base64 文件字符串
 base64FileString True array of string

要发送的 Base64 编码 PDF 文档的数组。
文件名
 fileNames True array of string

每个文档的显示名称数组，顺序与 Base64 文件字符串数组相同。
名字
 firstName True string

收件人的名字。
姓氏
 lastName True string

收件人的姓氏。
Email地址
 emailId True string

收件人的电子邮件地址。
权限
 permission True string
序列
 sequence True integer

使用此字段可向收件人列表中的收件人分配序列号。 对从 1 开始的每个方使用唯一序列号，例如 1,2,3,4....如果在签名工作流中多次出现一个人，请在每次重复收件人时分配不同的序列。
signerAuthLevels
 signerAuthLevel string

签名者用于验证的身份验证级别
占位符
 isPlaceholder boolean

使用此字段启动参与方是占位符。 注意：1. firstName、lastName、emailId 参数的值必须为此方空白。 2. 若要添加占位符，必须使用“PARTY_ASSIGNER”权限重新引用一个收件人。
收件人角色
 partyRole string

使用此字段分配占位符的角色。
允许名称更改
 allowNameChange string

值可以是 true 或 false，使用此参数允许签名者在完成签名过程之前更新名字和姓氏。
工作流序列
 workflowSequence integer

向此收件人分配工作流序列号。 启用登录序列后，收件人会按升序顺序接收其签名邀请。
主机电子邮件 ID
 hostEmailId string

In-Person 管理员的电子邮件地址。
访问代码
 userDefinedAccessCode string

当“signerAuthLevel”值设置为“用户定义的访问代码”进行身份验证时，该参数将包含 Access Code。 注意：1. 代码不区分大小写。 2. 系统不发送此代码，因此必须直接与签名者共享此代码。 3. 访问代码可以包含字母、数字和以下特殊字符：@、&、{,}%、（、）、~、|,!,+、^。
群是电子邮件组
 partyIsEmailGroup boolean

批量创建群时使用此参数。 注意： 如果此参数为 true，将忽略此参与方的 firstName、lastName 和 emailId。
电子邮件组 ID
 emailGroupId integer

传递要用于批量创建组 ID 的电子邮件。
单一签名者批量
 allowSingleSignerInBulk boolean

使用此参数仅允许一个人登录电子邮件组。
拨号代码
 dialingCode string

使用此字段可分配国家/地区拨入代码是收件人列表中的收件人的手机号码前缀。
手机号
 mobileNumber string

使用此字段可向收件人列表中的收件人分配一个手机号码。
Fields
 Fields object
立即发送
 sendNow boolean

启用后，Foxit eSign 会立即向每个收件人的电子邮件地址发送唯一的签名链接。 请禁用此选项以将信封保存为草稿。
创建嵌入式签名会话
 createEmbeddedSigningSession True boolean

签名会话令牌将生成，而不会向收件人发送电子邮件。
为各方创建嵌入式签名会话
 createEmbeddedSigningSessionForAllParties boolean

如果设置为 true，则会为信封中的每个收件人生成嵌入签名 URL。
处理文本标记
 processTextTags True boolean

值可以是 true 或 false。 此字段用于确定 Foxit eSign 是否应分析文本标记的文档，以将它们转换为 Foxit eSign 字段。
处理 Acro 字段
 processAcroFields True boolean

此字段用于确定 Foxit eSign 是否应分析 AcroFields 的文档，以将其转换为 Foxit eSign 字段。
登录顺序
 signInSequence boolean

此字段用于确定收件人是否按顺序对信封文档进行签名。 如果为 false，则所有收件人同时接收邀请电子邮件。 如果为 true，则每个收件人在上一个收件人完成所需任务后连续接收邀请电子邮件，例如对文档进行签名或填写字段等。
“亲自启用”
 inPersonEnable boolean

此字段用于启动可在几分钟内在任何设备上轻松完成的人员签名过程，并在需要时避免基于电子邮件的签名。 如果为 false，则所有收件人同时收到邀请电子邮件。 如果为 true，则内部管理员会收到邀请电子邮件，以启动签名者的签名过程。
修复收件人参与方
 fixRecipientParties boolean

如果为 true，则嵌入发送视图中无法更改已作为此请求的一部分添加的信封的参与方。
修复文档
 fixDocuments boolean

如果为 true，则嵌入发送中无法更改已作为此请求的一部分添加的信封的文档。
发送成功 URL
 sendSuccessUrl string

输入登录页的绝对 URL，登录者将在嵌入的发送视图中成功发送文件夹后重定向到该 URL。
发送错误 URL
 sendErrorUrl string

输入登陆页面的绝对 URL，如果发送嵌入的发送视图中的文件夹出现错误，签名者将重定向到该 URL。
创建嵌入式发送会话
 createEmbeddedSendingSession boolean

如果设置为 true，它将生成嵌入令牌以打开 Foxit eSign 的文档准备视图。
嵌入式签名者电子邮件 ID
 embeddedSignersEmailIds array of string

需要为其创建嵌入式签名会话的收件人的电子邮件 ID 数组。 参与方列表中添加的收件人方的电子邮件 ID。
签名成功 URL
 signSuccessUrl string

输入成功登录嵌入式签名视图后将重定向到的签名者的绝对 URL。
签名拒绝 URL
 signDeclineUrl string

输入要重定向到的签名者的绝对 URL（如果拒绝登录嵌入式签名视图）。
稍后签署 URL
 signLaterUrl string

输入将重定向到的签名者的绝对 URL（如果以后选择在嵌入式签名视图中登录）。
签名错误 URL
 signErrorUrl string

在嵌入式签名视图中为文档签名期间出现错误时，输入将重定向到的签名者的绝对 URL。
允许立即发送和嵌入式签名会话
 allowSendNowAndEmbeddedSigningSession boolean

如果设置为 true，Foxit eSign 将向每个收件人发送唯一的签名链接。 仅当参数 sendNow 和 createEmbeddedSigningSession 为 true 时才适用。
高级电子邮件验证
 allowAdvancedEmailValidation boolean

将参与方的电子邮件地址设置为 true 时进行验证。
签署成功 URL 各方
 signSuccessUrlAllParties boolean

如果设置为 true，则成功签名后，签名者将重定向到 signSuccessUrl 中提供的 URL。 仅当 sendNow 为 true 时才适用。
电子邮件模板 ID
 emailTemplateId integer

传递电子邮件模板 ID 以发送默认电子邮件模板以外的电子邮件模板。
签名者指令 ID
 signerInstructionId integer

传递指令 ID 以发送默认签名者指令以外的签名者指令。
确认指令 ID
 confirmationInstructionId string

传递确认指令 ID 以发送默认确认说明以外的确认指令。
主题颜色
 themeColor string

输入 CSS 值以设置主题颜色。
会话过期
 sessionExpire boolean

设置为 true 以启动嵌入签名会话的过期时间。
到期
 expiry integer

如果 sessionExpire 为 true，则为必需。 输入嵌入签名会话到期的持续时间（以毫秒为单位）。
从属字段名称
 dependentFieldName True string

其可见性由父字段控制的字段的名称。
父字段名称
 parentFieldName True string

其值控制依赖字段可见性的父字段的名称。 支持的父字段类型：textfield、textbox、checkbox、radiobutton、下拉列表。
父字段值
 parentFieldValue True string

触发依赖字段变为可见的父字段的值。 对于复选框和单选按钮字段，请使用选中或未选中。
选项
 options True string

基于文本的父字段的其他匹配选项。 接受的值：isblank、allowNull、contains。
Metadata
 metadata object

这应位于键值对中。 允许最多 1000 个键值对。
发件人电子邮件
 senderEmail string

在帐户中输入另一个用户的电子邮件，该电子邮件将用于向收件人方发送此文档文件夹。
隐藏“添加我”按钮
 hideAddMeButton boolean

如果为 true，它将在嵌入式发送会话中隐藏收件人群上的“添加我”按钮。
隐藏“添加新”按钮
 hideAddNewButton boolean

如果为 true，它将在嵌入式发送会话中隐藏收件人群上的“添加新”按钮。
隐藏“添加组”按钮
 hideAddGroupButton boolean

如果为 true，它将在嵌入式发送会话中隐藏收件人群上的“添加组”按钮。
隐藏收件人的字段名称
 hideFieldNameForRecipients boolean

隐藏“数据输入字段”和“高级字段”收件人的字段名称。 （单选按钮、复选框、图像和超链接除外）。
隐藏复选框边框
 hideCheckboxBorder boolean

复选框的边框将隐藏在执行的文档中。
隐藏签名者选择选项
 hideSignerSelectOption boolean

如果为 true，它将隐藏嵌入式发送会话中收件人群上的“现有签名者名称/电子邮件”输入框。
隐藏签名者操作
 hideSignerActions boolean

如果为 true，它将在嵌入式发送会话中隐藏对收件人参与方的“编辑”、“更改”和“删除”操作。
隐藏发件人名称
 hideSenderName boolean

如果为 true，它将在嵌入的发送会话中隐藏收件人群上的发件人名称。
隐藏文件夹名称
 hideFolderName boolean

如果为 true，它将在两个嵌入会话中的导航上隐藏文件夹名称。
隐藏文档名称
 hideDocumentsName boolean

如果为 true，它将在两个嵌入会话中隐藏文档名称。
隐藏拒绝签名
 hideDeclineToSign boolean

如果为 true，它将隐藏签名者的“拒绝签名”选项。
隐藏更多操作
 hideMoreAction boolean

如果为 true，它将隐藏发送/签名会话中的“更多操作”按钮。 对于“立即发送”：true，它不会隐藏任何内容。
隐藏发送按钮
 hideSendButton boolean

如果为 true，它将隐藏嵌入式发送会话中的“发送”按钮。
隐藏下一个必需 Fieldbtn
 hideNextRequiredFieldbtn boolean

如果设置为 true，则隐藏将签名者移动到下一个必需字段的导航按钮。
需要两个嵌入式会话
 requiredBothEmbeddedSession boolean

如果为 true，它将生成嵌入的发送和签名 URL。
信封密码
 folderPassword string

签名者/作者需要此密码才能打开数字签名的文档。 如果参数保持空白，则无需密码即可打开数字签名的文档。
启用分步
 enableStepByStep boolean

在嵌入式发送会话中启用分步操作。
隐藏“添加参与方”选项
 hideAddPartiesOption boolean

如果为 true，它将隐藏在草稿和模板创建模式下添加参与方选项的选项。
自签名
 selfSign boolean

它通过 API 启用嵌入式自签名。 此参数仅适用于 createEmbeddedSendingSession 参数为 true 时。
自签名者成功 URL
 selfSignerSuccessUrl string

输入网站/应用程序上登陆页面的绝对 URL，用户在嵌入式发送视图中成功发送文件夹后会重定向到该 URL。

返回

名称 路径 类型 说明
ID
 folder.folderId integer

新创建的信封的唯一 ID。 在后续操作中使用此包来引用此信封。
Name
 folder.folderName string

新创建的信封的名称。
自定义名称
 folder.folderCustomName string

信封的自定义名称。
密码
 folder.folderPassword string

信封的访问密码（如果已设置）。
创建者 ID
 folder.folderAuthorId integer

信封创建者的唯一标识符。
Creator 名字
 folder.folderAuthorFirstName string

信封创建者的名字。
Creator 姓氏
 folder.folderAuthorLastName string

信封创建者的姓氏。
创建者电子邮件
 folder.folderAuthorEmail string

信封创建者的电子邮件地址。
创建者角色
 folder.folderAuthorRole string

信封创建者的角色。
公司 ID
 folder.folderCompanyId integer

拥有信封的公司的唯一标识符。
创建日期
 folder.folderCreationDate integer

创建信封的日期（Unix 时间戳（以毫秒为单位）。
发送日期
 folder.folderSentDate integer

发送信封的日期（Unix 时间戳（以毫秒为单位）。
地位
 folder.folderStatus string

信封的当前状态。
自定义字段 1
 folder.custom_field1 string

信封的第一个自定义元数据字段。
自定义域 2
 folder.custom_field2 string

信封的第二个自定义元数据字段。
Metadata
 folder.metadata string

与信封关联的自定义元数据。
文档 ID
 folder.folderDocumentIds array of integer

信封中包含的文档 ID 列表。
文档
 folder.documentsList array of object

信封中的文档列表。
文档编号
 folder.documentsList.documentId integer

文档的唯一标识符。
合同 ID
 folder.documentsList.contractId integer

协定的唯一标识符。
公司 ID
 folder.documentsList.companyId integer

公司的唯一标识符。
创建者
 folder.documentsList.contractCreatedBy integer

创建合同的人员的用户 ID。
创建日期
 folder.documentsList.contractCreatedOn string

合同的创建日期和时间。
协定类型
 folder.documentsList.contractType string

协定的类型。
合同状态
 folder.documentsList.contractStatus string

合同的当前状态。
可编辑
 folder.documentsList.editable boolean

指示该项是否可编辑。
版本标识
 folder.documentsList.contractVersionId integer

协定版本的唯一标识符。
版本名称
 folder.documentsList.contractVersionName string

协定版本的名称。
版本说明
 folder.documentsList.contractVersionDesc string

协定版本的说明。
创建者版本
 folder.documentsList.versionCreatedby integer

创建此版本的人员的用户 ID。
创建的版本
 folder.documentsList.versionCreatedOn string

创建此版本的日期和时间。
版本号
 folder.documentsList.contractVersionNumber integer

协定的版本号。
事务源
 folder.documentsList.contractTransactionSource string

启动协定事务的源系统。
收件人
 folder.folderRecipientParties array of object

此信封的收件人方列表。
收件人 ID
 folder.folderRecipientParties.partyId integer

收件人的唯一标识符。
收件人 ID
 folder.folderRecipientParties.partyDetails.partyId integer

收件人的唯一标识符。
名字
 folder.folderRecipientParties.partyDetails.firstName string

收件人的名字。
姓氏
 folder.folderRecipientParties.partyDetails.lastName string

收件人的姓氏。
Email地址
 folder.folderRecipientParties.partyDetails.emailId string

收件人的电子邮件地址。
占位符
 folder.folderRecipientParties.partyDetails.placeholder boolean

指示此方是否为占位符收件人。
地址
 folder.folderRecipientParties.partyDetails.address string

收件人的物理地址。
创建日期
 folder.folderRecipientParties.partyDetails.dateCreated integer

记录的创建日期（Unix 时间戳（以毫秒为单位）。
选择退出电子邮件
 folder.folderRecipientParties.partyDetails.optOutEmails boolean

指示收件人是否已选择退出电子邮件通知。
唯一收件人 ID
 folder.folderRecipientParties.partyDetails.uniquePartyId string

此收件人的唯一系统标识符。
身份验证级别
 folder.folderRecipientParties.partyDetails.authenticationLevel string

此收件人所需的身份验证方法。
密码更新日期
 folder.folderRecipientParties.partyDetails.passwordUpdateDate string

上次更新密码的日期。
密码更新状态
 folder.folderRecipientParties.partyDetails.passwordUpdateStatus boolean

指示密码是否已更新。
公司 ID
 folder.folderRecipientParties.partyDetails.companyId integer

公司的唯一标识符。
用户角色
 folder.folderRecipientParties.partyDetails.userRole string

分配给用户的角色。
Department
 folder.folderRecipientParties.partyDetails.department string

用户所属的部门。
Title
 folder.folderRecipientParties.partyDetails.title string

用户的职务。
积极
 folder.folderRecipientParties.partyDetails.active boolean

指示用户或记录是否处于活动状态。
地区
 folder.folderRecipientParties.partyDetails.requestLocale string

用户的区域设置。
与部门共享
 folder.folderRecipientParties.partyDetails.share_among_department boolean

指示是否跨部门共享信封。
拨号代码
 folder.folderRecipientParties.partyDetails.dialingCode string

电话号码的国际拨号代码。
手机号
 folder.folderRecipientParties.partyDetails.mobileNumber string

移动电话号码。
状态筛选器
 folder.folderRecipientParties.partyDetails.docStatusFilter string

文档状态的筛选器。
日期筛选器
 folder.folderRecipientParties.partyDetails.docDateFilter string

文档日期的筛选器。
安全字段访问
 folder.folderRecipientParties.partyDetails.userSecureFieldAccess boolean

指示用户是否有权访问安全字段。
展开边栏
 folder.folderRecipientParties.partyDetails.expandSidebar boolean

指示是否默认展开边栏。
Adv. 电子邮件验证
 folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation boolean

指示是否启用高级电子邮件验证。
管理器 ID
 folder.folderRecipientParties.partyDetails.managerId string

用户经理的唯一标识符。
登录计数
 folder.folderRecipientParties.partyDetails.loginCount integer

用户登录的次数。
密码重置电子邮件
 folder.folderRecipientParties.partyDetails.sendMailForPasswordReset boolean

指示是否应发送密码重置电子邮件。
部门 ID
 folder.folderRecipientParties.partyDetails.departmentId string

部门的唯一标识符。
主要公司
 folder.folderRecipientParties.partyDetails.userPrimaryCompany integer

与用户关联的主要公司。
设备类型
 folder.folderRecipientParties.partyDetails.deviceType string

所使用的设备类型。
设备令牌
 folder.folderRecipientParties.partyDetails.deviceToken string

设备的推送通知令牌。
分包商说明
 folder.folderRecipientParties.partyDetails.subcontractorDescription string

分包商或外部签名者的说明。
分包商组织
 folder.folderRecipientParties.partyDetails.subcontractorOrganization string

分包商或外部签名者的组织名称。
分包商添加日期
 folder.folderRecipientParties.partyDetails.subcAddedDate integer

分包商添加的日期（Unix 时间戳（以毫秒为单位）。
来源
 folder.folderRecipientParties.partyDetails.source string

从中添加外部签名者的源系统。
拨号代码
 folder.folderRecipientParties.dialingCode string

电话号码的国际拨号代码。
手机号
 folder.folderRecipientParties.mobileNumber string

移动电话号码。
签名类型
 folder.folderRecipientParties.signerSignatureType string

签名者将使用的签名类型。
权限
 folder.folderRecipientParties.contractPermissions string

为合同授予此方的权限。
签名顺序
 folder.folderRecipientParties.partySequence integer

此收件人的签名顺序序列号。
工作流序列
 folder.folderRecipientParties.workflowSignSequence integer

工作流签名序列号。
信封 ID
 folder.folderRecipientParties.envelopeId integer

信封的唯一标识符。
收件人公司 ID
 folder.folderRecipientParties.partyCompanyId integer

与此收件人关联的公司的唯一标识符。
共享模式
 folder.folderRecipientParties.sharingMode string

此信封的共享模式。
收件人访问 URL
 folder.folderRecipientParties.folderAccessURL string

收件人可用于访问和签名信封的 URL。
安全模式
 folder.folderRecipientParties.securityMode string

应用于此信封的安全模式。
注释
 folder.folderRecipientParties.extraComments string

信封中包含的其他注释。
允许名称更改
 folder.folderRecipientParties.allowNameChange boolean

指示是否允许收件人更新其名称。
已更新的名称
 folder.folderRecipientParties.signerNameUpdated boolean

指示签名者是否已更新其名称。
签名者身份验证级别
 folder.folderRecipientParties.signerAuthenticationLevel string

签名者所需的身份验证级别。
访问代码
 folder.folderRecipientParties.userDefinedAccessCode string

为签名者定义的自定义访问代码。
签名 ID
 folder.folderRecipientParties.signatureId string

签名的唯一标识符。
收件人角色
 folder.folderRecipientParties.partyRole string

在签名工作流中分配给此收件人的角色。
公司字段
 folder.folderRecipientParties.companyFieldValue string

签名中公司名称字段的值。
标题字段
 folder.folderRecipientParties.titleFieldValue string

签名中标题字段的值。
签名的原因
 folder.folderRecipientParties.reasonSigning string

收件人签署文档的原因。
已添加付款字段
 folder.folderRecipientParties.payFieldAdded boolean

指示是否已添加付款字段。
收款人
 folder.folderRecipientParties.payee boolean

指示此收件人是否为付款人。
定期付款
 folder.folderRecipientParties.recurringFieldExist boolean

指示是否存在定期付款字段。
打印并签名完成
 folder.folderRecipientParties.printAndSignCompleted boolean

指示打印和签名过程是否已完成。
支付
 folder.folderRecipientParties.paid boolean

指示是否已完成付款。
允许的可选签名者
 folder.folderRecipientParties.allowOptionalSigner boolean

指示此收件人是否为可选签名者。
可选签名者
 folder.folderRecipientParties.optionalSigners array of integer

此信封的可选签名方 ID 列表。
作者签名 URL
 folder.folderAccessURLForAuthor string

发送方可用于访问信封的 URL。
草稿访问 URL
 folder.draftFolderAccessURL string

用于访问信封草稿版本的 URL。
董事会签名
 folder.boardRoomSign boolean

指示是否启用了板房签名模式。
包括徽标
 folder.includeLogo boolean

指示公司徽标是否包含在电子邮件中。
按钮背景色
 folder.email_btnBgColor string

电子邮件按钮的背景色。
按钮文本颜色
 folder.email_btnTxtColor string

电子邮件按钮的文本颜色。
电子邮件徽标
 folder.emailTemplateLogo string

电子邮件模板中使用的徽标 URL。
电子邮件模板 ID
 folder.emailTemplateId integer

电子邮件模板的唯一标识符。
电子邮件标头
 folder.emailHeader string

通知电子邮件中使用的标头文本。
电子邮件页脚
 folder.emailFooter string

通知电子邮件中使用的页脚文本。
清除计划
 folder.purgeFlag boolean

指示信封是否计划清除。
清除开始日期
 folder.purgeStartDate string

计划从中开始清除的日期。
清除结束日期
 folder.purgeEndDate string

清除计划完成的日期。
批量发送 ID
 folder.bulkId integer

批量发送操作的唯一标识符。
强制实施签名顺序
 folder.enforceSignWorkflow boolean

指示收件人是否必须登录定义的序列。
当前步骤
 folder.currentWorkflowStep integer

签名工作流中的当前步骤。
事务源
 folder.transactionSource string

启动此事务的源系统。
可编辑
 folder.editable boolean

指示该项是否可编辑。
In-Person 签名
 folder.inPersonSignable boolean

指示是否可以亲自登录信封。
替代提醒
 folder.overrideAccountReminders boolean

指示是否重写帐户级提醒设置。
替代委派
 folder.overrideAccountRecipientDelegation boolean

指示是否重写帐户级委派设置。
允许委派
 folder.allowRecipientsToDelegate boolean

指示是否允许收件人委托签名。
ID
 folder.envelopeId integer

信封的唯一标识符。
Name
 folder.envelopeName string

信封的名称。
发起方 ID
 folder.envelopeOriginatorId integer

创建信封的用户的唯一标识符。
公司 ID
 folder.envelopeCompanyId integer

拥有信封的公司的唯一标识符。
日期
 folder.envelopeDate integer

创建信封的日期（Unix 时间戳（以毫秒为单位）。
共享日期
 folder.envelopeSharedDate integer

信封共享的日期（Unix 时间戳（以毫秒为单位）。
地位
 folder.envelopeStatus string

信封的当前状态。
合同 ID
 folder.envelopeContractIds array of integer

与此信封关联的合同 ID 列表。
收件人权限
 folder.envelopePartyPermissions array of object

此信封的收件人权限列表。
收件人 ID
 folder.envelopePartyPermissions.partyId integer

收件人的唯一标识符。
收件人 ID
 folder.envelopePartyPermissions.partyDetails.partyId integer

收件人的唯一标识符。
名字
 folder.envelopePartyPermissions.partyDetails.firstName string

收件人的名字。
姓氏
 folder.envelopePartyPermissions.partyDetails.lastName string

收件人的姓氏。
Email地址
 folder.envelopePartyPermissions.partyDetails.emailId string

收件人的电子邮件地址。
占位符
 folder.envelopePartyPermissions.partyDetails.placeholder boolean

指示此方是否为占位符收件人。
地址
 folder.envelopePartyPermissions.partyDetails.address string

收件人的物理地址。
创建日期
 folder.envelopePartyPermissions.partyDetails.dateCreated integer

记录的创建日期（Unix 时间戳（以毫秒为单位）。
选择退出电子邮件
 folder.envelopePartyPermissions.partyDetails.optOutEmails boolean

指示收件人是否已选择退出电子邮件通知。
唯一收件人 ID
 folder.envelopePartyPermissions.partyDetails.uniquePartyId string

此收件人的唯一系统标识符。
身份验证级别
 folder.envelopePartyPermissions.partyDetails.authenticationLevel string

此收件人所需的身份验证方法。
密码更新日期
 folder.envelopePartyPermissions.partyDetails.passwordUpdateDate string

上次更新密码的日期。
密码更新状态
 folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus boolean

指示密码是否已更新。
公司 ID
 folder.envelopePartyPermissions.partyDetails.companyId integer

公司的唯一标识符。
用户角色
 folder.envelopePartyPermissions.partyDetails.userRole string

分配给用户的角色。
Department
 folder.envelopePartyPermissions.partyDetails.department string

用户所属的部门。
Title
 folder.envelopePartyPermissions.partyDetails.title string

用户的职务。
积极
 folder.envelopePartyPermissions.partyDetails.active boolean

指示用户或记录是否处于活动状态。
地区
 folder.envelopePartyPermissions.partyDetails.requestLocale string

用户的区域设置。
与部门共享
 folder.envelopePartyPermissions.partyDetails.share_among_department boolean

指示是否跨部门共享信封。
拨号代码
 folder.envelopePartyPermissions.partyDetails.dialingCode string

电话号码的国际拨号代码。
手机号
 folder.envelopePartyPermissions.partyDetails.mobileNumber string

移动电话号码。
状态筛选器
 folder.envelopePartyPermissions.partyDetails.docStatusFilter string

文档状态的筛选器。
日期筛选器
 folder.envelopePartyPermissions.partyDetails.docDateFilter string

文档日期的筛选器。
安全字段访问
 folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess boolean

指示用户是否有权访问安全字段。
展开边栏
 folder.envelopePartyPermissions.partyDetails.expandSidebar boolean

指示是否默认展开边栏。
Adv. 电子邮件验证
 folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation boolean

指示是否启用高级电子邮件验证。
管理器 ID
 folder.envelopePartyPermissions.partyDetails.managerId string

用户经理的唯一标识符。
登录计数
 folder.envelopePartyPermissions.partyDetails.loginCount integer

用户登录的次数。
密码重置电子邮件
 folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset boolean

指示是否应发送密码重置电子邮件。
部门 ID
 folder.envelopePartyPermissions.partyDetails.departmentId string

部门的唯一标识符。
主要公司
 folder.envelopePartyPermissions.partyDetails.userPrimaryCompany integer

与用户关联的主要公司。
设备类型
 folder.envelopePartyPermissions.partyDetails.deviceType string

所使用的设备类型。
设备令牌
 folder.envelopePartyPermissions.partyDetails.deviceToken string

设备的推送通知令牌。
分包商说明
 folder.envelopePartyPermissions.partyDetails.subcontractorDescription string

分包商或外部签名者的说明。
分包商组织
 folder.envelopePartyPermissions.partyDetails.subcontractorOrganization string

分包商或外部签名者的组织名称。
分包商添加日期
 folder.envelopePartyPermissions.partyDetails.subcAddedDate integer

分包商添加的日期（Unix 时间戳（以毫秒为单位）。
来源
 folder.envelopePartyPermissions.partyDetails.source string

从中添加外部签名者的源系统。
拨号代码
 folder.envelopePartyPermissions.dialingCode string

电话号码的国际拨号代码。
手机号
 folder.envelopePartyPermissions.mobileNumber string

移动电话号码。
签名类型
 folder.envelopePartyPermissions.signerSignatureType string

签名者将使用的签名类型。
权限
 folder.envelopePartyPermissions.contractPermissions string

为合同授予此方的权限。
签名顺序
 folder.envelopePartyPermissions.partySequence integer

此收件人的签名顺序序列号。
工作流序列
 folder.envelopePartyPermissions.workflowSignSequence integer

工作流签名序列号。
信封 ID
 folder.envelopePartyPermissions.envelopeId integer

信封的唯一标识符。
收件人公司 ID
 folder.envelopePartyPermissions.partyCompanyId integer

与此收件人关联的公司的唯一标识符。
共享模式
 folder.envelopePartyPermissions.sharingMode string

此信封的共享模式。
收件人访问 URL
 folder.envelopePartyPermissions.folderAccessURL string

收件人可用于访问和签名信封的 URL。
安全模式
 folder.envelopePartyPermissions.securityMode string

应用于此信封的安全模式。
注释
 folder.envelopePartyPermissions.extraComments string

信封中包含的其他注释。
允许名称更改
 folder.envelopePartyPermissions.allowNameChange boolean

指示是否允许收件人更新其名称。
已更新的名称
 folder.envelopePartyPermissions.signerNameUpdated boolean

指示签名者是否已更新其名称。
签名者身份验证级别
 folder.envelopePartyPermissions.signerAuthenticationLevel string

签名者所需的身份验证级别。
访问代码
 folder.envelopePartyPermissions.userDefinedAccessCode string

为签名者定义的自定义访问代码。
签名 ID
 folder.envelopePartyPermissions.signatureId string

签名的唯一标识符。
收件人角色
 folder.envelopePartyPermissions.partyRole string

在签名工作流中分配给此收件人的角色。
公司字段
 folder.envelopePartyPermissions.companyFieldValue string

签名中公司名称字段的值。
标题字段
 folder.envelopePartyPermissions.titleFieldValue string

签名中标题字段的值。
签名的原因
 folder.envelopePartyPermissions.reasonSigning string

收件人签署文档的原因。
已添加付款字段
 folder.envelopePartyPermissions.payFieldAdded boolean

指示是否已添加付款字段。
收款人
 folder.envelopePartyPermissions.payee boolean

指示此收件人是否为付款人。
定期付款
 folder.envelopePartyPermissions.recurringFieldExist boolean

指示是否存在定期付款字段。
打印并签名完成
 folder.envelopePartyPermissions.printAndSignCompleted boolean

指示打印和签名过程是否已完成。
支付
 folder.envelopePartyPermissions.paid boolean

指示是否已完成付款。
身份验证级别
 folder.envelopeAuthenticationLevel string

信封所需的身份验证级别。
单一签名者批量
 folder.allowSingleSignerInBulk boolean

指示是否允许在批量发送模式下使用单一签名者。
File-Based 命名
 folder.folderNameBasedOnFileNaming boolean

指示文件夹名称是否基于文件名。
文档 File-Based 名称
 folder.documentNameBasedOnFileNaming boolean

指示文档名称是否基于文件名。
证书 File-Based 名称
 folder.certificateNameBasedOnFileNaming boolean

指示证书名称是否基于文件名。
Pre-Exec 文件命名
 folder.enableFileNamingBeforeExecution boolean

指示是否在文档执行之前启用文件命名。
已添加付款人
 folder.payeeAddedd boolean

指示是否已添加付款人。
已启用 Self-Signing
 folder.selfSignerEnabled boolean

指示是否启用自签名模式。
Notary Enabled
 folder.notaryEnabled boolean

指示是否启用公证签名。
可见性有限
 folder.limitedVisibilityFlag boolean

指示是否为此信封启用了有限的可见性。
签名后可见性
 folder.postSigningVisibility boolean

指示是否启用签名后可见性。
湿签名
 folder.wetSignatureEnabled boolean

指示是否启用湿签名。
已启用合并
 folder.mergeEnabled boolean

指示是否启用文档合并。
嵌入式签名会话
 embeddedSigningSessions array of object

嵌入式签名会话列表，每个收件人一个。 仅当 createEmbeddedSigningSession 为 true 时才存在。
签名者电子邮件
 embeddedSigningSessions.emailIdOfSigner string

此嵌入式签名会话的收件人的电子邮件地址。
签名令牌
 embeddedSigningSessions.embeddedToken string

此收件人嵌入式签名会话的唯一令牌。
签名会话 URL
 embeddedSigningSessions.embeddedSessionURL string

要打开或嵌入此收件人以签署文档的 URL。
嵌入式发送令牌
 embeddedToken string

嵌入式发送会话的令牌。 仅当 createEmbeddedSendingSession 为 true 时才存在。
发送会话 URL
 embeddedSessionURL string

要打开或嵌入信封作者的 URL，以便准备并发送信封。 仅当 createEmbeddedSendingSession 为 true 时才存在。
Result
 result string

操作的结果。
Message
 message string

描述操作结果的消息。

从 Base64 创建模板

操作 ID:
CreateTemplatefromBase64

使用 Base64 编码的 PDF 字符串创建新模板。 当 PDF 文件已作为流中的 Base64 字符串提供（例如，从SharePoint文件或OneDrive文档）中可用时，请使用此功能。

参数

名称 密钥 必需 类型 说明
模板名称
 templateName True string

模板的名称。 必须以 .pdf 扩展名（例如，onboarding.pdf）结尾。
Base64 文件字符串
 base64FileString True string

用于创建模板的 PDF 的 BASE64 字符串。 创建模板时，应可公开访问该模板。
输入类型
 inputType True string

文档的输入方法。 对于此操作，始终设置为“base64”。
处理文本标记
 processTextTags True boolean

启用后，Foxit eSign 将扫描文档以获取文本标记，并自动将它们转换为签名字段。
处理 Acro 字段
 processAcroFields True boolean

启用后，Foxit eSign 将扫描文档以获取 AcroFields，并自动将它们转换为签名字段。
全部共享
 shareAll True boolean

将此模板与帐户中的所有用户共享。
参与方数
 numberOfParties True integer

此模板的收件人参与方数。 必须小于 20。
主题颜色
 themeColor string

用于自定义嵌入模板会话主题的 CSS 颜色值（例如 #42caf4）。
创作Email
 authorEmail string

帐户中要设置为此模板作者的其他用户的电子邮件地址。
创建嵌入式模板会话
 createEmbeddedTemplateSession boolean

如果设置为 true，则会创建嵌入模板会话，以便直接打开 Foxit eSign 模板编辑器，并将字段拖放到模板上。
重定向 URL
 redirectURL string

如果“创建嵌入模板会话”为 true，则单击嵌入模板编辑器中的“保存并关闭”后，将用户重定向到的 URL。
隐藏发送模板
 hideSendTemplate boolean

如果为 true，则嵌入模板编辑器中隐藏“发送”按钮。
修复收件人参与方
 fixRecipientParties boolean

如果为 true，则无法在嵌入式模板编辑器中更改已添加的收件人参与方。
Fields
 Fields object
权限
 permission True string
序列
 sequence True integer

此方的唯一序列号，从 1 开始。 定义启用登录序列时的签名顺序。
收件人角色
 partyRole True string

在模板中分配给此方的角色。
隐藏更多操作
 hideMoreAction boolean

如果为 true，则嵌入模板会话中隐藏“更多操作”按钮。
全部隐藏共享
 hideShareWithAll boolean

如果为 true，则嵌入模板会话中隐藏“与所有共享”选项。
隐藏添加群
 hideAddParty boolean

如果为 true，则所有添加方选项都隐藏在嵌入的模板会话中。
“隐藏我”按钮
 hideMeButton boolean

如果为 true，则收件人参与方的“我”按钮隐藏在嵌入的模板会话中。
隐藏其他按钮
 hideOthersButton boolean

如果为 true，则收件人群上的“其他”按钮隐藏在嵌入的模板会话中。
隐藏收件人的字段名称
 hideFieldNameForRecipients boolean

如果为 true，则数据输入和高级字段的收件人将隐藏字段名称。
隐藏复选框边框
 hideCheckboxBorder boolean

如果为 true，则复选框边框隐藏在执行的文档中。

返回

名称 路径 类型 说明
Result
 result string

指示操作是否成功（例如“success”）。
Message
 message string

操作结果的说明。
ID
 template.templateId integer

创建模板的唯一 ID。 使用此模板创建信封。
Name
 template.templateName string

模板的名称。
Description
 template.templateDesc string

模板的说明。
类型
 template.templateType string

模板的类型。
创建日期
 template.templateCreationDate string

模板的创建日期。
上次更新时间
 template.templateLastUpdateDate string

上次更新模板的日期。
可编辑
 template.editable boolean

指示是否可以编辑模板。
参与方数
 template.numberOfParties integer

模板中定义的收件人参与方数。
总页数
 template.totalPages integer

模板文档中的总页数。
公司 ID
 template.companyId integer

此模板所属的公司 ID。
与所有共享
 template.shareAll boolean

指示此模板是否与帐户中的所有用户共享。
参与方权限
 template.templatePartyPermissions array of object

此模板中定义的收件人角色及其权限的列表。
当事方 ID
 template.templatePartyPermissions.template_party_id integer

此模板参与方条目的唯一 ID。
ID
 template.templatePartyPermissions.templateId integer

此方所属的模板的 ID。
权限
 template.templatePartyPermissions.templatePermissions string

此方（例如FILL_FIELDS_AND_SIGN）的签名权限。
签名顺序
 template.templatePartyPermissions.partySequence integer

此方的签名顺序位置。
群角色
 template.templatePartyPermissions.templatePartyRole string

在模板中分配给此方的角色名称。 从模板创建信封时，请使用此功能。
用户 ID
 template.templateCreatedBy.partyId integer

用户的唯一 ID。
名字
 template.templateCreatedBy.firstName string

用户的名字。
姓氏
 template.templateCreatedBy.lastName string

用户的姓氏。
Email
 template.templateCreatedBy.emailId string

用户的电子邮件地址。
模板字段
 allfields array of object

模板中定义的所有签名和表单字段的列表。
字段 ID
 allfields.fieldTagId integer

字段的唯一标识符。
模板编号
 allfields.templateId integer

此字段所属的模板的 ID。
公司 ID
 allfields.companyId integer

此字段所属的公司帐户。
字段类型
 allfields.fieldType string

字段的类型（例如，signfield、initialfield、textfield、datefield、checkboxfield、securedfield、attachmentfield）。
页码
 allfields.documentPageNumber integer

放置此字段的文档的页码。
责任方
 allfields.partyResponsible integer

负责填充此字段的群序列号。
Party 序列
 allfields.partyResponsibleSequence integer

责任方的序列位置。
字段文档 ID
 allfields.docFieldId string

此字段的文档级标识符。
依赖
 allfields.dependent boolean

指示此字段的可见性是否取决于另一个字段的值。
Tab 键顺序
 allfields.tabOrder integer

用于在字段之间导航的 Tab 键顺序。
必需
 allfields.required boolean

指示是否必须填写此字段，然后才能对文档进行签名。
自定义字段名称
 allfields.customFieldName string

分配给此字段的自定义名称。
全部共享
 allfields.shareAll boolean

指示此字段是否与所有用户共享。
允许编辑
 allfields.allowEdit boolean

指示收件人是否可以编辑此字段。
文本字段名称
 allfields.textfieldName string

文本字段的标签（在 fieldType 为“textfield”时适用）。
Value
 allfields.value string

字段的预填充或输入值。
字体大小
 allfields.fontSize integer

用于此字段中文本的字号。
字体颜色
 allfields.fontColor string

此字段中用于文本的字体颜色（例如 #0000000）。
只读
 allfields.readOnly boolean

指示该字段是否为只读字段，并且不能由收件人编辑。
多行
 allfields.multiLine boolean

指示文本字段是否接受多行输入（在 fieldType 为“textfield”时适用）。
字符限制
 allfields.characterLimit integer

字段中允许的最大字符数（在 fieldType 为“textfield”时适用）。
日期字段名称
 allfields.datefieldName string

日期字段的标签（在 fieldType 为“datefield”时适用）。
日期格式
 allfields.dateFormat string

此字段使用的日期格式（例如 MM/DD/YYYY）（适用于 fieldType 为“datefield”时）。
复选框名称
 allfields.cbname string

复选框字段的标签（在 fieldType 为“checkboxfield”时适用）。
复选框组
 allfields.cbgroup string

此复选框的组名称（适用于 fieldType 为“checkboxfield”时）。
已选中
 allfields.checked boolean

指示复选框是否默认选中（适用于 fieldType 为“checkboxfield”时）。
受保护的字段名称
 allfields.securedfieldName string

受保护字段的标签（在 fieldType 为“securedfield”时适用）。
要显示的字符
 allfields.charToDisplay integer

要在安全字段值末尾显示的未屏蔽字符数（适用于 fieldType 为“securedfield”时）。
签名 ID
 allfields.signatureId string

应用于此签名字段的签名的 ID（适用于 fieldType 为“signfield”时）。
初始图像
 allfields.initialImage string

应用于此字段的首字母缩写的图像数据（适用于 fieldType 为“initialfield”时）。
附件字段名称
 allfields.attachmentfieldName string

附件字段的名称（在 fieldType 为“attachmentfield”时适用）。
附件说明
 allfields.attachmentfieldDescription string

说明要附加的内容（在 fieldType 为“attachmentfield”时适用）。

从 URL 创建信封

操作 ID:
CreateEnvelopefromURL

使用可公开访问的 PDF URL 创建和发送信封。 提供文档 URL 和收件人详细信息以启动签名过程。

参数

名称 密钥 必需 类型 说明
信封名称
 folderName True string

此信封的名称。
输入类型
 inputType string

指定文档源格式。 设置为 URL 以提供文件 URL，或 base64 提供 Base64 编码的文件内容。
文件 URL
 fileUrls True array of string

指向要添加到此信封的文档的可公开访问 URL 数组。
文件名
 fileNames True array of string

每个文档的显示名称数组，顺序与文件 URL 相同。
名字
 firstName True string

收件人的名字。
姓氏
 lastName True string

收件人的姓氏。
Email地址
 emailId True string

收件人的电子邮件地址。
权限
 permission True string
序列
 sequence True integer

使用此字段可向收件人列表中的收件人分配序列号。 对从 1 开始的每个方使用唯一序列号，例如 1,2,3,4....如果在签名工作流中多次出现单个人员，请在每次重复收件人时分配不同的序列。
signerAuthLevels
 signerAuthLevel string

签名者用于验证的身份验证级别
占位符
 isPlaceholder boolean

使用此字段启动参与方是占位符。 注意：1. firstName、lastName、emailId 参数的值必须为此方空白。 2. 若要添加占位符，必须使用“PARTY_ASSIGNER”权限重新引用一个收件人。
收件人角色
 partyRole string

使用此字段分配占位符的角色。
允许名称更改
 allowNameChange string

值可以是 true 或 false，使用此参数允许签名者在完成签名过程之前更新名字和姓氏。
工作流序列
 workflowSequence integer

向此收件人分配工作流序列号。 启用登录序列后，收件人会按升序顺序接收其签名邀请。
主机电子邮件 ID
 hostEmailId string

In-Person 管理员的电子邮件地址。
访问代码
 userDefinedAccessCode string

当“signerAuthLevel”值设置为“用户定义的访问代码”进行身份验证时，该参数将包含 Access Code。 注意：1. 代码不区分大小写。 2. 系统不发送此代码，因此必须直接与签名者共享此代码。 3. 访问代码可以包含字母、数字和以下特殊字符：@、&、{,}%、（、）、~、|,!,+、^。
群是电子邮件组
 partyIsEmailGroup boolean

批量创建群时使用此参数。 注意： 如果此参数为 true，将忽略此参与方的 firstName、lastName 和 emailId。
电子邮件组 ID
 emailGroupId integer

传递要用于批量创建组 ID 的电子邮件。
单一签名者批量
 allowSingleSignerInBulk boolean

使用此参数仅允许一个人登录电子邮件组。
拨号代码
 dialingCode string

使用此字段可分配国家/地区拨入代码是收件人列表中的收件人的手机号码前缀。
手机号
 mobileNumber string

使用此字段可向收件人列表中的收件人分配一个手机号码。
Fields
 Fields object
立即发送
 sendNow boolean

启用后，Foxit eSign 会立即向每个收件人的电子邮件地址发送唯一的签名链接。 请禁用此选项以将信封保存为草稿。
创建嵌入式签名会话
 createEmbeddedSigningSession True boolean

签名会话令牌将生成，而不会向收件人发送电子邮件。
为各方创建嵌入式签名会话
 createEmbeddedSigningSessionForAllParties boolean

如果设置为 true，则会为信封中的每个收件人生成嵌入签名 URL。
处理文本标记
 processTextTags True boolean

值可以是 true 或 false。 此字段用于确定 Foxit eSign 是否应分析文本标记的文档，以将它们转换为 Foxit eSign 字段。
处理 Acro 字段
 processAcroFields True boolean

此字段用于确定 Foxit eSign 是否应分析 AcroFields 的文档，以将其转换为 Foxit eSign 字段。
登录顺序
 signInSequence boolean

此字段用于确定收件人是否按顺序对信封文档进行签名。 如果为 false，则所有收件人同时接收邀请电子邮件。 如果为 true，则每个收件人在上一个收件人完成所需任务后连续接收邀请电子邮件，例如对文档进行签名或填写字段等。
“亲自启用”
 inPersonEnable boolean

此字段用于启动可在几分钟内在任何设备上轻松完成的人员签名过程，并在需要时避免基于电子邮件的签名。 如果为 false，则所有收件人同时收到邀请电子邮件。 如果为 true，则内部管理员会收到邀请电子邮件，以启动签名者的签名过程。
修复收件人参与方
 fixRecipientParties boolean

如果为 true，则嵌入发送视图中无法更改已作为此请求的一部分添加的信封的参与方。
修复文档
 fixDocuments boolean

如果为 true，则嵌入发送中无法更改已作为此请求的一部分添加的信封的文档。
发送成功 URL
 sendSuccessUrl string

输入登录页的绝对 URL，登录者将在嵌入的发送视图中成功发送文件夹后重定向到该 URL。
发送错误 URL
 sendErrorUrl string

输入登陆页面的绝对 URL，如果发送嵌入的发送视图中的文件夹出现错误，签名者将重定向到该 URL。
创建嵌入式发送会话
 createEmbeddedSendingSession boolean

如果设置为 true，它将生成嵌入令牌以打开 Foxit eSign 的文档准备视图。
嵌入式签名者电子邮件 ID
 embeddedSignersEmailIds array of string

需要为其创建嵌入式签名会话的收件人的电子邮件 ID 数组。 参与方列表中添加的收件人方的电子邮件 ID。
签名成功 URL
 signSuccessUrl string

输入成功登录嵌入式签名视图后将重定向到的签名者的绝对 URL。
签名拒绝 URL
 signDeclineUrl string

输入要重定向到的签名者的绝对 URL（如果拒绝登录嵌入式签名视图）。
稍后签署 URL
 signLaterUrl string

输入将重定向到的签名者的绝对 URL（如果以后选择在嵌入式签名视图中登录）。
签名错误 URL
 signErrorUrl string

在嵌入式签名视图中为文档签名期间出现错误时，输入将重定向到的签名者的绝对 URL。
允许立即发送和嵌入式签名会话
 allowSendNowAndEmbeddedSigningSession boolean

如果设置为 true，Foxit eSign 将向每个收件人发送唯一的签名链接。 仅当参数 sendNow 和 createEmbeddedSigningSession 为 true 时才适用。
高级电子邮件验证
 allowAdvancedEmailValidation boolean

将参与方的电子邮件地址设置为 true 时进行验证。
签署成功 URL 各方
 signSuccessUrlAllParties boolean

如果设置为 true，则成功签名后，签名者将重定向到 signSuccessUrl 中提供的 URL。 仅当 sendNow 为 true 时才适用。
电子邮件模板 ID
 emailTemplateId integer

传递电子邮件模板 ID 以发送默认电子邮件模板以外的电子邮件模板。
签名者指令 ID
 signerInstructionId integer

传递指令 ID 以发送默认签名者指令以外的签名者指令。
确认指令 ID
 confirmationInstructionId string

传递确认指令 ID 以发送默认确认说明以外的确认指令。
主题颜色
 themeColor string

输入 CSS 值以设置主题颜色。
会话过期
 sessionExpire boolean

设置为 true 以启动嵌入签名会话的过期时间。
到期
 expiry integer

如果 sessionExpire 为 true，则为必需。 输入嵌入签名会话到期的持续时间（以毫秒为单位）。
从属字段名称
 dependentFieldName True string

其可见性由父字段控制的字段的名称。
父字段名称
 parentFieldName True string

其值控制依赖字段可见性的父字段的名称。 支持的父字段类型：textfield、textbox、checkbox、radiobutton、下拉列表。
父字段值
 parentFieldValue True string

触发依赖字段变为可见的父字段的值。 对于复选框和单选按钮字段，请使用选中或未选中。
选项
 options True string

基于文本的父字段的其他匹配选项。 接受的值：isblank、allowNull、contains。
Metadata
 metadata object

这应位于键值对中。 允许最多 1000 个键值对。
发件人电子邮件
 senderEmail string

在帐户中输入另一个用户的电子邮件，该电子邮件将用于向收件人方发送此文档文件夹。
隐藏“添加我”按钮
 hideAddMeButton boolean

如果为 true，它将在嵌入式发送会话中隐藏收件人群上的“添加我”按钮。
隐藏“添加新”按钮
 hideAddNewButton boolean

如果为 true，它将在嵌入式发送会话中隐藏收件人群上的“添加新”按钮。
隐藏“添加组”按钮
 hideAddGroupButton boolean

如果为 true，它将在嵌入式发送会话中隐藏收件人群上的“添加组”按钮。
隐藏收件人的字段名称
 hideFieldNameForRecipients boolean

隐藏“数据输入字段”和“高级字段”收件人的字段名称。 （单选按钮、复选框、图像和超链接除外）。
隐藏复选框边框
 hideCheckboxBorder boolean

复选框的边框将隐藏在执行的文档中。
隐藏签名者选择选项
 hideSignerSelectOption boolean

如果为 true，它将隐藏嵌入式发送会话中收件人群上的“现有签名者名称/电子邮件”输入框。
隐藏签名者操作
 hideSignerActions boolean

如果为 true，它将在嵌入式发送会话中隐藏对收件人参与方的“编辑”、“更改”和“删除”操作。
隐藏发件人名称
 hideSenderName boolean

如果为 true，它将在嵌入的发送会话中隐藏收件人群上的发件人名称。
隐藏文件夹名称
 hideFolderName boolean

如果为 true，它将在两个嵌入会话中的导航上隐藏文件夹名称。
隐藏文档名称
 hideDocumentsName boolean

如果为 true，它将在两个嵌入会话中隐藏文档名称。
隐藏拒绝签名
 hideDeclineToSign boolean

如果为 true，它将隐藏签名者的“拒绝签名”选项。
隐藏更多操作
 hideMoreAction boolean

如果为 true，它将隐藏发送/签名会话中的“更多操作”按钮。 对于“立即发送”：true，它不会隐藏任何内容。
隐藏发送按钮
 hideSendButton boolean

如果为 true，它将隐藏嵌入式发送会话中的“发送”按钮。
隐藏下一个必需 Fieldbtn
 hideNextRequiredFieldbtn boolean

如果设置为 true，则隐藏将签名者移动到下一个必需字段的导航按钮。
需要两个嵌入式会话
 requiredBothEmbeddedSession boolean

如果为 true，它将生成嵌入的发送和签名 URL。
信封密码
 folderPassword string

签名者/作者需要此密码才能打开数字签名的文档。 如果参数保持空白，则无需密码即可打开数字签名的文档。
启用分步
 enableStepByStep boolean

在嵌入式发送会话中启用分步操作。
隐藏“添加参与方”选项
 hideAddPartiesOption boolean

如果为 true，它将隐藏在草稿和模板创建模式下添加参与方选项的选项。
自签名
 selfSign boolean

它通过 API 启用嵌入式自签名。 此参数仅适用于 createEmbeddedSendingSession 参数为 true 时。
自签名者成功 URL
 selfSignerSuccessUrl string

输入网站/应用程序上登陆页面的绝对 URL，用户在嵌入式发送视图中成功发送文件夹后会重定向到该 URL。

返回

名称 路径 类型 说明
ID
 folder.folderId integer

新创建的信封的唯一 ID。 在后续操作中使用此包来引用此信封。
Name
 folder.folderName string

新创建的信封的名称。
自定义名称
 folder.folderCustomName string

信封的自定义名称。
密码
 folder.folderPassword string

信封的访问密码（如果已设置）。
创建者 ID
 folder.folderAuthorId integer

信封创建者的唯一标识符。
Creator 名字
 folder.folderAuthorFirstName string

信封创建者的名字。
Creator 姓氏
 folder.folderAuthorLastName string

信封创建者的姓氏。
创建者电子邮件
 folder.folderAuthorEmail string

信封创建者的电子邮件地址。
创建者角色
 folder.folderAuthorRole string

信封创建者的角色。
公司 ID
 folder.folderCompanyId integer

拥有信封的公司的唯一标识符。
创建日期
 folder.folderCreationDate integer

创建信封的日期（Unix 时间戳（以毫秒为单位）。
发送日期
 folder.folderSentDate integer

发送信封的日期（Unix 时间戳（以毫秒为单位）。
地位
 folder.folderStatus string

信封的当前状态。
自定义字段 1
 folder.custom_field1 string

信封的第一个自定义元数据字段。
自定义域 2
 folder.custom_field2 string

信封的第二个自定义元数据字段。
Metadata
 folder.metadata string

与信封关联的自定义元数据。
文档 ID
 folder.folderDocumentIds array of integer

信封中包含的文档 ID 列表。
文档
 folder.documentsList array of object

信封中的文档列表。
文档编号
 folder.documentsList.documentId integer

文档的唯一标识符。
合同 ID
 folder.documentsList.contractId integer

协定的唯一标识符。
公司 ID
 folder.documentsList.companyId integer

公司的唯一标识符。
创建者
 folder.documentsList.contractCreatedBy integer

创建合同的人员的用户 ID。
创建日期
 folder.documentsList.contractCreatedOn string

合同的创建日期和时间。
协定类型
 folder.documentsList.contractType string

协定的类型。
合同状态
 folder.documentsList.contractStatus string

合同的当前状态。
可编辑
 folder.documentsList.editable boolean

指示该项是否可编辑。
版本标识
 folder.documentsList.contractVersionId integer

协定版本的唯一标识符。
版本名称
 folder.documentsList.contractVersionName string

协定版本的名称。
版本说明
 folder.documentsList.contractVersionDesc string

协定版本的说明。
创建者版本
 folder.documentsList.versionCreatedby integer

创建此版本的人员的用户 ID。
创建的版本
 folder.documentsList.versionCreatedOn string

创建此版本的日期和时间。
版本号
 folder.documentsList.contractVersionNumber integer

协定的版本号。
事务源
 folder.documentsList.contractTransactionSource string

启动协定事务的源系统。
收件人
 folder.folderRecipientParties array of object

此信封的收件人方列表。
收件人 ID
 folder.folderRecipientParties.partyId integer

收件人的唯一标识符。
收件人 ID
 folder.folderRecipientParties.partyDetails.partyId integer

收件人的唯一标识符。
名字
 folder.folderRecipientParties.partyDetails.firstName string

收件人的名字。
姓氏
 folder.folderRecipientParties.partyDetails.lastName string

收件人的姓氏。
Email地址
 folder.folderRecipientParties.partyDetails.emailId string

收件人的电子邮件地址。
占位符
 folder.folderRecipientParties.partyDetails.placeholder boolean

指示此方是否为占位符收件人。
地址
 folder.folderRecipientParties.partyDetails.address string

收件人的物理地址。
创建日期
 folder.folderRecipientParties.partyDetails.dateCreated integer

记录的创建日期（Unix 时间戳（以毫秒为单位）。
选择退出电子邮件
 folder.folderRecipientParties.partyDetails.optOutEmails boolean

指示收件人是否已选择退出电子邮件通知。
唯一收件人 ID
 folder.folderRecipientParties.partyDetails.uniquePartyId string

此收件人的唯一系统标识符。
身份验证级别
 folder.folderRecipientParties.partyDetails.authenticationLevel string

此收件人所需的身份验证方法。
密码更新日期
 folder.folderRecipientParties.partyDetails.passwordUpdateDate string

上次更新密码的日期。
密码更新状态
 folder.folderRecipientParties.partyDetails.passwordUpdateStatus boolean

指示密码是否已更新。
公司 ID
 folder.folderRecipientParties.partyDetails.companyId integer

公司的唯一标识符。
用户角色
 folder.folderRecipientParties.partyDetails.userRole string

分配给用户的角色。
Department
 folder.folderRecipientParties.partyDetails.department string

用户所属的部门。
Title
 folder.folderRecipientParties.partyDetails.title string

用户的职务。
积极
 folder.folderRecipientParties.partyDetails.active boolean

指示用户或记录是否处于活动状态。
地区
 folder.folderRecipientParties.partyDetails.requestLocale string

用户的区域设置。
与部门共享
 folder.folderRecipientParties.partyDetails.share_among_department boolean

指示是否跨部门共享信封。
拨号代码
 folder.folderRecipientParties.partyDetails.dialingCode string

电话号码的国际拨号代码。
手机号
 folder.folderRecipientParties.partyDetails.mobileNumber string

移动电话号码。
状态筛选器
 folder.folderRecipientParties.partyDetails.docStatusFilter string

文档状态的筛选器。
日期筛选器
 folder.folderRecipientParties.partyDetails.docDateFilter string

文档日期的筛选器。
安全字段访问
 folder.folderRecipientParties.partyDetails.userSecureFieldAccess boolean

指示用户是否有权访问安全字段。
展开边栏
 folder.folderRecipientParties.partyDetails.expandSidebar boolean

指示是否默认展开边栏。
Adv. 电子邮件验证
 folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation boolean

指示是否启用高级电子邮件验证。
管理器 ID
 folder.folderRecipientParties.partyDetails.managerId string

用户经理的唯一标识符。
登录计数
 folder.folderRecipientParties.partyDetails.loginCount integer

用户登录的次数。
密码重置电子邮件
 folder.folderRecipientParties.partyDetails.sendMailForPasswordReset boolean

指示是否应发送密码重置电子邮件。
部门 ID
 folder.folderRecipientParties.partyDetails.departmentId string

部门的唯一标识符。
主要公司
 folder.folderRecipientParties.partyDetails.userPrimaryCompany integer

与用户关联的主要公司。
设备类型
 folder.folderRecipientParties.partyDetails.deviceType string

所使用的设备类型。
设备令牌
 folder.folderRecipientParties.partyDetails.deviceToken string

设备的推送通知令牌。
分包商说明
 folder.folderRecipientParties.partyDetails.subcontractorDescription string

分包商或外部签名者的说明。
分包商组织
 folder.folderRecipientParties.partyDetails.subcontractorOrganization string

分包商或外部签名者的组织名称。
分包商添加日期
 folder.folderRecipientParties.partyDetails.subcAddedDate integer

分包商添加的日期（Unix 时间戳（以毫秒为单位）。
来源
 folder.folderRecipientParties.partyDetails.source string

从中添加外部签名者的源系统。
拨号代码
 folder.folderRecipientParties.dialingCode string

电话号码的国际拨号代码。
手机号
 folder.folderRecipientParties.mobileNumber string

移动电话号码。
签名类型
 folder.folderRecipientParties.signerSignatureType string

签名者将使用的签名类型。
权限
 folder.folderRecipientParties.contractPermissions string

为合同授予此方的权限。
签名顺序
 folder.folderRecipientParties.partySequence integer

此收件人的签名顺序序列号。
工作流序列
 folder.folderRecipientParties.workflowSignSequence integer

工作流签名序列号。
信封 ID
 folder.folderRecipientParties.envelopeId integer

信封的唯一标识符。
收件人公司 ID
 folder.folderRecipientParties.partyCompanyId integer

与此收件人关联的公司的唯一标识符。
共享模式
 folder.folderRecipientParties.sharingMode string

此信封的共享模式。
收件人访问 URL
 folder.folderRecipientParties.folderAccessURL string

收件人可用于访问和签名信封的 URL。
安全模式
 folder.folderRecipientParties.securityMode string

应用于此信封的安全模式。
注释
 folder.folderRecipientParties.extraComments string

信封中包含的其他注释。
允许名称更改
 folder.folderRecipientParties.allowNameChange boolean

指示是否允许收件人更新其名称。
已更新的名称
 folder.folderRecipientParties.signerNameUpdated boolean

指示签名者是否已更新其名称。
签名者身份验证级别
 folder.folderRecipientParties.signerAuthenticationLevel string

签名者所需的身份验证级别。
访问代码
 folder.folderRecipientParties.userDefinedAccessCode string

为签名者定义的自定义访问代码。
签名 ID
 folder.folderRecipientParties.signatureId string

签名的唯一标识符。
收件人角色
 folder.folderRecipientParties.partyRole string

在签名工作流中分配给此收件人的角色。
公司字段
 folder.folderRecipientParties.companyFieldValue string

签名中公司名称字段的值。
标题字段
 folder.folderRecipientParties.titleFieldValue string

签名中标题字段的值。
签名的原因
 folder.folderRecipientParties.reasonSigning string

收件人签署文档的原因。
已添加付款字段
 folder.folderRecipientParties.payFieldAdded boolean

指示是否已添加付款字段。
收款人
 folder.folderRecipientParties.payee boolean

指示此收件人是否为付款人。
定期付款
 folder.folderRecipientParties.recurringFieldExist boolean

指示是否存在定期付款字段。
打印并签名完成
 folder.folderRecipientParties.printAndSignCompleted boolean

指示打印和签名过程是否已完成。
支付
 folder.folderRecipientParties.paid boolean

指示是否已完成付款。
允许的可选签名者
 folder.folderRecipientParties.allowOptionalSigner boolean

指示此收件人是否为可选签名者。
可选签名者
 folder.folderRecipientParties.optionalSigners array of integer

此信封的可选签名方 ID 列表。
作者签名 URL
 folder.folderAccessURLForAuthor string

发送方可用于访问信封的 URL。
草稿访问 URL
 folder.draftFolderAccessURL string

用于访问信封草稿版本的 URL。
董事会签名
 folder.boardRoomSign boolean

指示是否启用了板房签名模式。
包括徽标
 folder.includeLogo boolean

指示公司徽标是否包含在电子邮件中。
按钮背景色
 folder.email_btnBgColor string

电子邮件按钮的背景色。
按钮文本颜色
 folder.email_btnTxtColor string

电子邮件按钮的文本颜色。
电子邮件徽标
 folder.emailTemplateLogo string

电子邮件模板中使用的徽标 URL。
电子邮件模板 ID
 folder.emailTemplateId integer

电子邮件模板的唯一标识符。
电子邮件标头
 folder.emailHeader string

通知电子邮件中使用的标头文本。
电子邮件页脚
 folder.emailFooter string

通知电子邮件中使用的页脚文本。
清除计划
 folder.purgeFlag boolean

指示信封是否计划清除。
清除开始日期
 folder.purgeStartDate string

计划从中开始清除的日期。
清除结束日期
 folder.purgeEndDate string

清除计划完成的日期。
批量发送 ID
 folder.bulkId integer

批量发送操作的唯一标识符。
强制实施签名顺序
 folder.enforceSignWorkflow boolean

指示收件人是否必须登录定义的序列。
当前步骤
 folder.currentWorkflowStep integer

签名工作流中的当前步骤。
事务源
 folder.transactionSource string

启动此事务的源系统。
可编辑
 folder.editable boolean

指示该项是否可编辑。
In-Person 签名
 folder.inPersonSignable boolean

指示是否可以亲自登录信封。
替代提醒
 folder.overrideAccountReminders boolean

指示是否重写帐户级提醒设置。
替代委派
 folder.overrideAccountRecipientDelegation boolean

指示是否重写帐户级委派设置。
允许委派
 folder.allowRecipientsToDelegate boolean

指示是否允许收件人委托签名。
ID
 folder.envelopeId integer

信封的唯一标识符。
Name
 folder.envelopeName string

信封的名称。
发起方 ID
 folder.envelopeOriginatorId integer

创建信封的用户的唯一标识符。
公司 ID
 folder.envelopeCompanyId integer

拥有信封的公司的唯一标识符。
日期
 folder.envelopeDate integer

创建信封的日期（Unix 时间戳（以毫秒为单位）。
共享日期
 folder.envelopeSharedDate integer

信封共享的日期（Unix 时间戳（以毫秒为单位）。
地位
 folder.envelopeStatus string

信封的当前状态。
合同 ID
 folder.envelopeContractIds array of integer

与此信封关联的合同 ID 列表。
收件人权限
 folder.envelopePartyPermissions array of object

此信封的收件人权限列表。
收件人 ID
 folder.envelopePartyPermissions.partyId integer

收件人的唯一标识符。
收件人 ID
 folder.envelopePartyPermissions.partyDetails.partyId integer

收件人的唯一标识符。
名字
 folder.envelopePartyPermissions.partyDetails.firstName string

收件人的名字。
姓氏
 folder.envelopePartyPermissions.partyDetails.lastName string

收件人的姓氏。
Email地址
 folder.envelopePartyPermissions.partyDetails.emailId string

收件人的电子邮件地址。
占位符
 folder.envelopePartyPermissions.partyDetails.placeholder boolean

指示此方是否为占位符收件人。
地址
 folder.envelopePartyPermissions.partyDetails.address string

收件人的物理地址。
创建日期
 folder.envelopePartyPermissions.partyDetails.dateCreated integer

记录的创建日期（Unix 时间戳（以毫秒为单位）。
选择退出电子邮件
 folder.envelopePartyPermissions.partyDetails.optOutEmails boolean

指示收件人是否已选择退出电子邮件通知。
唯一收件人 ID
 folder.envelopePartyPermissions.partyDetails.uniquePartyId string

此收件人的唯一系统标识符。
身份验证级别
 folder.envelopePartyPermissions.partyDetails.authenticationLevel string

此收件人所需的身份验证方法。
密码更新日期
 folder.envelopePartyPermissions.partyDetails.passwordUpdateDate string

上次更新密码的日期。
密码更新状态
 folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus boolean

指示密码是否已更新。
公司 ID
 folder.envelopePartyPermissions.partyDetails.companyId integer

公司的唯一标识符。
用户角色
 folder.envelopePartyPermissions.partyDetails.userRole string

分配给用户的角色。
Department
 folder.envelopePartyPermissions.partyDetails.department string

用户所属的部门。
Title
 folder.envelopePartyPermissions.partyDetails.title string

用户的职务。
积极
 folder.envelopePartyPermissions.partyDetails.active boolean

指示用户或记录是否处于活动状态。
地区
 folder.envelopePartyPermissions.partyDetails.requestLocale string

用户的区域设置。
与部门共享
 folder.envelopePartyPermissions.partyDetails.share_among_department boolean

指示是否跨部门共享信封。
拨号代码
 folder.envelopePartyPermissions.partyDetails.dialingCode string

电话号码的国际拨号代码。
手机号
 folder.envelopePartyPermissions.partyDetails.mobileNumber string

移动电话号码。
状态筛选器
 folder.envelopePartyPermissions.partyDetails.docStatusFilter string

文档状态的筛选器。
日期筛选器
 folder.envelopePartyPermissions.partyDetails.docDateFilter string

文档日期的筛选器。
安全字段访问
 folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess boolean

指示用户是否有权访问安全字段。
展开边栏
 folder.envelopePartyPermissions.partyDetails.expandSidebar boolean

指示是否默认展开边栏。
Adv. 电子邮件验证
 folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation boolean

指示是否启用高级电子邮件验证。
管理器 ID
 folder.envelopePartyPermissions.partyDetails.managerId string

用户经理的唯一标识符。
登录计数
 folder.envelopePartyPermissions.partyDetails.loginCount integer

用户登录的次数。
密码重置电子邮件
 folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset boolean

指示是否应发送密码重置电子邮件。
部门 ID
 folder.envelopePartyPermissions.partyDetails.departmentId string

部门的唯一标识符。
主要公司
 folder.envelopePartyPermissions.partyDetails.userPrimaryCompany integer

与用户关联的主要公司。
设备类型
 folder.envelopePartyPermissions.partyDetails.deviceType string

所使用的设备类型。
设备令牌
 folder.envelopePartyPermissions.partyDetails.deviceToken string

设备的推送通知令牌。
分包商说明
 folder.envelopePartyPermissions.partyDetails.subcontractorDescription string

分包商或外部签名者的说明。
分包商组织
 folder.envelopePartyPermissions.partyDetails.subcontractorOrganization string

分包商或外部签名者的组织名称。
分包商添加日期
 folder.envelopePartyPermissions.partyDetails.subcAddedDate integer

分包商添加的日期（Unix 时间戳（以毫秒为单位）。
来源
 folder.envelopePartyPermissions.partyDetails.source string

从中添加外部签名者的源系统。
拨号代码
 folder.envelopePartyPermissions.dialingCode string

电话号码的国际拨号代码。
手机号
 folder.envelopePartyPermissions.mobileNumber string

移动电话号码。
签名类型
 folder.envelopePartyPermissions.signerSignatureType string

签名者将使用的签名类型。
权限
 folder.envelopePartyPermissions.contractPermissions string

为合同授予此方的权限。
签名顺序
 folder.envelopePartyPermissions.partySequence integer

此收件人的签名顺序序列号。
工作流序列
 folder.envelopePartyPermissions.workflowSignSequence integer

工作流签名序列号。
信封 ID
 folder.envelopePartyPermissions.envelopeId integer

信封的唯一标识符。
收件人公司 ID
 folder.envelopePartyPermissions.partyCompanyId integer

与此收件人关联的公司的唯一标识符。
共享模式
 folder.envelopePartyPermissions.sharingMode string

此信封的共享模式。
收件人访问 URL
 folder.envelopePartyPermissions.folderAccessURL string

收件人可用于访问和签名信封的 URL。
安全模式
 folder.envelopePartyPermissions.securityMode string

应用于此信封的安全模式。
注释
 folder.envelopePartyPermissions.extraComments string

信封中包含的其他注释。
允许名称更改
 folder.envelopePartyPermissions.allowNameChange boolean

指示是否允许收件人更新其名称。
已更新的名称
 folder.envelopePartyPermissions.signerNameUpdated boolean

指示签名者是否已更新其名称。
签名者身份验证级别
 folder.envelopePartyPermissions.signerAuthenticationLevel string

签名者所需的身份验证级别。
访问代码
 folder.envelopePartyPermissions.userDefinedAccessCode string

为签名者定义的自定义访问代码。
签名 ID
 folder.envelopePartyPermissions.signatureId string

签名的唯一标识符。
收件人角色
 folder.envelopePartyPermissions.partyRole string

在签名工作流中分配给此收件人的角色。
公司字段
 folder.envelopePartyPermissions.companyFieldValue string

签名中公司名称字段的值。
标题字段
 folder.envelopePartyPermissions.titleFieldValue string

签名中标题字段的值。
签名的原因
 folder.envelopePartyPermissions.reasonSigning string

收件人签署文档的原因。
已添加付款字段
 folder.envelopePartyPermissions.payFieldAdded boolean

指示是否已添加付款字段。
收款人
 folder.envelopePartyPermissions.payee boolean

指示此收件人是否为付款人。
定期付款
 folder.envelopePartyPermissions.recurringFieldExist boolean

指示是否存在定期付款字段。
打印并签名完成
 folder.envelopePartyPermissions.printAndSignCompleted boolean

指示打印和签名过程是否已完成。
支付
 folder.envelopePartyPermissions.paid boolean

指示是否已完成付款。
身份验证级别
 folder.envelopeAuthenticationLevel string

信封所需的身份验证级别。
单一签名者批量
 folder.allowSingleSignerInBulk boolean

指示是否允许在批量发送模式下使用单一签名者。
File-Based 命名
 folder.folderNameBasedOnFileNaming boolean

指示文件夹名称是否基于文件名。
文档 File-Based 名称
 folder.documentNameBasedOnFileNaming boolean

指示文档名称是否基于文件名。
证书 File-Based 名称
 folder.certificateNameBasedOnFileNaming boolean

指示证书名称是否基于文件名。
Pre-Exec 文件命名
 folder.enableFileNamingBeforeExecution boolean

指示是否在文档执行之前启用文件命名。
已添加付款人
 folder.payeeAddedd boolean

指示是否已添加付款人。
已启用 Self-Signing
 folder.selfSignerEnabled boolean

指示是否启用自签名模式。
Notary Enabled
 folder.notaryEnabled boolean

指示是否启用公证签名。
可见性有限
 folder.limitedVisibilityFlag boolean

指示是否为此信封启用了有限的可见性。
签名后可见性
 folder.postSigningVisibility boolean

指示是否启用签名后可见性。
湿签名
 folder.wetSignatureEnabled boolean

指示是否启用湿签名。
已启用合并
 folder.mergeEnabled boolean

指示是否启用文档合并。
嵌入式签名会话
 embeddedSigningSessions array of object

嵌入式签名会话列表，每个收件人一个。 仅当 createEmbeddedSigningSession 为 true 时才存在。
签名者电子邮件
 embeddedSigningSessions.emailIdOfSigner string

此嵌入式签名会话的收件人的电子邮件地址。
签名令牌
 embeddedSigningSessions.embeddedToken string

此收件人嵌入式签名会话的唯一令牌。
签名会话 URL
 embeddedSigningSessions.embeddedSessionURL string

要打开或嵌入此收件人以签署文档的 URL。
嵌入式发送令牌
 embeddedToken string

嵌入式发送会话的令牌。 仅当 createEmbeddedSendingSession 为 true 时才存在。
发送会话 URL
 embeddedSessionURL string

要打开或嵌入信封作者的 URL，以便准备并发送信封。 仅当 createEmbeddedSendingSession 为 true 时才存在。
Result
 result string

操作的结果。
Message
 message string

描述操作结果的消息。

从 URL 创建模板

操作 ID:
CreateTemplatefromURL

使用可公开访问的 PDF URL 创建新模板。

参数

名称 密钥 必需 类型 说明
模板名称
 templateName True string

模板的名称。 必须以 .pdf 扩展名（例如，onboarding.pdf）结尾。
模板 URL
 templateUrl True string

要用作模板的 PDF 文档的可公开访问 URL。
输入类型
 inputType True string

文档的输入方法。 始终设置为此操作的“url”。
处理文本标记
 processTextTags True boolean

启用后，Foxit eSign 将扫描文档以获取文本标记，并自动将它们转换为签名字段。
处理 Acro 字段
 processAcroFields True boolean

启用后，Foxit eSign 将扫描文档以获取 AcroFields，并自动将它们转换为签名字段。
全部共享
 shareAll True boolean

将此模板与帐户中的所有用户共享。
参与方数
 numberOfParties True integer

在模板中添加参与方数。 此参数的值应小于 20。
主题颜色
 themeColor string

输入颜色的 css 值以更改 createEmbeddedTemplateSession 的主题。
创作Email
 authorEmail string

在帐户中输入另一个用户的电子邮件，该用户将用作此模板的作者。
创建嵌入式模板会话
 createEmbeddedTemplateSession boolean

如果设置为 true，则嵌入模板会话以直接打开 Foxit eSign 模板准备视图。 在模板上拖放各种字段将可用。
重定向 URL
 redirectURL string

如果 createEmbeddedTemplateSession 为 true，则可以在任何网站/应用程序中输入登陆页面的绝对 URL，在嵌入模板视图中单击“保存并关闭”后，用户将被重定向到该 URL。
隐藏发送模板
 hideSendTemplate boolean

如果为 true，它将隐藏嵌入模板视图中的“发送”按钮。
修复收件人参与方
 fixRecipientParties boolean

如果为 true，则嵌入模板视图中无法更改已添加信封的参与方。
Fields
 Fields object
权限
 permission True string
序列
 sequence True integer

此方的唯一序列号，从 1 开始。 定义启用登录序列时的签名顺序。
收件人角色
 partyRole True string

在模板中分配给此方的角色。
隐藏更多操作
 hideMoreAction boolean

如果为 true，它将在模板会话中隐藏“更多操作”按钮。
全部隐藏共享
 hideShareWithAll boolean

如果为 true，它将在模板会话中隐藏“与所有共享”选项。
隐藏添加群
 hideAddParty boolean

如果为 true，它将隐藏嵌入模板会话中的所有添加方选项。
“隐藏我”按钮
 hideMeButton boolean

如果为 true，它将在嵌入的模板会话中隐藏收件人群上的“Me”按钮。
隐藏其他按钮
 hideOthersButton boolean

如果为 true，它将隐藏嵌入模板会话中收件人群上的“其他”按钮。
隐藏现有联系人选择选项
 hideExistingContactSelectOption boolean

如果为 true，它将隐藏嵌入模板会话中收件人群上的“查找和添加现有联系人”输入框。
隐藏收件人的字段名称
 hideFieldNameForRecipients boolean

隐藏“数据输入字段”和“高级字段”收件人的字段名称。（单选按钮、复选框、图像和超链接除外）。
隐藏复选框边框
 hideCheckboxBorder boolean

复选框的边框将隐藏在执行的文档中。

返回

名称 路径 类型 说明
Result
 result string

指示操作是否成功（例如“success”）。
Message
 message string

操作结果的说明。
ID
 template.templateId integer

创建模板的唯一 ID。 使用此模板创建信封。
Name
 template.templateName string

模板的名称。
Description
 template.templateDesc string

模板的说明。
类型
 template.templateType string

模板的类型。
创建日期
 template.templateCreationDate string

模板的创建日期。
上次更新时间
 template.templateLastUpdateDate string

上次更新模板的日期。
可编辑
 template.editable boolean

指示是否可以编辑模板。
参与方数
 template.numberOfParties integer

模板中定义的收件人参与方数。
总页数
 template.totalPages integer

模板文档中的总页数。
公司 ID
 template.companyId integer

此模板所属的公司 ID。
与所有共享
 template.shareAll boolean

指示此模板是否与帐户中的所有用户共享。
自定义名称模式
 template.templateCustomName string

应用于从此模板创建的信封的自定义名称模式。
参与方权限
 template.templatePartyPermissions array of object

此模板中定义的收件人角色及其权限的列表。
当事方 ID
 template.templatePartyPermissions.template_party_id integer

此模板参与方条目的唯一 ID。
ID
 template.templatePartyPermissions.templateId integer

此方所属的模板的 ID。
权限
 template.templatePartyPermissions.templatePermissions string

此方（例如FILL_FIELDS_AND_SIGN）的签名权限。
签名顺序
 template.templatePartyPermissions.partySequence integer

此方的签名顺序位置。
群角色
 template.templatePartyPermissions.templatePartyRole string

在模板中分配给此方的角色名称。 从模板创建信封时，请使用此功能。
当事方 ID
 template.templatePartyPermissions.partyId integer

分配给此角色的参与方的 ID（如果已预先分配）。
用户 ID
 template.templateCreatedBy.partyId integer

用户的唯一 ID。
名字
 template.templateCreatedBy.firstName string

用户的名字。
姓氏
 template.templateCreatedBy.lastName string

用户的姓氏。
Email
 template.templateCreatedBy.emailId string

用户的电子邮件地址。
公司 ID
 template.templateCreatedBy.companyId integer

用户所属的公司 ID。
用户角色
 template.templateCreatedBy.userRole string

用户在其组织内的角色。
积极
 template.templateCreatedBy.active boolean

指示用户帐户是否处于活动状态。
用户 ID
 template.templateLastUpdatedBy.partyId integer

用户的唯一 ID。
名字
 template.templateLastUpdatedBy.firstName string

用户的名字。
姓氏
 template.templateLastUpdatedBy.lastName string

用户的姓氏。
Email
 template.templateLastUpdatedBy.emailId string

用户的电子邮件地址。
公司 ID
 template.templateLastUpdatedBy.companyId integer

用户所属的公司 ID。
用户角色
 template.templateLastUpdatedBy.userRole string

用户在其组织内的角色。
积极
 template.templateLastUpdatedBy.active boolean

指示用户帐户是否处于活动状态。
模板字段
 allfields array of object

模板中定义的所有签名和表单字段的列表。
字段 ID
 allfields.fieldTagId integer

字段的唯一标识符。
模板编号
 allfields.templateId integer

此字段所属的模板的 ID。
公司 ID
 allfields.companyId integer

此字段所属的公司帐户。
字段类型
 allfields.fieldType string

字段的类型（例如，signfield、initialfield、textfield、datefield、checkboxfield、securedfield、attachmentfield）。
页码
 allfields.documentPageNumber integer

放置此字段的文档的页码。
责任方
 allfields.partyResponsible integer

负责填充此字段的群序列号。
Party 序列
 allfields.partyResponsibleSequence integer

责任方的序列位置。
字段文档 ID
 allfields.docFieldId string

此字段的文档级标识符。
依赖
 allfields.dependent boolean

指示此字段的可见性是否取决于另一个字段的值。
Tab 键顺序
 allfields.tabOrder integer

用于在字段之间导航的 Tab 键顺序。
必需
 allfields.required boolean

指示是否必须填写此字段，然后才能对文档进行签名。
自定义字段名称
 allfields.customFieldName string

分配给此字段的自定义名称。
全部共享
 allfields.shareAll boolean

指示此字段是否与所有用户共享。
允许编辑
 allfields.allowEdit boolean

指示收件人是否可以编辑此字段。
文本字段名称
 allfields.textfieldName string

文本字段的标签（在 fieldType 为“textfield”时适用）。
Value
 allfields.value string

字段的预填充或输入值。
字体大小
 allfields.fontSize integer

用于此字段中文本的字号。
字体颜色
 allfields.fontColor string

此字段中用于文本的字体颜色（例如 #0000000）。
只读
 allfields.readOnly boolean

指示该字段是否为只读字段，并且不能由收件人编辑。
多行
 allfields.multiLine boolean

指示文本字段是否接受多行输入（在 fieldType 为“textfield”时适用）。
字符限制
 allfields.characterLimit integer

字段中允许的最大字符数（在 fieldType 为“textfield”时适用）。
日期字段名称
 allfields.datefieldName string

日期字段的标签（在 fieldType 为“datefield”时适用）。
日期格式
 allfields.dateFormat string

此字段使用的日期格式（例如 MM/DD/YYYY）（适用于 fieldType 为“datefield”时）。
复选框名称
 allfields.cbname string

复选框字段的标签（在 fieldType 为“checkboxfield”时适用）。
复选框组
 allfields.cbgroup string

此复选框的组名称（适用于 fieldType 为“checkboxfield”时）。
已选中
 allfields.checked boolean

指示复选框是否默认选中（适用于 fieldType 为“checkboxfield”时）。
受保护的字段名称
 allfields.securedfieldName string

受保护字段的标签（在 fieldType 为“securedfield”时适用）。
要显示的字符
 allfields.charToDisplay integer

要在安全字段值末尾显示的未屏蔽字符数（适用于 fieldType 为“securedfield”时）。
签名 ID
 allfields.signatureId string

应用于此签名字段的签名的 ID（适用于 fieldType 为“signfield”时）。
初始图像
 allfields.initialImage string

应用于此字段的首字母缩写的图像数据（适用于 fieldType 为“initialfield”时）。
附件字段名称
 allfields.attachmentfieldName string

附件字段的名称（在 fieldType 为“attachmentfield”时适用）。
附件说明
 allfields.attachmentfieldDescription string

说明要附加的内容（在 fieldType 为“attachmentfield”时适用）。

从模板创建信封

操作 ID:
CreateEnvelopefromTemplate

使用现有模板创建和发送信封。 可以自定义收件人详细信息。

参数

名称 密钥 必需 类型 说明
信封名称
 folderName string

文档文件夹的名称。 如果未提供此值，则文档（s） 文件夹名称与模板名称（s）保持相同。
模板 ID
 templateIds True array of integer

要用于为此文件夹创建文档的模板 ID 数组。
Fields
 fields object

可以传递模板中使用的字段值，以在模板中创建的文档中预填充这些值。 FIELD_NAME是模板中使用的字段的名称。 FIELD_VALUE是文档字段值。
高级电子邮件验证
 allowAdvancedEmailValidation boolean

将参与方的电子邮件地址设置为 true 时进行验证。
名字
 firstName True string

收件人的名字。
姓氏
 lastName True string

收件人的姓氏。
Email地址
 emailId True string

收件人的电子邮件地址。
权限
 permission True string
序列
 sequence True integer

使用此字段可向收件人列表中的收件人分配序列号。 对从 1 开始的每个方使用唯一序列号，例如 1,2,3,4....如果在签名工作流中多次出现单个人员，请在每次重复收件人时分配不同的序列。
signerAuthLevels
 signerAuthLevel string

签名者用于验证的身份验证级别
占位符
 isPlaceholder boolean

使用此字段启动参与方是占位符。 注意：1. firstName、lastName、emailId 参数的值必须为此方空白。 2. 若要添加占位符，必须使用“PARTY_ASSIGNER”权限重新引用一个收件人。
收件人角色
 partyRole string

使用此字段分配占位符的角色。
允许名称更改
 allowNameChange string

值可以是 true 或 false，使用此参数允许签名者在完成签名过程之前更新名字和姓氏。
工作流序列
 workflowSequence integer

向此收件人分配工作流序列号。 启用登录序列后，收件人会按升序顺序接收其签名邀请。
主机电子邮件 ID
 hostEmailId string

In-Person 管理员的电子邮件地址。
访问代码
 userDefinedAccessCode string

当“signerAuthLevel”值设置为“用户定义的访问代码”进行身份验证时，该参数将包含 Access Code。 注意：1. 代码不区分大小写。 2. 系统不发送此代码，因此必须直接与签名者共享此代码。 3. 访问代码可以包含字母、数字和以下特殊字符：@、&、{,}%、（、）、~、|,!,+、^。
群是电子邮件组
 partyIsEmailGroup boolean

批量创建群时使用此参数。 注意： 如果此参数为 true，将忽略此参与方的 firstName、lastName 和 emailId。
电子邮件组 ID
 emailGroupId integer

传递要用于批量创建组 ID 的电子邮件。
单一签名者批量
 allowSingleSignerInBulk boolean

使用此参数仅允许一个人登录电子邮件组。
拨号代码
 dialingCode string

使用此字段可分配国家/地区拨入代码是收件人列表中的收件人的手机号码前缀。
手机号
 mobileNumber string

使用此字段可向收件人列表中的收件人分配一个手机号码。
信封密码
 folderPassword string

签名者/作者需要此密码才能打开数字签名的文档。 如果参数保持空白，则无需密码即可打开数字签名的文档。
登录顺序
 signInSequence boolean

此字段用于确定收件人是否按顺序对信封文档进行签名。 如果为 false，则所有收件人同时接收邀请电子邮件。 如果为 true，则每个收件人在上一个收件人完成所需任务后连续接收邀请电子邮件，例如对文档进行签名或填写字段等。
“亲自启用”
 inPersonEnable boolean

此字段用于启动可在几分钟内在任何设备上轻松完成的人员签名过程，并在需要时避免基于电子邮件的签名。 如果为 false，则所有收件人同时收到邀请电子邮件。 如果为 true，则内部管理员会收到邀请电子邮件，以启动签名者的签名过程。
立即发送
 sendNow boolean

启用后，Foxit eSign 会立即向每个收件人的电子邮件地址发送唯一的签名链接。 请禁用此选项以将信封保存为草稿。
签署成功 URL 各方
 signSuccessUrlAllParties boolean

如果设置为 true，则成功签名后，签名者将重定向到 signSuccessUrl 中提供的 URL。 仅当 sendNow 为 true 时才适用。
创建嵌入式发送会话
 createEmbeddedSendingSession boolean

如果设置为 true，它将生成嵌入 URL 以打开 Foxit eSign 的文档准备视图。
修复收件人参与方
 fixRecipientParties boolean

如果为 true，则嵌入发送视图中无法更改已作为此请求的一部分添加的信封的参与方。
修复文档
 fixDocuments boolean

如果为 true，则嵌入发送中无法更改已作为此请求的一部分添加的信封的文档。
发送成功 URL
 sendSuccessUrl string

输入登录页的绝对 URL，登录者将在嵌入的发送视图中成功发送文件夹后重定向到该 URL。
发送错误 URL
 sendErrorUrl string

输入登陆页面的绝对 URL，如果发送嵌入的发送视图中的文件夹出现错误，签名者将重定向到该 URL。
隐藏签名者选择选项
 hideSignerSelectOption boolean

如果为 true，它将隐藏嵌入式发送会话中收件人群上的“现有签名者名称/电子邮件”输入框。
隐藏签名者操作
 hideSignerActions boolean

如果为 true，它将在嵌入式发送会话中隐藏对收件人参与方的“编辑”、“更改”和“删除”操作。
隐藏发件人名称
 hideSenderName boolean

如果为 true，它将在嵌入的发送会话中隐藏收件人群上的发件人名称。
隐藏发送按钮
 hideSendButton boolean

如果为 true，它将隐藏嵌入式发送会话中的“发送”按钮。
隐藏文件夹名称
 hideFolderName boolean

如果为 true，它将在两个嵌入会话中的导航上隐藏文件夹名称。
隐藏文档名称
 hideDocumentsName boolean

如果为 true，它将在两个嵌入会话中隐藏文档名称。
隐藏“添加我”按钮
 hideAddMeButton boolean

如果为 true，它将在嵌入式发送会话中隐藏收件人群上的“添加我”按钮。
隐藏“添加新”按钮
 hideAddNewButton boolean

如果为 true，它将在嵌入式发送会话中隐藏收件人群上的“添加新”按钮。
隐藏“添加组”按钮
 hideAddGroupButton boolean

如果为 true，它将在嵌入式发送会话中隐藏收件人群上的“添加组”按钮。
创建嵌入式签名会话
 createEmbeddedSigningSession boolean

签名会话令牌将生成，而不会向收件人发送电子邮件。
为各方创建嵌入式签名会话
 createEmbeddedSigningSessionForAllParties boolean

如果设置为 true，则会为信封中的每个收件人生成嵌入签名 URL。 如果为 false，则只有嵌入式签名者电子邮件 ID 中列出的收件人会收到嵌入会话。
嵌入式签名者电子邮件 ID
 embeddedSignersEmailIds array of string

需要为其创建嵌入式签名会话的收件人的电子邮件 ID 数组。 参与方列表中添加的收件人方的电子邮件 ID。
签名成功 URL
 signSuccessUrl string

输入成功登录嵌入式签名视图后将重定向到的签名者的绝对 URL。
签名拒绝 URL
 signDeclineUrl string

输入要重定向到的签名者的绝对 URL（如果拒绝登录嵌入式签名视图）。
稍后签署 URL
 signLaterUrl string

输入将重定向到的签名者的绝对 URL（如果以后选择在嵌入式签名视图中登录）。
签名错误 URL
 signErrorUrl string

在嵌入式签名视图中为文档签名期间出现错误时，输入将重定向到的签名者的绝对 URL。
隐藏下一个必填字段 Btn
 hideNextRequiredFieldBtn boolean

如果设置为 true，则隐藏将签名者移动到下一个必需字段的导航按钮。
主题颜色
 themeColor string

输入 CSS 值以设置主题颜色。
隐藏拒绝签名
 hideDeclineToSign boolean

如果设置为 true，则隐藏签名屏幕上的“拒绝登录”选项。
隐藏更多操作
 hideMoreAction boolean

如果设置为 true，则隐藏发送和签名会话中的“更多操作”按钮。 当“立即发送”为 true 时不起作用。
隐藏“添加参与方”选项
 hideAddPartiesOption boolean

如果设置为 true，则隐藏在草稿和模板创建模式下添加参与方的选项。
会话过期
 sessionExpire boolean

设置为 true 以启动嵌入签名会话的过期时间。
到期
 expiry integer

如果 sessionExpire 为 true，则为必需。 输入嵌入签名会话到期的持续时间（以毫秒为单位）。
发件人电子邮件
 senderEmail string

在帐户中输入另一个用户的电子邮件，该电子邮件将用于向收件人方发送此文档文件夹。
允许立即发送和嵌入式签名会话
 allowSendNowAndEmbeddedSigningSession boolean

如果设置为 true，Foxit eSign 会向每个收件人发送签名邀请电子邮件，并为嵌入签名者电子邮件中包含的收件人生成嵌入签名链接。 电子邮件和嵌入链接同时处于活动状态。
启用分步
 enableStepByStep boolean

在嵌入式发送会话中启用分步操作。

返回

名称 路径 类型 说明
Result
 result string

指示操作是否成功（例如“success”）。
Message
 message string

操作结果的说明。
嵌入式签名会话
 embeddedSigningSessions array of object

嵌入式签名会话列表，每个收件人一个。 仅当 createEmbeddedSigningSession 为 true 时才存在。
签名者电子邮件
 embeddedSigningSessions.emailIdOfSigner string

此嵌入式签名会话的收件人的电子邮件地址。
签名令牌
 embeddedSigningSessions.embeddedToken string

此收件人嵌入式签名会话的唯一令牌。
签名会话 URL
 embeddedSigningSessions.embeddedSessionURL string

要打开或嵌入此收件人以签署文档的 URL。
嵌入式发送令牌
 embeddedToken string

嵌入式发送会话的令牌。 仅当 createEmbeddedSendingSession 为 true 时才存在。
发送会话 URL
 embeddedSessionURL string

要打开或嵌入信封作者的 URL，以便准备并发送信封。 仅当 createEmbeddedSendingSession 为 true 时才存在。
ID
 folder.folderId integer

创建信封的唯一 ID。 使用此在后续操作中引用信封。
Name
 folder.folderName string

信封的名称。
自定义名称
 folder.folderCustomName string

分配给信封的自定义名称。
密码
 folder.folderPassword string

为信封设置的密码（如果有）。
作者 ID
 folder.folderAuthorId integer

创建信封的用户的唯一 ID。
作者名字
 folder.folderAuthorFirstName string

信封创建者的名字。
作者姓氏
 folder.folderAuthorLastName string

信封创建者的姓氏。
创作Email
 folder.folderAuthorEmail string

信封创建者的电子邮件地址。
作者角色
 folder.folderAuthorRole string

信封创建者的帐户角色。
公司 ID
 folder.folderCompanyId integer

信封所属公司的唯一 ID。
创建日期
 folder.folderCreationDate integer

创建信封的日期和时间（以 Unix 毫秒为单位）。
发送日期
 folder.folderSentDate integer

信封发送到收件人的日期和时间（以 Unix 毫秒为单位）。
地位
 folder.folderStatus string

信封的当前状态（例如，SHARED、EXECUTED、DRAFT、CANCELLED）。
自定义字段 1
 folder.custom_field1 string

信封上设置的自定义字段 1 的值。
自定义域 2
 folder.custom_field2 string

信封上设置的自定义字段 2 的值。
Metadata
 folder.metadata string

与信封关联的任何其他元数据。
文档 ID
 folder.folderDocumentIds array of integer

此信封中包含的文档 ID 列表。
文档
 folder.documentsList array of object

信封中包含的每个文档的详细信息。
文档编号
 folder.documentsList.documentId integer

文档的唯一标识符。
合同 ID
 folder.documentsList.contractId integer

与此文档关联的协定的唯一标识符。
公司 ID
 folder.documentsList.companyId integer

本文档所属的公司的唯一 ID。
创建者
 folder.documentsList.contractCreatedBy integer

创建合同的人员的用户 ID。
创建日期
 folder.documentsList.contractCreatedOn string

合同的创建日期。
协定类型
 folder.documentsList.contractType string

协定的类型。
文档状态
 folder.documentsList.contractStatus string

文档的当前签名状态（例如，WAITING_FOR_SIGNATURE，EXECUTED）。
可编辑
 folder.documentsList.editable boolean

指示是否可以编辑文档。
版本标识
 folder.documentsList.contractVersionId integer

当前文档版本的唯一 ID。
版本名称
 folder.documentsList.contractVersionName string

当前文档版本的名称。
版本说明
 folder.documentsList.contractVersionDesc string

当前文档版本的说明。
创建者版本
 folder.documentsList.versionCreatedby integer

创建此文档版本的人员的用户 ID。
创建的版本
 folder.documentsList.versionCreatedOn string

创建此文档版本的日期。
版本号
 folder.documentsList.contractVersionNumber integer

文档的版本号。
事务源
 folder.documentsList.contractTransactionSource string

协定事务的源。
收件人
 folder.folderRecipientParties array of object

此信封的收件人列表，包括其个人签名链接。
收件人 ID
 folder.folderRecipientParties.partyId integer

收件人的唯一标识符。
收件人 ID
 folder.folderRecipientParties.partyDetails.partyId integer

收件人的唯一标识符。
名字
 folder.folderRecipientParties.partyDetails.firstName string

收件人的名字。
姓氏
 folder.folderRecipientParties.partyDetails.lastName string

收件人的姓氏。
Email
 folder.folderRecipientParties.partyDetails.emailId string

收件人的电子邮件地址。
占位符
 folder.folderRecipientParties.partyDetails.placeholder boolean

指示此收件人是否为占位符。
地址
 folder.folderRecipientParties.partyDetails.address string

收件人的地址。
帐户创建日期
 folder.folderRecipientParties.partyDetails.dateCreated integer

收件人帐户的创建日期（以 Unix 毫秒为单位）。
选择退出电子邮件
 folder.folderRecipientParties.partyDetails.optOutEmails boolean

指示收件人是否已选择退出电子邮件通知。
唯一方 ID
 folder.folderRecipientParties.partyDetails.uniquePartyId string

收件人的唯一字符串标识符。
身份验证级别
 folder.folderRecipientParties.partyDetails.authenticationLevel string

此收件人所需的身份验证级别。
公司 ID
 folder.folderRecipientParties.partyDetails.companyId integer

收件人所属的公司 ID。
用户角色
 folder.folderRecipientParties.partyDetails.userRole string

收件人在其组织内的角色。
Department
 folder.folderRecipientParties.partyDetails.department string

收件人的部门。
Title
 folder.folderRecipientParties.partyDetails.title string

收件人的职务。
积极
 folder.folderRecipientParties.partyDetails.active boolean

指示收件人的帐户是否处于活动状态。
拨号代码
 folder.folderRecipientParties.partyDetails.dialingCode string

收件人电话号码的国家/地区拨号代码。
手机号
 folder.folderRecipientParties.partyDetails.mobileNumber string

收件人的移动电话号码。
分包商说明
 folder.folderRecipientParties.partyDetails.subcontractorDescription string

分包商的说明（如果适用）。
分包商组织
 folder.folderRecipientParties.partyDetails.subcontractorOrganization string

分包商的组织名称（如果适用）。
分包商添加日期
 folder.folderRecipientParties.partyDetails.subcAddedDate integer

分包商的添加日期（以 Unix 毫秒为单位）。
来源
 folder.folderRecipientParties.partyDetails.source string

添加收件人的源。
拨号代码
 folder.folderRecipientParties.dialingCode string

收件人的电话号码的国家/地区拨号代码。
手机号
 folder.folderRecipientParties.mobileNumber string

收件人的手机号码。
签名类型
 folder.folderRecipientParties.signerSignatureType string

此收件人允许的签名类型。
权限
 folder.folderRecipientParties.contractPermissions string

授予此收件人的签名权限（例如，FILL_FIELDS_AND_SIGN）。
签名顺序
 folder.folderRecipientParties.partySequence integer

此收件人在签名顺序中的位置。
工作流序列
 folder.folderRecipientParties.workflowSignSequence integer

此收件人的工作流签名序列号。
信封 ID
 folder.folderRecipientParties.envelopeId integer

此收件人所属的信封的 ID。
Party 公司 ID
 folder.folderRecipientParties.partyCompanyId integer

此收件人所属的公司 ID。
共享模式
 folder.folderRecipientParties.sharingMode string

用于与此收件人共享文档的方法（例如电子邮件）。
签名 URL
 folder.folderRecipientParties.folderAccessURL string

此收件人的唯一签名 URL。 使用此链接直接共享签名链接。
安全模式
 folder.folderRecipientParties.securityMode string

应用于此收件人访问权限的安全模式。
额外批注
 folder.folderRecipientParties.extraComments string

此收件人的签名邀请中包含的任何其他注释。
允许名称更改
 folder.folderRecipientParties.allowNameChange boolean

指示是否允许收件人在签名前更改其姓名。
已更新的名称
 folder.folderRecipientParties.signerNameUpdated boolean

指示收件人是否已更新其显示名称。
身份验证级别
 folder.folderRecipientParties.signerAuthenticationLevel string

此收件人访问文档所需的身份验证方法。
访问代码
 folder.folderRecipientParties.userDefinedAccessCode string

此收件人打开文档所需的自定义访问代码。
签名 ID
 folder.folderRecipientParties.signatureId string

此收件人使用的已保存签名的 ID。
收件人角色
 folder.folderRecipientParties.partyRole string

在信封中分配给此收件人的角色。
公司字段值
 folder.folderRecipientParties.companyFieldValue string

为此收件人预先填充的公司字段值。
标题字段值
 folder.folderRecipientParties.titleFieldValue string

为此收件人预先填充的标题字段值。
签名的原因
 folder.folderRecipientParties.reasonSigning string

此收件人提供的签名的原因。
已添加“付款”字段
 folder.folderRecipientParties.payFieldAdded boolean

指示是否已为此收件人添加付款字段。
是付款人
 folder.folderRecipientParties.payee boolean

指示此收件人是否为付款人。
重复字段存在
 folder.folderRecipientParties.recurringFieldExist boolean

指示此收件人是否存在定期付款字段。
打印和签名已完成
 folder.folderRecipientParties.printAndSignCompleted boolean

指示收件人是否已完成打印和签名操作。
允许可选签名者
 folder.folderRecipientParties.allowOptionalSigner boolean

指示是否可以将此收件人作为可选签名者跳过。
可选签名者
 folder.folderRecipientParties.optionalSigners string

与此收件人关联的可选签名者列表（如果有）。
支付
 folder.folderRecipientParties.paid boolean

指示此收件人是否已完成付款。
创作访问 URL
 folder.folderAccessURLForAuthor string

信封作者访问文档的 URL。
草稿访问 URL
 folder.draftFolderAccessURL string

在信封处于草稿状态时访问信封的 URL。
板房标志
 folder.boardRoomSign boolean

指示是否为此信封启用了板房签名。
包括徽标
 folder.includeLogo boolean

指示公司徽标是否包含在电子邮件通知中。
电子邮件按钮颜色
 folder.email_btnBgColor string

签名电子邮件中操作按钮的背景色。
电子邮件按钮文本颜色
 folder.email_btnTxtColor string

签名电子邮件中操作按钮的文本颜色。
电子邮件徽标
 folder.emailTemplateLogo string

电子邮件模板中使用的徽标图像。
电子邮件模板 ID
 folder.emailTemplateId integer

用于签名通知的电子邮件模板的 ID。
电子邮件标头
 folder.emailHeader string

签名通知电子邮件中的自定义标头文本。
电子邮件页脚
 folder.emailFooter string

签名通知电子邮件中的自定义页脚文本。
清除计划
 folder.purgeFlag boolean

指示是否计划此信封进行自动清除。
清除开始日期
 folder.purgeStartDate string

清除周期开始的日期。
清除结束日期
 folder.purgeEndDate string

将清除信封的日期。
批量 ID
 folder.bulkId integer

此信封所属的批量发送批处理的 ID（如果有）。
强制实施签名顺序
 folder.enforceSignWorkflow boolean

指示收件人是否必须按指定顺序登录。
当前工作流步骤
 folder.currentWorkflowStep integer

签名工作流中的当前步骤。
事务源
 folder.transactionSource string

发起此信封事务的源。
可编辑
 folder.editable boolean

指示信封是否仍可编辑。
In-Person 签名
 folder.inPersonSignable boolean

指示是否可以亲自登录信封。
替代提醒
 folder.overrideAccountReminders boolean

指示是否为此信封重写帐户级提醒设置。
替代委派
 folder.overrideAccountRecipientDelegation boolean

指示是否为此信封重写帐户级委派设置。
允许委派
 folder.allowRecipientsToDelegate boolean

指示是否允许收件人将其签名委托给另一个人。
ID
 folder.envelopeId integer

信封的唯一 ID。 与信封 ID 相同的值（folderId）。
Name
 folder.envelopeName string

信封的名称。 与信封名称（folderName）相同的值。
发起方 ID
 folder.envelopeOriginatorId integer

创建信封的人员的用户 ID。
公司 ID
 folder.envelopeCompanyId integer

信封所属的公司 ID。
日期
 folder.envelopeDate integer

创建信封的日期和时间（以 Unix 毫秒为单位）。
共享日期
 folder.envelopeSharedDate integer

信封与收件人共享的日期和时间（以 Unix 毫秒为单位）。
地位
 folder.envelopeStatus string

信封的当前状态。 与信封状态（folderStatus）的值相同。
合同 ID
 folder.envelopeContractIds array of integer

与此信封关联的合同 ID 列表。
参与方权限
 folder.envelopePartyPermissions array of object

收件人及其签名权限的列表。 与收件人相同的结构。
收件人 ID
 folder.envelopePartyPermissions.partyId integer

收件人的唯一标识符。
签名 URL
 folder.envelopePartyPermissions.folderAccessURL string

此收件人的唯一签名 URL。
权限
 folder.envelopePartyPermissions.contractPermissions string

此收件人的签名权限。
签名顺序
 folder.envelopePartyPermissions.partySequence integer

此收件人在签名顺序中的位置。
身份验证级别
 folder.envelopeAuthenticationLevel string

应用于整个信封的身份验证级别。
允许批量进行单一签名
 folder.allowSingleSignerInBulk boolean

指示是否允许在批量发送模式下使用单一签名者。
基于文件的名称
 folder.folderNameBasedOnFileNaming boolean

指示信封名称是否派生自文件名。
基于文件的文档名称
 folder.documentNameBasedOnFileNaming boolean

指示文档名称是否派生自文件名。
基于文件的证书名称
 folder.certificateNameBasedOnFileNaming boolean

指示证书名称是否派生自文件名。
启用文件命名
 folder.enableFileNamingBeforeExecution boolean

指示是否在发送信封之前提示文件命名。
已添加付款人
 folder.payeeAddedd boolean

指示付款人是否已添加到信封中。
自签名者
 folder.selfSignerEnabled boolean

指示发件人是否也是此信封上的签名者。
Notary Enabled
 folder.notaryEnabled boolean

指示是否为此信封启用了公证。
可见性有限
 folder.limitedVisibilityFlag boolean

指示是否启用了有限的文档可见性。
签名后可见性
 folder.postSigningVisibility boolean

指示收件人是否可以在完成后查看已签名的文档。
已启用湿签名
 folder.wetSignatureEnabled boolean

指示是否为此信封启用了湿（手写）签名。
已启用合并
 folder.mergeEnabled boolean

指示是否为此信封启用了文档合并。

列出所有 Webhook 通道

操作 ID:
ListallWebhookChannels

返回帐户中配置的所有 Webhook 通道的列表。

返回

名称 路径 类型 说明
Result
 result string

指示请求是否成功。
频道总数
 total_channel integer

帐户中配置的 Webhook 通道总数。
Webhook 通道
 templatesList array of object

帐户中所有 Webhook 通道的列表。
通道 ID
 templatesList.channelId integer

Webhook 通道的唯一标识符。
公司 ID
 templatesList.companyId integer

此渠道所属的公司帐户。
通道名称
 templatesList.channelName string

Webhook 通道的名称。
Webhook 链接地址
 templatesList.webhookUrl string

Foxit eSign 在发生订阅事件时将调用的 URL。
Webhook 机密
 templatesList.webhookSecret string

用于验证 Webhook 有效负载的密钥。
创建日期
 templatesList.dateCreated integer

通道的创建日期（以 Unix 毫秒为单位）。
已更新日期
 templatesList.dateUpdated integer

频道上次更新的日期（以 Unix 毫秒为单位）。
Webhook 级别
 templatesList.webhookLevel string

Webhook 通道的范围。 “帐户”（所有信封的触发器）或“API 应用”（仅针对通过 API 创建的信封触发）。
地位
 templatesList.status string

通道的当前状态。 “active”或“deactive”。
已发送信封
 templatesList.eventsSubscribedMap.folder_sent boolean

将信封发送到收件人时触发。
已查看信封
 templatesList.eventsSubscribedMap.folder_viewed boolean

收件人打开信封时触发。
带符号的信封
 templatesList.eventsSubscribedMap.folder_signed boolean

收件人签名信封时触发。
信封已取消
 templatesList.eventsSubscribedMap.folder_cancelled boolean

取消信封时触发。
已执行的信封
 templatesList.eventsSubscribedMap.folder_executed boolean

当各方已签名并完全执行信封时触发。
信封已删除
 templatesList.eventsSubscribedMap.folder_deleted boolean

删除信封时触发。

创建电子邮件组

操作 ID:
CreateEmailGroup

创建一个新的电子邮件组，该组可用于一次性向多个收件人发送信封。

参数

名称 密钥 必需 类型 说明
组名称
 emailGroupName True string

新电子邮件组的名称。
组说明
 emailGroupDescription string

电子邮件组的可选说明。
允许高级电子邮件验证
 allowAdvancedEmailValidation boolean

启用后，Foxit eSign 会验证组中的所有电子邮件地址在发送之前是否可访问。
名字
 firstName True string

收件人的名字。
姓氏
 lastName True string

收件人的姓氏。
Email
 emailId True string

收件人的电子邮件地址。

返回

名称 路径 类型 说明
Result
 result string

指示请求是否成功。
Message
 message string

所执行的操作的确认消息。
群组标识符
 emailGroup.groupId integer

电子邮件组的唯一标识符。 将信封发送到组时使用此 ID。
组名称
 emailGroup.groupName string

电子邮件组的名称。
组说明
 emailGroup.groupDesc string

电子邮件组的说明。
创建日期
 emailGroup.dateCreated integer

电子邮件组的创建日期（以 Unix 毫秒为单位）。
公司 ID
 emailGroup.companyId integer

此电子邮件组所属的公司帐户。
Parties
 emailGroup.parties array of object

电子邮件组中的收件人列表。
名字
 emailGroup.parties.firstName string

收件人的名字。
姓氏
 emailGroup.parties.lastName string

收件人的姓氏。
Email
 emailGroup.parties.emailId string

收件人的电子邮件地址。

删除信封

操作 ID:
DeleteEnvelopes

永久删除一个或多个信封。

参数

名称 密钥 必需 类型 说明
文件夹 ID
 folderIds True array of integer

要对其执行操作的信封 ID 数组。

返回

名称 路径 类型 说明
Result
 result string

指示操作是否成功。

发送签名提醒

操作 ID:
SendSignatureReminder

向信封的挂起收件人发送提醒通知，提示他们完成签名。

参数

名称 密钥 必需 类型 说明
信封 ID
 folderId True integer

信封的 ID。

返回

名称 路径 类型 说明
Result
 result string

指示请求是否成功。
信封 ID
 reminder sent integer

为其发送提醒的信封的 ID。

取消信封

操作 ID:
CancelEnvelope

取消已发送的信封。 收件人将无法再对文档进行签名。

参数

名称 密钥 必需 类型 说明
信封 ID
 folderId True integer

要取消的信封的 ID。
取消原因
 reason_for_cancellation True string

取消此信封的原因。 这记录在信封活动历史记录中。

返回

名称 路径 类型 说明
Result
 result string

指示请求是否成功。
已取消的信封 ID
 folders cancelled array of integer

已成功取消的信封 ID 列表。

取消订阅 Webhook 触发器

操作 ID:
DeleteTriggerWebhookChannel

按其通道 ID 删除活动的 Webhook 通道订阅。 使用此操作清理不再需要的 Webhook 订阅。

参数

名称 密钥 必需 类型 说明
通道 ID
 channelId True integer

要删除的 Webhook 通道的 ID。

将信封移动到回收站

操作 ID:
MoveEnvelopestoRecycleBin

将一个或多个信封移动到回收站。 回收站中的信封不会永久删除。

参数

名称 密钥 必需 类型 说明
文件夹 ID
 folderIds True array of integer

要对其执行操作的信封 ID 数组。

返回

名称 路径 类型 说明
Result
 result string

指示操作是否成功。

按模板 ID 获取模板

操作 ID:
GetTemplatesbyTemplateIds

按 ID 检索一个或多个模板的详细信息。

参数

名称 密钥 必需 类型 说明
模板 ID
 templateIds True array of integer

要检索的模板 ID 数组。

返回

名称 路径 类型 说明
Result
 result string

指示请求是否成功。
模板总数
 total_templates integer

返回的模板总数。
模板列表
 templateIdList object

模板 ID 键键的模板数据的映射。 每个条目都包含模板详细信息及其字段。

获取 Webhook 通道详细信息

操作 ID:
GetWebhookChannelDetails

检索特定 Webhook 通道的详细信息。

参数

名称 密钥 必需 类型 说明
通道 ID
 channelId True string

要检索的 Webhook 通道的唯一标识符。

返回

名称 路径 类型 说明
Result
 result string

指示请求是否成功。
ID
 channel.channelId integer

Webhook 通道的唯一标识符。
公司 ID
 channel.companyId integer

此渠道所属的公司帐户。
Name
 channel.channelName string

Webhook 通道的名称。
Webhook 链接地址
 channel.webhookUrl string

Foxit eSign 在发生订阅事件时将调用的 URL。
Webhook 机密
 channel.webhookSecret string

用于验证 Webhook 有效负载的密钥。
创建日期
 channel.dateCreated integer

通道的创建日期（以 Unix 毫秒为单位）。
已更新日期
 channel.dateUpdated integer

频道上次更新的日期（以 Unix 毫秒为单位）。
Webhook 级别
 channel.webhookLevel string

Webhook 通道的范围。 “帐户”（所有信封的触发器）或“API 应用”（仅针对通过 API 创建的信封触发）。
地位
 channel.status string

通道的当前状态。 “active”或“deactive”。
已发送信封
 channel.eventsSubscribedMap.folder_sent boolean

将信封发送到收件人时触发。
已查看信封
 channel.eventsSubscribedMap.folder_viewed boolean

收件人打开信封时触发。
带符号的信封
 channel.eventsSubscribedMap.folder_signed boolean

收件人签名信封时触发。
信封已取消
 channel.eventsSubscribedMap.folder_cancelled boolean

取消信封时触发。
已执行的信封
 channel.eventsSubscribedMap.folder_executed boolean

当各方已签名并完全执行信封时触发。
信封已删除
 channel.eventsSubscribedMap.folder_deleted boolean

删除信封时触发。

获取信封 ID

操作 ID:
GetEnvelopeIds

返回按状态筛选的信封 ID 列表。 使用此方法可查找处于特定状态的信封。

参数

名称 密钥 必需 类型 说明
日期日期
 dateFrom True string

信封创建日期范围的开始。 接受的格式：YYYY-MM-DD。
日期到
 dateTo True string

信封创建日期范围的结束。 接受的格式：YYYY-MM-DD。 dateTo 值必须在 dateFrom 值的 6 个月内。
地位
 status string

按状态筛选信封。 接受的值：EXECUTED、SHARED、DRAFT、部分签名、已取消、已过期、已删除。 如果省略，则返回任何状态的信封。

返回

名称 路径 类型 说明
Result
 result string

指示请求是否成功。
Message
 message string

一条摘要消息，指示返回了多少个信封 ID。
信封 ID
 allFolderIds array of integer

符合筛选条件的信封 ID 列表。 将这些 ID 与获取信封详细信息一起使用，以检索完整的信封信息。

获取信封活动历史记录

操作 ID:
GetEnvelopeActivityHistory

检索信封的完整活动日志，其中显示了收件人和发件人执行的所有操作。

参数

名称 密钥 必需 类型 说明
信封 ID
 folderId True integer

要检索其活动历史记录的信封的唯一标识符。

返回

名称 路径 类型 说明
Result
 result string

指示请求是否成功。
信封 ID
 details.folderId integer

信封的唯一标识符。
封闭文档
 details.enclosedDocuments string

包含在信封中的文档的名称。
收件人
 details.envelopeRecipients string

信封上所有收件人的姓名。
作者
 details.author string

创建信封的用户的名称。
地位
 details.status string

信封的当前状态（例如，SHARED、EXECUTED、CANCELLED）。
最新活动日期
 details.latestActivityDate string

信封上最近活动的日期和时间。
创建日期
 details.dateCreated string

创建信封的日期和时间。
已发送日期
 details.dateSent string

信封发送给收件人的日期和时间。
Activities
 details.activities array of object

此信封上执行的所有操作的时间顺序列表。
Activity
 details.activities.activity string

对所发生的操作的人工可读说明。
Action
 details.activities.action string

执行的操作类型（例如已创建、邀请发送、已打开、已查看、已签名）。
User
 details.activities.user string

执行操作的用户的名称。
信封状态
 details.activities.folderStatus string

此操作发生时信封的状态。
Time
 details.activities.time string

操作发生的日期和时间。
来源
 details.activities.source string

执行操作的源（例如 Web）。
IP 地址
 details.activities.ipAddress string

执行操作的 IP 地址（如果可用）。

获取信封详细信息

操作 ID:
GetEnvelopeDetails

检索信封的完整详细信息，包括其状态、收件人和文档。

参数

名称 密钥 必需 类型 说明
信封 ID
 folderId True integer

要检索的信封的唯一标识符。
访问令牌
 access_token string

用于身份验证的 OAuth 2.0 访问令牌。

返回

名称 路径 类型 说明
Result
 result string

指示操作是否成功（例如“success”）。
ID
 folder.folderId integer

信封的唯一 ID。
Name
 folder.folderName string

信封的名称。
作者 ID
 folder.folderAuthorId integer

创建信封的用户的唯一 ID。
作者名字
 folder.folderAuthorFirstName string

信封创建者的名字。
作者姓氏
 folder.folderAuthorLastName string

信封创建者的姓氏。
创作Email
 folder.folderAuthorEmail string

信封创建者的电子邮件地址。
作者角色
 folder.folderAuthorRole string

信封创建者的帐户角色。
公司 ID
 folder.folderCompanyId integer

信封所属公司的唯一 ID。
创建日期
 folder.folderCreationDate integer

创建信封的日期和时间（以 Unix 毫秒为单位）。
发送日期
 folder.folderSentDate integer

信封发送到收件人的日期和时间（以 Unix 毫秒为单位）。 如果尚未发送，则为 Null。
地位
 folder.folderStatus string

信封的当前状态（例如，SHARED、EXECUTED、DRAFT、CANCELLED）。
文档 ID
 folder.folderDocumentIds array of integer

此信封中包含的文档 ID 列表。
文档
 folder.documentsList array of object

信封中包含的每个文档的详细信息。
文档编号
 folder.documentsList.documentId integer

文档的唯一标识符。
合同 ID
 folder.documentsList.contractId integer

与此文档关联的协定的唯一标识符。
公司 ID
 folder.documentsList.companyId integer

本文档所属的公司的唯一 ID。
创建者
 folder.documentsList.contractCreatedBy integer

创建合同的人员的用户 ID。
创建日期
 folder.documentsList.contractCreatedOn integer

协定的创建日期（以 Unix 毫秒为单位）。
协定类型
 folder.documentsList.contractType string

协定的类型或类别。
文档状态
 folder.documentsList.contractStatus string

文档的当前签名状态（例如，WAITING_FOR_SIGNATURE，EXECUTED）。
可编辑
 folder.documentsList.editable boolean

指示是否可以编辑文档。
版本标识
 folder.documentsList.contractVersionId integer

当前文档版本的唯一 ID。
版本名称
 folder.documentsList.contractVersionName string

当前文档版本的名称。
版本说明
 folder.documentsList.contractVersionDesc string

当前文档版本的说明。
创建者版本
 folder.documentsList.versionCreatedby integer

创建此文档版本的人员的用户 ID。
创建的版本
 folder.documentsList.versionCreatedOn integer

此文档版本的创建日期（以 Unix 毫秒为单位）。
版本号
 folder.documentsList.contractVersionNumber integer

文档的版本号。
收件人
 folder.folderRecipientParties array of object

此信封的收件人列表，包括其签名状态和访问链接。
收件人 ID
 folder.folderRecipientParties.partyId integer

收件人的唯一标识符。
收件人 ID
 folder.folderRecipientParties.partyDetails.partyId integer

收件人的唯一标识符。
名字
 folder.folderRecipientParties.partyDetails.firstName string

收件人的名字。
姓氏
 folder.folderRecipientParties.partyDetails.lastName string

收件人的姓氏。
Email
 folder.folderRecipientParties.partyDetails.emailId string

收件人的电子邮件地址。
地址
 folder.folderRecipientParties.partyDetails.address string

收件人的地址。
帐户创建日期
 folder.folderRecipientParties.partyDetails.dateCreated integer

收件人帐户的创建日期（以 Unix 毫秒为单位）。
权限
 folder.folderRecipientParties.contractPermissions string

授予此收件人的签名权限（例如，FILL_FIELDS_AND_SIGN）。
签名顺序
 folder.folderRecipientParties.partySequence integer

此收件人在签名顺序中的位置。
工作流序列
 folder.folderRecipientParties.workflowSignSequence integer

此收件人的工作流签名序列号。
信封 ID
 folder.folderRecipientParties.envelopeId integer

此收件人所属的信封的 ID。
共享模式
 folder.folderRecipientParties.sharingMode string

用于与此收件人共享文档的方法（例如电子邮件）。
签名 URL
 folder.folderRecipientParties.folderAccessURL string

此收件人的唯一签名 URL。 如果信封已完成或取消，则为 Null。
安全模式
 folder.folderRecipientParties.securityMode string

应用于此收件人访问权限的安全模式。
额外批注
 folder.folderRecipientParties.extraComments string

此收件人的签名邀请中包含的任何其他注释。
创作访问 URL
 folder.folderAccessURLForAuthor string

信封作者访问文档的 URL。 如果不适用，则为 Null。
批量 ID
 folder.bulkId integer

此信封所属的批量发送批处理的 ID（如果有）。
强制实施签名顺序
 folder.enforceSignWorkflow boolean

指示收件人是否必须按指定顺序登录。
当前工作流步骤
 folder.currentWorkflowStep integer

签名工作流中的当前步骤。
事务源
 folder.transactionSource string

发起此信封事务的源。
可编辑
 folder.editable boolean

指示信封是否仍可编辑。
In-Person 签名
 folder.inPersonSignable boolean

指示是否可以亲自登录信封。
替代提醒
 folder.overrideAccountReminders boolean

指示是否为此信封重写帐户级提醒设置。
ID
 folder.envelopeId integer

信封的唯一 ID。 与信封 ID 相同的值（folderId）。
Name
 folder.envelopeName string

信封的名称。 与信封名称（folderName）相同的值。
发起方 ID
 folder.envelopeOriginatorId integer

创建信封的人员的用户 ID。
公司 ID
 folder.envelopeCompanyId integer

信封所属的公司 ID。
日期
 folder.envelopeDate integer

创建信封的日期和时间（以 Unix 毫秒为单位）。
共享日期
 folder.envelopeSharedDate integer

信封与收件人共享的日期和时间（以 Unix 毫秒为单位）。 如果尚未共享，则为 Null。
地位
 folder.envelopeStatus string

信封的当前状态。 与信封状态（folderStatus）的值相同。
合同 ID
 folder.envelopeContractIds array of integer

与此信封关联的合同 ID 列表。
参与方权限
 folder.envelopePartyPermissions array of object

收件人及其签名权限的列表。 与收件人相同的结构。
收件人 ID
 folder.envelopePartyPermissions.partyId integer

收件人的唯一标识符。
名字
 folder.envelopePartyPermissions.partyDetails.firstName string

收件人的名字。
姓氏
 folder.envelopePartyPermissions.partyDetails.lastName string

收件人的姓氏。
Email
 folder.envelopePartyPermissions.partyDetails.emailId string

收件人的电子邮件地址。
权限
 folder.envelopePartyPermissions.contractPermissions string

此收件人的签名权限。
签名顺序
 folder.envelopePartyPermissions.partySequence integer

此收件人在签名顺序中的位置。
签名 URL
 folder.envelopePartyPermissions.folderAccessURL string

此收件人的唯一签名 URL。
所有字段
 allFields array of object

放置在信封文档中的所有签名和表单字段的列表。
字段 ID
 allFields.fieldTagId integer

字段的唯一标识符。
文档编号
 allFields.contractId integer

此字段所属的文档的 ID。
版本标识
 allFields.versionId integer

此字段所属的文档的版本 ID。
字段类型
 allFields.fieldType string

字段的类型（例如，signfield、textfield、datefield、checkboxfield、下拉列表字段、initialfield）。
页码
 allFields.documentPageNumber integer

放置此字段的页码。
字段文档 ID
 allFields.docFieldId string

此字段的文档级标识符。
责任方
 allFields.partyResponsible integer

负责填写此字段的群 ID。
依赖
 allFields.dependent boolean

指示此字段的可见性是否取决于另一个字段的值。
必需
 allFields.required boolean

指示在提交文档之前是否必须填写此字段。
字段值
 allFields.value string

字段的当前值（如果已填充）。
字段值
 allFieldsNameValue array of object

所有字段名称及其当前值的简化列表。 使用此字段从带符号信封读取已填充的字段数据。
字段 ID
 allFieldsNameValue.fieldId integer

字段的唯一标识符。
文档编号
 allFieldsNameValue.documentId integer

此字段所属的文档的 ID。
版本标识
 allFieldsNameValue.documentVersionId integer

此字段所属的文档的版本 ID。
字段类型
 allFieldsNameValue.fieldType string

字段的类型（例如，textfield、signfield、datefield、checkboxfield、下拉列表字段）。
字段名称
 allFieldsNameValue.name string

模板中定义的字段的标签或名称。
字段值
 allFieldsNameValue.value string

为此字段输入或选择的值。
信封历史记录
 Folder History array of object

按时间顺序对此信封执行的所有操作的审核线索。
名字
 Folder History.firstName string

执行操作的人员的名字。
姓氏
 Folder History.lastName string

执行操作的人员的姓氏。
Email
 Folder History.email string

执行操作的人员的电子邮件地址。
信封 ID
 Folder History.envelopeId integer

对其执行操作的信封的 ID。
日期
 Folder History.dateChanged integer

操作发生的日期和时间（以 Unix 毫秒为单位）。
当事方 ID
 Folder History.changeDoneByParty integer

执行操作的人员的群 ID。
Action
 Folder History.action string

对信封执行的操作（例如，Created、InviteSentTo、InviteAccepted、Signed、Executed）。

获取已删除的信封历史记录

操作 ID:
GetDeletedEnvelopeHistory

检索已删除或移动到回收站的信封的历史记录。

参数

名称 密钥 必需 类型 说明
信封 ID
 folderId True string

要检索其删除历史记录的信封的唯一标识符。

返回

名称 路径 类型 说明
Result
 result string

指示请求是否成功。
已删除的信封信息
 Deleted Folder Log Info array of object

有关已删除信封的摘要信息。
信封 ID
 Deleted Folder Log Info.folderId integer

已删除信封的唯一标识符。
信封名称
 Deleted Folder Log Info.folderName string

已删除信封的名称。
文档名称
 Deleted Folder Log Info.documentName string

已删除信封中文档的名称。
文档编号
 Deleted Folder Log Info.documentId string

已删除信封中文档的唯一标识符。
删除日期
 Deleted Folder Log Info.deletionDate integer

删除信封的日期和时间（以 Unix 毫秒为单位）。
删除者
 Deleted Folder Log Info.deletedBy string

删除信封的用户的名称。
删除日志历史记录
 Deleted Folder Log History array of object

信封上执行的所有删除操作的分步日志。
执行者
 Deleted Folder Log History.partiesName string

执行删除步骤的用户的名称。
来源
 Deleted Folder Log History.source string

从中启动删除的源（例如 Web、API）。
事件 / 活动
 Deleted Folder Log History.event string

执行的特定删除操作（例如，删除文件夹，从文件夹中删除所有参与方）。

获取所有模板的列表

操作 ID:
GetalistofallTemplates

返回帐户中可用的所有模板的列表。

返回

名称 路径 类型 说明
Result
 result string

指示请求是否成功。
模板总数
 total_templates integer

帐户中的模板总数。
模板列表
 templatesList array of object

帐户中可用的所有模板的列表。
模板编号
 templatesList.templateId integer

模板的唯一标识符。 将此 ID 与“从模板创建信封”一起使用，以发送用于签名的模板。
模板名称
 templatesList.templateName string

模板的名称。
模板说明
 templatesList.templateDesc string

模板的说明。
模板类型
 templatesList.templateType string

模板的类型或类别。
创建日期
 templatesList.templateCreationDate integer

模板的创建日期（以 Unix 毫秒为单位）。
上次更新时间
 templatesList.templateLastUpdateDate integer

上次更新模板的日期（以 Unix 毫秒为单位）。
可编辑
 templatesList.editable boolean

指示是否可以编辑模板。
参与方数
 templatesList.numberOfParties integer

模板中定义的签名方数。
公司 ID
 templatesList.companyId integer

模板所属的公司帐户。
与所有共享
 templatesList.shareAll boolean

指示模板是否与帐户中的所有用户共享。
当事方 ID
 templatesList.templateCreatedBy.partyId integer

用户的唯一标识符。
名字
 templatesList.templateCreatedBy.firstName string

用户的名字。
姓氏
 templatesList.templateCreatedBy.lastName string

用户的姓氏。
Email
 templatesList.templateCreatedBy.emailId string

用户的电子邮件地址。
当事方 ID
 templatesList.templateLastUpdatedBy.partyId integer

用户的唯一标识符。
名字
 templatesList.templateLastUpdatedBy.firstName string

用户的名字。
姓氏
 templatesList.templateLastUpdatedBy.lastName string

用户的姓氏。
Email
 templatesList.templateLastUpdatedBy.emailId string

用户的电子邮件地址。

获取模板详细信息

操作 ID:
GetTemplateDetails

检索特定模板的完整详细信息，包括其字段和收件人。

参数

名称 密钥 必需 类型 说明
模板编号
 templateId True string

要检索的模板的唯一标识符。

返回

名称 路径 类型 说明
Result
 result string

指示请求是否成功。
ID
 template.templateId integer

模板的唯一标识符。
Name
 template.templateName string

模板的名称。
Description
 template.templateDesc string

模板的说明。
类型
 template.templateType string

模板的类型。
创建日期
 template.templateCreationDate integer

模板的创建日期（以 Unix 毫秒为单位）。
上次更新时间
 template.templateLastUpdateDate integer

上次更新模板的日期（以 Unix 毫秒为单位）。
可编辑
 template.editable boolean

指示是否可以编辑模板。
参与方数
 template.numberOfParties integer

模板中定义的签名方数。
总页数
 template.totalPages integer

模板文档中的总页数。
公司 ID
 template.companyId integer

模板所属的公司帐户。
与所有共享
 template.shareAll boolean

指示模板是否与帐户中的所有用户共享。
自定义名称模式
 template.templateCustomName string

应用于从此模板创建的信封的自定义名称模式。
参与方权限
 template.templatePartyPermissions array of object

在此模板中定义的收件人角色及其签名权限的列表。
当事方 ID
 template.templatePartyPermissions.template_party_id integer

此模板参与方条目的唯一 ID。
ID
 template.templatePartyPermissions.templateId integer

此方所属的模板的 ID。
权限
 template.templatePartyPermissions.templatePermissions string

此方（例如FILL_FIELDS_AND_SIGN）的签名权限。
签名顺序
 template.templatePartyPermissions.partySequence integer

此方的签名顺序位置。
群角色
 template.templatePartyPermissions.templatePartyRole string

分配给此方的角色名称。 从此模板创建信封时，请使用此值。
当事方 ID
 template.templatePartyPermissions.partyId integer

分配给此角色的参与方的 ID（如果已预先分配）。
当事方 ID
 template.templateCreatedBy.partyId integer

用户的唯一标识符。
名字
 template.templateCreatedBy.firstName string

用户的名字。
姓氏
 template.templateCreatedBy.lastName string

用户的姓氏。
Email
 template.templateCreatedBy.emailId string

用户的电子邮件地址。
Department
 template.templateCreatedBy.department string

用户的部门。
Title
 template.templateCreatedBy.title string

用户的职务。
积极
 template.templateCreatedBy.active boolean

指示用户帐户是否处于活动状态。
当事方 ID
 template.templateLastUpdatedBy.partyId integer

用户的唯一标识符。
名字
 template.templateLastUpdatedBy.firstName string

用户的名字。
姓氏
 template.templateLastUpdatedBy.lastName string

用户的姓氏。
Email
 template.templateLastUpdatedBy.emailId string

用户的电子邮件地址。
Department
 template.templateLastUpdatedBy.department string

用户的部门。
Title
 template.templateLastUpdatedBy.title string

用户的职务。
积极
 template.templateLastUpdatedBy.active boolean

指示用户帐户是否处于活动状态。
所有字段
 allfields array of object

此模板中定义的所有字段的列表。
字段标记 ID
 allfields.fieldTagId integer

字段的唯一标识符。
模板编号
 allfields.templateId integer

此字段所属的模板的 ID。
公司 ID
 allfields.companyId integer

此字段所属的公司帐户。
字段类型
 allfields.fieldType string

字段的类型（例如，signfield、initialfield、textfield、datefield、checkboxfield、securedfield、attachmentfield）。
页码
 allfields.documentPageNumber integer

放置此字段的文档的页码。
负责方
 allfields.partyResponsible integer

负责完成此字段的参与方序列号。
Party 序列
 allfields.partyResponsibleSequence integer

责任方的序列位置。
文档字段 ID
 allfields.docFieldId string

文档中此字段的标识符。
依赖
 allfields.dependent boolean

指示此字段的可见性是否取决于另一个字段的值。
Tab 键顺序
 allfields.tabOrder integer

用于在字段之间导航的 Tab 键顺序。
必需
 allfields.required boolean

指示是否必须先完成此字段，然后才能对文档进行签名。
自定义字段名称
 allfields.customFieldName string

分配给此字段的自定义名称。
全部共享
 allfields.shareAll boolean

指示此字段是否与所有用户共享。
允许编辑
 allfields.allowEdit boolean

指示收件人是否可以编辑此字段。
文本字段名称
 allfields.textfieldName string

文本字段的标签（在 fieldType 为“textfield”时适用）。
Value
 allfields.value string

字段的预填充或输入值。
字体大小
 allfields.fontSize integer

用于此字段中文本的字号。
字体颜色
 allfields.fontColor string

此字段中用于文本的字体颜色（例如 #0000000）。
只读
 allfields.readOnly boolean

指示该字段是否为只读字段，并且不能由收件人编辑。
多行
 allfields.multiLine boolean

指示文本字段是否接受多行输入（在 fieldType 为“textfield”时适用）。
字符限制
 allfields.characterLimit integer

字段中允许的最大字符数（在 fieldType 为“textfield”时适用）。
日期字段名称
 allfields.datefieldName string

日期字段的标签（在 fieldType 为“datefield”时适用）。
日期格式
 allfields.dateFormat string

此字段使用的日期格式（例如 MM/DD/YYYY）（适用于 fieldType 为“datefield”时）。
复选框名称
 allfields.cbname string

复选框字段的标签（在 fieldType 为“checkboxfield”时适用）。
复选框组
 allfields.cbgroup string

此复选框的组名称，在链接多个复选框时使用（适用于 fieldType 为“checkboxfield”）。
已选中
 allfields.checked boolean

指示复选框是否默认选中（适用于 fieldType 为“checkboxfield”时）。
受保护的字段名称
 allfields.securedfieldName string

受保护字段的标签（在 fieldType 为“securedfield”时适用）。
要显示的字符
 allfields.charToDisplay integer

要在安全字段值末尾显示的未屏蔽字符数（适用于 fieldType 为“securedfield”时）。
签名 ID
 allfields.signatureId string

应用于此签名字段的签名的 ID（适用于 fieldType 为“signfield”时）。
初始图像
 allfields.initialImage string

应用于此字段的首字母缩写的图像数据（适用于 fieldType 为“initialfield”时）。
附件字段名称
 allfields.attachmentfieldName string

附件字段的名称（在 fieldType 为“attachmentfield”时适用）。
附件说明
 allfields.attachmentfieldDescription string

说明要附加的内容（在 fieldType 为“attachmentfield”时适用）。

获取电子邮件组详细信息

操作 ID:
GetEmailGroupDetails

检索现有电子邮件组的详细信息。

参数

名称 密钥 必需 类型 说明
电子邮件组名称
 emailGroupNames True array of string

用于标识组的电子邮件组名称数组。

返回

名称 路径 类型 说明
电子邮件组
 allEmailGroups array of object

与请求的组名称匹配的电子邮件组列表。
群组标识符
 allEmailGroups.groupId integer

电子邮件组的唯一标识符。
组名称
 allEmailGroups.groupName string

电子邮件组的名称。
组说明
 allEmailGroups.groupDesc string

电子邮件组的说明。
创建日期
 allEmailGroups.dateCreated integer

电子邮件组的创建日期（以 Unix 毫秒为单位）。
公司 ID
 allEmailGroups.companyId integer

此电子邮件组所属的公司帐户。
Parties
 allEmailGroups.parties array of object

此电子邮件组中的收件人列表。
名字
 allEmailGroups.parties.firstName string

收件人的名字。
姓氏
 allEmailGroups.parties.lastName string

收件人的姓氏。
Email
 allEmailGroups.parties.emailId string

收件人的电子邮件地址。

触发器

删除信封时

删除信封时触发。
发送信封时

将信封发送到收件人时触发。 仅当 Webhook 级别设置为“帐户”时，才会触发此事件。
取消信封时

当收件人或发件人取消信封时触发。
完全执行信封时

当所有收件人都已签名并完全执行信封时触发。
查看信封时

收件人打开并查看信封时触发。
签名信封时

收件人签署信封时触发。

删除信封时

操作 ID:
TriggerEnvelopeDeleted

删除信封时触发。

参数

名称 密钥 必需 类型 说明
通道名称
 channelName True string

用于在帐户中标识此 Webhook 订阅的名称。
Webhook 级别
 webhookLevel True string

帐户：针对所有信封（Web 和 API）触发。 API 应用：仅针对通过 API 创建的信封触发。
Webhook 机密
 webhookSecret string

Optional. Foxit eSign 使用此机密验证 HMAC-SHA-256 对每个 Webhook 有效负载进行签名。

返回

当 Webhook 事件触发时，从 Foxit eSign 接收的事件数据。

WebhookEventPayload
WebhookEventPayload

发送信封时

操作 ID:
TriggerEnvelopeSent

将信封发送到收件人时触发。 仅当 Webhook 级别设置为“帐户”时，才会触发此事件。

参数

名称 密钥 必需 类型 说明
通道名称
 channelName True string

用于在帐户中标识此 Webhook 订阅的名称。
Webhook 级别
 webhookLevel True string

帐户：通过 Web 或 API 发送的信封触发。 API 应用：仅针对通过 API 创建的信封触发。 folder_sent事件仅在帐户级别触发。
Webhook 机密
 webhookSecret string

Optional. Foxit eSign 使用此机密验证 HMAC-SHA-256 对每个 Webhook 有效负载进行签名。

返回

当 Webhook 事件触发时，从 Foxit eSign 接收的事件数据。

WebhookEventPayload
WebhookEventPayload

取消信封时

操作 ID:
TriggerEnvelopeCancelled

当收件人或发件人取消信封时触发。

参数

名称 密钥 必需 类型 说明
通道名称
 channelName True string

用于在帐户中标识此 Webhook 订阅的名称。
Webhook 级别
 webhookLevel True string

帐户：针对所有信封（Web 和 API）触发。 API 应用：仅针对通过 API 创建的信封触发。
Webhook 机密
 webhookSecret string

Optional. Foxit eSign 使用此机密验证 HMAC-SHA-256 对每个 Webhook 有效负载进行签名。

返回

当 Webhook 事件触发时，从 Foxit eSign 接收的事件数据。

WebhookEventPayload
WebhookEventPayload

完全执行信封时

操作 ID:
TriggerEnvelopeExecuted

当所有收件人都已签名并完全执行信封时触发。

参数

名称 密钥 必需 类型 说明
通道名称
 channelName True string

用于在帐户中标识此 Webhook 订阅的名称。
Webhook 级别
 webhookLevel True string

帐户：针对所有信封（Web 和 API）触发。 API 应用：仅针对通过 API 创建的信封触发。
Webhook 机密
 webhookSecret string

Optional. Foxit eSign 使用此机密验证 HMAC-SHA-256 对每个 Webhook 有效负载进行签名。

返回

当 Webhook 事件触发时，从 Foxit eSign 接收的事件数据。

WebhookEventPayload
WebhookEventPayload

查看信封时

操作 ID:
TriggerEnvelopeViewed

收件人打开并查看信封时触发。

参数

名称 密钥 必需 类型 说明
通道名称
 channelName True string

用于在帐户中标识此 Webhook 订阅的名称。
Webhook 级别
 webhookLevel True string

帐户：针对所有信封（Web 和 API）触发。 API 应用：仅针对通过 API 创建的信封触发。
Webhook 机密
 webhookSecret string

Optional. Foxit eSign 使用此机密验证 HMAC-SHA-256 对每个 Webhook 有效负载进行签名。

返回

当 Webhook 事件触发时，从 Foxit eSign 接收的事件数据。

WebhookEventPayload
WebhookEventPayload

签名信封时

操作 ID:
TriggerEnvelopeSigned

收件人签署信封时触发。

参数

名称 密钥 必需 类型 说明
通道名称
 channelName True string

用于在帐户中标识此 Webhook 订阅的名称。
Webhook 级别
 webhookLevel True string

帐户：针对所有信封（Web 和 API）触发。 API 应用：仅针对通过 API 创建的信封触发。
Webhook 机密
 webhookSecret string

Optional. Foxit eSign 使用此机密验证 HMAC-SHA-256 对每个 Webhook 有效负载进行签名。

返回

当 Webhook 事件触发时，从 Foxit eSign 接收的事件数据。

WebhookEventPayload
WebhookEventPayload

定义

WebhookEventPayload

当 Webhook 事件触发时，从 Foxit eSign 接收的事件数据。

名称 路径 类型 说明
事件名称
 event_name string

触发的事件的名称（例如，folder_sent、folder_signed、folder_executed）。
事件日期
 event_date integer

事件发生的日期和时间（Unix 时间戳（以毫秒为单位）。
ID
 data.folder.folderId integer

信封的唯一 ID。
Name
 data.folder.folderName string

信封的名称。
自定义名称
 data.folder.folderCustomName string

分配给信封的自定义名称。
密码
 data.folder.folderPassword string

信封的访问密码（如果已设置）。
创建者 ID
 data.folder.folderAuthorId integer

信封创建者的用户 ID。
Creator 名字
 data.folder.folderAuthorFirstName string

信封创建者的名字。
Creator 姓氏
 data.folder.folderAuthorLastName string

信封创建者的姓氏。
创建者电子邮件
 data.folder.folderAuthorEmail string

信封创建者的电子邮件地址。
创建者角色
 data.folder.folderAuthorRole string

信封创建者的帐户角色。
公司 ID
 data.folder.folderCompanyId integer

拥有信封的公司 ID。
创建日期
 data.folder.folderCreationDate integer

创建信封的日期（Unix 时间戳（以毫秒为单位）。
发送日期
 data.folder.folderSentDate integer

发送信封的日期（Unix 时间戳（以毫秒为单位）。
地位
 data.folder.folderStatus string

信封的当前状态。
自定义字段 1
 data.folder.custom_field1 string

第一个自定义元数据字段。
自定义域 2
 data.folder.custom_field2 string

第二个自定义元数据字段。
Metadata
 data.folder.metadata string

与信封关联的自定义元数据。
文档 ID
 data.folder.folderDocumentIds array of integer

信封中的文档 ID 列表。
文档
 data.folder.documentsList array of object

信封中的文档列表。
文档编号
 data.folder.documentsList.documentId integer

文档的唯一标识符。
合同 ID
 data.folder.documentsList.contractId integer

本文档的协定 ID。
公司 ID
 data.folder.documentsList.companyId integer

本文档的公司 ID。
创建者
 data.folder.documentsList.contractCreatedBy integer

创建合同的人员的用户 ID。
创建日期
 data.folder.documentsList.contractCreatedOn integer

协定的创建日期（Unix 时间戳（以毫秒为单位）。
协定类型
 data.folder.documentsList.contractType string

协定的类型。
合同状态
 data.folder.documentsList.contractStatus string

合同的当前状态。
可编辑
 data.folder.documentsList.editable boolean

指示文档是否可编辑。
版本标识
 data.folder.documentsList.contractVersionId integer

协定的版本 ID。
版本名称
 data.folder.documentsList.contractVersionName string

协定版本的名称。
版本说明
 data.folder.documentsList.contractVersionDesc string

协定版本的说明。
创建者版本
 data.folder.documentsList.versionCreatedby integer

创建此版本的人员的用户 ID。
创建的版本
 data.folder.documentsList.versionCreatedOn integer

创建此版本的日期（Unix 时间戳（以毫秒为单位）。
版本号
 data.folder.documentsList.contractVersionNumber integer

协定的版本号。
事务源
 data.folder.documentsList.contractTransactionSource string

启动协定的源系统。
收件人
 data.folder.folderRecipientParties array of object

此信封的收件人列表。
收件人 ID
 data.folder.folderRecipientParties.partyId integer

收件人的唯一标识符。
收件人 ID
 data.folder.folderRecipientParties.partyDetails.partyId integer

收件人的唯一 ID。
名字
 data.folder.folderRecipientParties.partyDetails.firstName string

收件人的名字。
姓氏
 data.folder.folderRecipientParties.partyDetails.lastName string

收件人的姓氏。
Email
 data.folder.folderRecipientParties.partyDetails.emailId string

收件人的电子邮件地址。
占位符
 data.folder.folderRecipientParties.partyDetails.placeholder boolean

这是否是占位符收件人。
地址
 data.folder.folderRecipientParties.partyDetails.address string

收件人的地址。
创建日期
 data.folder.folderRecipientParties.partyDetails.dateCreated integer

创建收件人记录的日期（Unix 时间戳（以毫秒为单位）。
选择退出电子邮件
 data.folder.folderRecipientParties.partyDetails.optOutEmails boolean

收件人是否选择退出电子邮件。
唯一标识符
 data.folder.folderRecipientParties.partyDetails.uniquePartyId string

此收件人的唯一系统标识符。
身份验证级别
 data.folder.folderRecipientParties.partyDetails.authenticationLevel string

此收件人的身份验证方法。
密码更新日期
 data.folder.folderRecipientParties.partyDetails.passwordUpdateDate string

上次更新密码的日期。
密码状态
 data.folder.folderRecipientParties.partyDetails.passwordUpdateStatus boolean

密码是否已更新。
拨号代码
 data.folder.folderRecipientParties.dialingCode string

国际拨号代码。
Mobile
 data.folder.folderRecipientParties.mobileNumber string

收件人的手机号码。
签名类型
 data.folder.folderRecipientParties.signerSignatureType string

签名者将使用的签名类型。
权限
 data.folder.folderRecipientParties.contractPermissions string

授予此收件人的权限。
签名顺序
 data.folder.folderRecipientParties.partySequence integer

此收件人的签名顺序。
工作流序列
 data.folder.folderRecipientParties.workflowSignSequence integer

工作流签名序列号。
信封 ID
 data.folder.folderRecipientParties.envelopeId integer

与此收件人关联的信封 ID。
收件人公司 ID
 data.folder.folderRecipientParties.partyCompanyId integer

此收件人的公司 ID。
共享模式
 data.folder.folderRecipientParties.sharingMode string

此收件人的共享模式。
收件人签名 URL
 data.folder.folderRecipientParties.folderAccessURL string

此收件人访问和签名信封的 URL。
安全模式
 data.folder.folderRecipientParties.securityMode string

此收件人的安全模式。
注释
 data.folder.folderRecipientParties.extraComments string

收件人的其他注释。
允许名称更改
 data.folder.folderRecipientParties.allowNameChange boolean

收件人是否可以更新其姓名。
已更新的名称
 data.folder.folderRecipientParties.signerNameUpdated boolean

签名者是否已更新其名称。
签名者身份验证级别
 data.folder.folderRecipientParties.signerAuthenticationLevel string

签名者所需的身份验证级别。
访问代码
 data.folder.folderRecipientParties.userDefinedAccessCode string

签名者的自定义访问代码。
签名 ID
 data.folder.folderRecipientParties.signatureId string

应用的签名的 ID。
角色
 data.folder.folderRecipientParties.partyRole string

此收件人在签名工作流中的角色。
公司字段
 data.folder.folderRecipientParties.companyFieldValue string

公司名称字段值。
标题字段
 data.folder.folderRecipientParties.titleFieldValue string

标题字段值。
签名的原因
 data.folder.folderRecipientParties.reasonSigning string

签名的原因。
已添加付款字段
 data.folder.folderRecipientParties.payFieldAdded boolean

是否添加了付款字段。
收款人
 data.folder.folderRecipientParties.payee boolean

此收件人是否为被付款人。
定期付款
 data.folder.folderRecipientParties.recurringFieldExist boolean

是否存在定期付款字段。
打印并签名完成
 data.folder.folderRecipientParties.printAndSignCompleted boolean

打印和签名是否完成。
可选签名者
 data.folder.folderRecipientParties.allowOptionalSigner boolean

此收件人是否为可选签名者。
可选签名者
 data.folder.folderRecipientParties.optionalSigners array of integer

可选的签名方 ID。
支付
 data.folder.folderRecipientParties.paid boolean

付款是否已完成。
创作访问 URL
 data.folder.folderAccessURLForAuthor string

信封作者访问信封的 URL。
草稿访问 URL
 data.folder.draftFolderAccessURL string

用于访问处于草稿状态的信封的 URL。
董事会签名
 data.folder.boardRoomSign boolean

是否启用了板房签名模式。
包括徽标
 data.folder.includeLogo boolean

公司徽标是否包含在电子邮件中。
按钮背景色
 data.folder.email_btnBgColor string

电子邮件操作按钮的背景色。
按钮文本颜色
 data.folder.email_btnTxtColor string

电子邮件操作按钮的文本颜色。
电子邮件徽标
 data.folder.emailTemplateLogo string

电子邮件模板中使用的徽标 URL。
电子邮件模板 ID
 data.folder.emailTemplateId integer

使用的电子邮件模板的 ID。
电子邮件标头
 data.folder.emailHeader string

通知电子邮件中的标题文本。
电子邮件页脚
 data.folder.emailFooter string

通知电子邮件中的页脚文本。
清除计划
 data.folder.purgeFlag boolean

信封是否计划清除。
清除开始日期
 data.folder.purgeStartDate string

清除计划的开始日期。
清除结束日期
 data.folder.purgeEndDate string

清除计划的结束日期。
批量 ID
 data.folder.bulkId integer

大容量发送操作 ID（如果适用）。
强制实施签名顺序
 data.folder.enforceSignWorkflow boolean

收件人是否必须按定义的顺序登录。
当前工作流步骤
 data.folder.currentWorkflowStep integer

签名工作流中的当前步骤。
事务源
 data.folder.transactionSource string

启动此事务的源系统。
可编辑
 data.folder.editable boolean

信封是否可编辑。
In-Person 签名
 data.folder.inPersonSignable boolean

信封是否支持亲自签名。
替代提醒
 data.folder.overrideAccountReminders boolean

是否重写帐户级提醒设置。
替代委派
 data.folder.overrideAccountRecipientDelegation boolean

是否重写帐户级委派设置。
允许委派
 data.folder.allowRecipientsToDelegate boolean

收件人是否可以委托签名。
ID
 data.folder.envelopeId integer

唯一信封 ID （folderId 的别名）。
Name
 data.folder.envelopeName string

信封名称（folderName 的别名）。
发起方 ID
 data.folder.envelopeOriginatorId integer

发起信封的用户 ID。
公司 ID
 data.folder.envelopeCompanyId integer

拥有信封的公司 ID。
日期
 data.folder.envelopeDate integer

创建信封的日期（Unix 时间戳（以毫秒为单位）。
共享日期
 data.folder.envelopeSharedDate integer

信封共享的日期（Unix 时间戳（以毫秒为单位）。
地位
 data.folder.envelopeStatus string

信封的当前状态。
合同 ID
 data.folder.envelopeContractIds array of integer

与此信封关联的协定 ID。
参与方权限
 data.folder.envelopePartyPermissions array of object

收件人权限列表（与收件人相同）。
收件人 ID
 data.folder.envelopePartyPermissions.partyId integer

收件人的唯一标识符。
收件人 ID
 data.folder.envelopePartyPermissions.partyDetails.partyId integer
名字
 data.folder.envelopePartyPermissions.partyDetails.firstName string
姓氏
 data.folder.envelopePartyPermissions.partyDetails.lastName string
Email
 data.folder.envelopePartyPermissions.partyDetails.emailId string
占位符
 data.folder.envelopePartyPermissions.partyDetails.placeholder boolean
地址
 data.folder.envelopePartyPermissions.partyDetails.address string
创建日期
 data.folder.envelopePartyPermissions.partyDetails.dateCreated integer
选择退出电子邮件
 data.folder.envelopePartyPermissions.partyDetails.optOutEmails boolean
唯一标识符
 data.folder.envelopePartyPermissions.partyDetails.uniquePartyId string
身份验证级别
 data.folder.envelopePartyPermissions.partyDetails.authenticationLevel string
密码更新日期
 data.folder.envelopePartyPermissions.partyDetails.passwordUpdateDate string
密码状态
 data.folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus boolean
拨号代码
 data.folder.envelopePartyPermissions.dialingCode string
Mobile
 data.folder.envelopePartyPermissions.mobileNumber string
签名类型
 data.folder.envelopePartyPermissions.signerSignatureType string
权限
 data.folder.envelopePartyPermissions.contractPermissions string
签名顺序
 data.folder.envelopePartyPermissions.partySequence integer
工作流序列
 data.folder.envelopePartyPermissions.workflowSignSequence integer
信封 ID
 data.folder.envelopePartyPermissions.envelopeId integer
收件人公司 ID
 data.folder.envelopePartyPermissions.partyCompanyId integer
共享模式
 data.folder.envelopePartyPermissions.sharingMode string
收件人签名 URL
 data.folder.envelopePartyPermissions.folderAccessURL string
安全模式
 data.folder.envelopePartyPermissions.securityMode string
注释
 data.folder.envelopePartyPermissions.extraComments string
允许名称更改
 data.folder.envelopePartyPermissions.allowNameChange boolean
已更新的名称
 data.folder.envelopePartyPermissions.signerNameUpdated boolean
签名者身份验证级别
 data.folder.envelopePartyPermissions.signerAuthenticationLevel string
访问代码
 data.folder.envelopePartyPermissions.userDefinedAccessCode string
签名 ID
 data.folder.envelopePartyPermissions.signatureId string
角色
 data.folder.envelopePartyPermissions.partyRole string
公司字段
 data.folder.envelopePartyPermissions.companyFieldValue string
标题字段
 data.folder.envelopePartyPermissions.titleFieldValue string
签名的原因
 data.folder.envelopePartyPermissions.reasonSigning string
已添加付款字段
 data.folder.envelopePartyPermissions.payFieldAdded boolean
收款人
 data.folder.envelopePartyPermissions.payee boolean
定期付款
 data.folder.envelopePartyPermissions.recurringFieldExist boolean
打印并签名完成
 data.folder.envelopePartyPermissions.printAndSignCompleted boolean
可选签名者
 data.folder.envelopePartyPermissions.allowOptionalSigner boolean
可选签名者
 data.folder.envelopePartyPermissions.optionalSigners array of integer
支付
 data.folder.envelopePartyPermissions.paid boolean
身份验证级别
 data.folder.envelopeAuthenticationLevel string

信封所需的身份验证级别。
单一签名者批量
 data.folder.allowSingleSignerInBulk boolean

是否允许在批量模式下使用单一签名者。
File-Based 文件夹名称
 data.folder.folderNameBasedOnFileNaming boolean
File-Based 文档名称
 data.folder.documentNameBasedOnFileNaming boolean
File-Based 证书名称
 data.folder.certificateNameBasedOnFileNaming boolean
Pre-Exec 文件命名
 data.folder.enableFileNamingBeforeExecution boolean
已添加付款人
 data.folder.payeeAddedd boolean
已启用 Self-Signing
 data.folder.selfSignerEnabled boolean
Notary Enabled
 data.folder.notaryEnabled boolean
可见性有限
 data.folder.limitedVisibilityFlag boolean
签名后可见性
 data.folder.postSigningVisibility boolean
湿签名
 data.folder.wetSignatureEnabled boolean
已启用合并
 data.folder.mergeEnabled boolean

二进制

这是基本数据类型“binary”。