Docusign
Docusign 使组织能够在整个协议生命周期中创建、提交和管理协议。 客户可以从经营其业务的协议中加速收入、降低风险和解锁价值。
此连接器在以下产品和区域中可用：
| 服务 | Class | 区域 |
|---|---|---|
| Copilot Studio | 标准 | 除以下各项外的所有 Power Automate 区域 ： - 由世纪互联运营的中国云 |
| 逻辑应用程序 | 标准 | 除以下各项外的所有 逻辑应用区域 ： - Azure 中国区域 - 美国国防部（DoD） |
| Power Apps | 标准 | 除以下各项外的所有 Power Apps 区域 ： - 由世纪互联运营的中国云 |
| Power Automate | 标准 | 除以下各项外的所有 Power Automate 区域 ： - 由世纪互联运营的中国云 |
| 联系人 | |
|---|---|
| Name | docusign |
| URL | https://support.docusign.com |
| 连接器元数据 | |
|---|---|
| 发布者 | DocuSign， Inc. |
| Website | https://www.docusign.com |
| 隐私策略 | https://www.docusign.com/company/privacy-policy |
| 类别 | 内容和文件;生产力 |
Title
DocuSign 可帮助组织连接和管理协议的准备、签署、作和管理方式并自动执行这些作。 DocuSign 演示连接器仅连接到 DocuSign 演示环境，但提供与常规 DocuSign 连接器相同的功能。 DocuSign 演示环境中的任何文档都不具有法律约束力。 对于所有非演示用途，请使用常规 DocuSign 连接器。
先决条件
若要在此集成中使用 Connect 触发器，必须在 DocuSign 帐户中启用 DocuSign Connect。 默认情况下，它未启用。 启用后，可以从 DocuSign 管理员 Web 应用程序访问“连接设置”页。 在此集成中使用 Connect 触发器会自动为你注册 Webhook。
获取凭据
若要尝试连接器，请使用演示帐户：
- 转到 https://developers.docusign.com/
- 创建沙盒帐户。
这些与免费试用版不同，因为它们永不过期，我们的付费帐户功能有 90%，而通过 DEMO 发送的文件都没有法律约束力（（https://support.docusign.com/en/articles/Free-account-vs-Developer-account）。
连接器文档
有关连接器的详细文档，请参阅 https://support.docusign.com/en/guides/DocuSign-eSignature-for-Microsoft-Power-Automate
已知问题和限制
有关 DocuSign 的问题，请先尝试此链接： https://support.docusign.com/en/articles/How-Do-I-Open-a-Case-in-the-DocuSign-Support-Center
部署说明
请使用 这些说明 将此连接器部署为 Microsoft Power Automate 和 Power Apps 中的自定义连接器。
限制
| 名称 | 调用 | 续订期 |
|---|---|---|
| 每个连接的 API 调用数 | 250 | 60 秒 |
操作
| Copilot for Sales：列出信封 |
Copilot for Sales：列表信封返回有关 Docusign 协议的信息，如标题、文档、收件人、协议状态、发件人名称和协议 URL。 该插件可以处理请求，例如显示我需要签署的所有协议，或者销售订单合同的状态是什么。 |
| Copilot for Sales：获取关键销售 |
此操作获取将在 Outlook 边栏的 C4S 关键销售信息卡中显示的更多销售见解。 该作增强了合作销售的现有技能 |
| Copilot for Sales：获取电子邮件摘要 |
此操作将获得额外的销售见解，这些见解将在 Outlook 摘要中的 C4S 电子邮件摘要体验中显示。 该操作增强了销售 Copilot 的现有技能。 |
| Copilot：列出信封 |
此作基于信封状态、日期范围、收件人名称、收件人电子邮件地址、信封标题、文档名称或信封自定义字段值返回相关的 Docusign 信封。 输出是标题、说明、信封 ID、文档名称、发件人姓名、信封状态、状态日期、发送日期和信封的 URL，可用作在 Docusign 中查看信封的链接。 |
| Copilot：获取相关活动 |
此操作将获得与 CRM 记录相关的其他销售见解，这些见解将显示在 C4S 记录摘要卡中。 该操作增强了销售 Copilot 的现有技能。 |
| Copilot：获取相关记录 |
此作获取与 CRM 记录相关的记录。 该作增强了 Copilot for Sales 的现有技能。 |
| 为信封添加提醒 |
为信封添加提醒 |
| 从信封中删除收件人 |
从信封中删除收件人 |
| 从信封更新文档生成表单字段 |
从信封更新文档生成表单字段 |
| 从信封获取收件人信息 |
从信封获取收件人信息 |
| 从信封获取收件人选项卡 |
从信封获取收件人选项卡 |
| 从信封获取文档 |
从信封获取文档 |
| 从信封获取文档信息 |
从信封获取文档信息 |
| 从信封获取文档生成表单字段 |
从信封获取文档生成表单字段 |
| 从信封获取文档自定义字段 |
从信封获取文档自定义字段 |
| 从信封获取文档选项卡 |
从信封获取文档选项卡 |
| 从信封获取自定义字段信息 |
从信封获取自定义字段信息 |
| 从模板获取文档选项卡 |
从模板获取文档选项卡 |
| 使用包含收件人和选项卡的模板创建信封 |
使用包含收件人和选项卡的模板创建信封 |
| 使用复合模板创建信封 |
使用复合模板创建信封 |
| 使用模板创建信封 |
使用指定的模板创建新信封。 |
| 使用模板批量发送信封 |
使用模板批量发送信封 |
| 列出信封 |
此作基于信封状态、日期范围、收件人名称、收件人电子邮件地址、信封标题、文档名称或信封自定义字段值返回相关的 Docusign 信封。 输出是标题、说明、信封 ID、文档名称、发件人姓名、信封状态、状态日期、发送日期和信封的 URL，可用作在 Docusign 中查看信封的链接。 |
| 列出信封中的收件人 |
列出信封中的收件人 |
| 列出信封中的文档 |
列出信封中的文档 |
| 列出模板 |
列出特定帐户的模板。 |
| 列出模板中的文档 |
列出模板中的文档 |
| 创建信封 |
创建新的空白信封。 |
| 创建批量发送列表 |
创建批量发送列表 |
| 发送信封 |
发送现有信封。 |
| 取消信封 |
取消信封。 |
| 向信封添加文档 |
将文档添加到信封。 |
| 向收件人添加验证类型 |
向收件人添加验证类型。 |
| 启动 Docusign Maestro 工作流 |
启动 Docusign Maestro 工作流 |
| 在信封上为收件人添加选项卡 |
在信封上为收件人添加选项卡 |
| 将收件人添加到信封（V2） |
将收件人添加到信封。 |
| 将模板应用于文档 |
将模板应用于文档 |
| 已弃用：从信封获取文档 |
从信封获取文档 |
| 已弃用：使用模板创建信封 |
使用指定的模板创建新信封。 |
| 已弃用：使用模板和收件人创建信封 |
使用指定的模板创建新的信封并指定收件人。 |
| 已弃用：将收件人添加到信封 |
将收件人添加到信封。 |
| 显示内部版本号（仅供参考）。请勿包含在执行流中） |
当前部署的内部版本的标识符。 |
| 更新信封上的收件人 |
更新信封上的收件人 |
| 更新信封上的收件人选项卡值 |
更新信封上的收件人选项卡值 |
| 更新信封自定义域 |
更新指定信封自定义域的值 |
| 更新信封预填充选项卡 |
更新预填充选项卡列表的值 |
| 生成嵌入发件人 URL |
生成嵌入发件人 URL |
| 生成嵌入式签名 URL [已弃用] |
生成嵌入式签名 URL |
| 生成嵌入式签名 URL （V2） |
生成嵌入式签名 URL （V2） |
| 登录 |
登录 |
| 获取审核事件列表 |
获取审核事件列表 |
| 获取收件人选项卡的信息 |
返回给定收件人的选项卡的值 |
| 重新发送信封 |
此作会重新发送 Docusign 信封，或向需要根据提供的 EnvelopeId 签署 Docusign 协议的收件人发送提醒。 |
Copilot for Sales：列出信封
Copilot for Sales：列表信封返回有关 Docusign 协议的信息，如标题、文档、收件人、协议状态、发件人名称和协议 URL。 该插件可以处理请求，例如显示我需要签署的所有协议，或者销售订单合同的状态是什么。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
收件人姓名
|
recipientName | string |
此作基于收件人姓名列出信封 |
|
|
Recipient emailId
|
recipientEmailId | string |
此作基于收件人电子邮件 ID 列出信封 |
|
|
信封主题
|
envelopeTitle | string |
此作基于信封的电子邮件主题列出信封 |
|
|
自定义字段名称
|
customFieldName | string |
此作基于其自定义字段的名称列出信封 |
|
|
自定义字段值
|
customFieldValue | string |
此作基于其自定义字段的值列出信封 |
|
|
信封状态
|
envelopeStatus | string |
此作根据信封的状态列出信封 |
|
|
文件夹
|
folder_ids | string |
此作根据信封的各种状态列出信封 |
|
|
订单依据
|
order_by | string |
此作根据特定属性对信封进行排序 |
|
|
Top
|
top | integer |
要返回的顶部信封 |
|
|
跳过
|
skip | integer |
要跳过的信封 |
|
|
开始日期
|
startDateTime | date-time |
输入开始日期时间格式：2017-05-02T01：44Z |
|
|
结束日期
|
endDateTime | date-time |
以格式输入结束日期时间：2017-05-02T01：44Z |
返回
Copilot for Sales：获取关键销售
此操作获取将在 Outlook 边栏的 C4S 关键销售信息卡中显示的更多销售见解。 该作增强了合作销售的现有技能
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
记录类型
|
recordType | True | string |
此输入标识 CRM 中请求密钥销售信息的记录类型。 |
|
记录 ID
|
recordId | True | string |
此输入提供请求关键销售信息的 CRM 记录的唯一标识符。 |
|
开始日期
|
startDateTime | date-time |
输入开始日期时间格式：2017-05-02T01：44Z |
|
|
Top
|
top | integer |
此输入指示要提取的销售亮点数。 |
|
|
跳过
|
skip | integer |
此输入指示提取销售亮点时要跳过的项目数。 |
|
|
CRM 类型
|
crmType | string |
此输入指示 CRM 记录所在的 CRM 类型，请求其关键销售信息。 |
|
|
CRM 组织 URL
|
crmOrgUrl | string |
此输入指示含有 CRM 记录的 CRM 环境的 URL，并且为此记录请求关键销售信息。 |
返回
- Body
- KeySalesResponse
Copilot for Sales：获取电子邮件摘要
此操作将获得额外的销售见解，这些见解将在 Outlook 摘要中的 C4S 电子邮件摘要体验中显示。 该操作增强了销售 Copilot 的现有技能。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
记录类型
|
recordType | string |
此输入标识 CRM 中与汇总电子邮件相关的记录类型。 |
|
|
记录 ID
|
recordId | string |
此输入提供与汇总电子邮件相关的 CRM 记录的唯一标识符。 |
|
|
CRM 类型
|
crmType | string |
此输入指示与汇总电子邮件相关的记录所在的 CRM 类型。 |
|
|
CRM 组织 URL
|
crmOrgUrl | string |
此输入指示与汇总电子邮件相关的记录所在的 CRM 环境的 URL。 |
|
|
逗号分隔的电子邮件地址
|
emailContacts | True | string |
此输入指示当前电子邮件线程中所有相关参与者电子邮件的列表。 |
|
Top
|
top | integer |
此输入指示要提取的见解数量。 |
|
|
跳过
|
skip | integer |
此输入指示提取见解时要跳过的项数。 |
返回
- Body
- EmailSummaryResponse
Copilot：列出信封
此作基于信封状态、日期范围、收件人名称、收件人电子邮件地址、信封标题、文档名称或信封自定义字段值返回相关的 Docusign 信封。 输出是标题、说明、信封 ID、文档名称、发件人姓名、信封状态、状态日期、发送日期和信封的 URL，可用作在 Docusign 中查看信封的链接。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
收件人姓名
|
recipientName | string |
此作基于收件人姓名列出信封 |
|
|
Recipient emailId
|
recipientEmailId | string |
此作基于收件人电子邮件 ID 列出信封 |
|
|
信封主题
|
envelopeTitle | string |
此作基于信封的电子邮件主题列出信封 |
|
|
自定义字段名称
|
customFieldName | string |
此作基于其自定义字段的名称列出信封 |
|
|
自定义字段值
|
customFieldValue | string |
此作基于其自定义字段的值列出信封 |
|
|
信封状态
|
envelopeStatus | string |
此作根据信封的状态列出信封 |
|
|
文件夹
|
folder_ids | string |
此作根据信封的各种状态列出信封 |
|
|
订单依据
|
order_by | string |
此作根据特定属性对信封进行排序 |
|
|
Top
|
top | integer |
要返回的顶部信封 |
|
|
跳过
|
skip | integer |
要跳过的信封 |
|
|
开始日期
|
from_date | date-time |
当用户未提供任何值时输入“'”。 以模式或格式输入开始日期时间：2017-05-02T01：44Z。 |
|
|
结束日期
|
to_date | date-time |
当用户未提供任何值时输入“'”。 以模式或格式输入结束日期时间：2017-05-02T01：44Z。 |
返回
Copilot：获取相关活动
此操作将获得与 CRM 记录相关的其他销售见解，这些见解将显示在 C4S 记录摘要卡中。 该操作增强了销售 Copilot 的现有技能。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
记录类型
|
recordType | True | string |
此输入指示 CRM 中为其请求见解的实体或对象类型。 |
|
记录 ID
|
recordId | True | string |
此输入指示为其请求见解的 CRM 记录的唯一标识符。 |
|
开始日期
|
startDateTime | date-time |
此输入指示请求的见解的开始日期和时间。 |
|
|
结束日期
|
endDateTime | date-time |
此输入指示请求的见解的结束日期和时间。 |
|
|
Top
|
top | integer |
此输入指示要提取的见解数量。 |
|
|
跳过
|
skip | integer |
此输入指示要跳过的见解数量。 |
|
|
CRM 类型
|
crmType | string |
此输入指示为其请求见解的 CRM 记录所在的 CRM 类型。 |
|
|
CRM 组织 URL
|
crmOrgUrl | string |
此输入指示为其请求见解的 CRM 记录所在的 CRM 环境的 URL。 |
返回
Copilot：获取相关记录
此作获取与 CRM 记录相关的记录。 该作增强了 Copilot for Sales 的现有技能。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
记录类型
|
recordType | True | string |
此输入标识 CRM 中请求相关记录的记录类型。 |
|
记录 ID
|
recordId | True | string |
此输入提供请求相关记录的 CRM 记录的唯一标识符。 |
|
开始日期
|
startDateTime | date-time |
输入开始日期时间格式：2017-05-02T01：44Z |
|
|
Top
|
top | integer |
此输入指示要提取的相关记录数。 |
|
|
跳过
|
skip | integer |
此输入指示提取相关记录时要跳过的记录数。 |
|
|
CRM 类型
|
crmType | string |
此输入指示从中提取相关记录的 CRM 类型。 |
|
|
CRM 组织 URL
|
crmOrgUrl | string |
此输入指示从中提取相关记录的 CRM 环境的 URL。 |
返回
为信封添加提醒
为信封添加提醒
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
信封
|
envelopeId | True | string |
信封 ID |
|
已启用提醒
|
reminderEnabled | True | boolean |
设置为 false 时，将禁用提醒。 默认值为 false |
|
提醒延迟
|
reminderDelay | True | string |
添加收件人接收提醒电子邮件的天数。 |
|
提醒频率
|
reminderFrequency | True | string |
添加提醒电子邮件之间的天数。 |
|
过期后
|
expireAfter | string |
在到期前添加天数。 |
返回
- Body
- AddRemindersResponse
从信封中删除收件人
从信封中删除收件人
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
文件夹
|
folderId | True | string |
文件夹 ID |
|
信封
|
envelopeId | True | string |
信封 ID |
|
Recipient
|
RemoveRecipientFromEnvelopeRecipientId | True | string |
收件人 ID |
返回
从信封更新文档生成表单字段
从信封更新文档生成表单字段
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
信封
|
envelopeId | True | string |
信封 ID |
|
文档 GUID
|
documentGuid | True | string |
文档 GUID |
|
类型
|
fieldType | string |
选择要更新的文档生成字段的类型 |
|
|
Name
|
name | string |
输入字段名称或表列名称 |
|
|
价值
|
value | string |
输入字段数据 |
|
|
：表名称
|
tableName | string |
“表行”是必需的。 输入表名称。 |
|
|
：表行
|
rowNumber | string |
“表行”是必需的。 输入行号 |
从信封获取收件人信息
从信封获取收件人信息
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
信封
|
envelopeId | True | string |
信封 ID |
|
收件人电子邮件
|
recipientEmail | string |
收件人电子邮件 |
|
|
区域代码
|
areaCode | string |
收件人的区号 |
|
|
电话号码
|
phoneNumber | string |
收件人的电话号码 |
|
|
收件人 ID
|
recipientId | string |
Recpinet Id |
返回
- Body
- Signer
从信封获取收件人选项卡
从信封获取收件人选项卡
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
信封
|
envelopeId | True | string |
信封 ID |
|
收件人 ID
|
recipientId | True | string |
收件人 ID |
返回
从信封获取文档
从信封获取文档
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
信封
|
envelopeId | True | string |
信封 ID |
|
输出格式
|
documentId | True | string |
提供特定的文档 ID 或使用下拉列表中的输出格式 |
返回
- response
- GetDocumentsResponse
从信封获取文档信息
从信封获取文档信息
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
信封
|
envelopeId | True | string |
信封 ID |
|
文档名称
|
documentName | True | string |
文件扩展名的文件名 |
返回
- Body
- EnvelopeDocument
从信封获取文档生成表单字段
从信封获取文档生成表单字段
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
信封
|
envelopeId | True | string |
信封 ID |
返回
从信封获取文档自定义字段
从信封获取文档自定义字段
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
信封
|
envelopeId | True | string |
信封 ID |
|
文档 ID
|
documentId | True | string |
文档 ID |
返回
从信封获取文档选项卡
从信封获取文档选项卡
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
信封
|
envelopeId | True | string |
信封 ID |
|
文档 ID
|
documentId | True | string |
文档 ID |
返回
- Body
- ListTabsResponse
从信封获取自定义字段信息
从信封获取自定义字段信息
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
信封
|
envelopeId | True | string |
信封 ID |
|
自定义字段名称
|
fieldName | True | string |
自定义字段名称 |
返回
从模板获取文档选项卡
从模板获取文档选项卡
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
Template
|
templateId | True | string |
模板 ID |
|
文档 ID
|
documentId | True | string |
文档 ID |
返回
- Body
- ListTabsResponse
使用包含收件人和选项卡的模板创建信封
使用包含收件人和选项卡的模板创建信封
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
Template
|
templateId | True | string |
模板编号 |
|
收件人
|
recipients | dynamic |
文档的签名者。 |
|
|
电子邮件主题
|
emailSubject | string |
电子邮件主题 |
返回
使用复合模板创建信封
使用复合模板创建信封
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
电子邮件主题
|
emailSubject | True | string |
电子邮件的主题。 |
|
电子邮件正文
|
emailBody | string |
电子邮件正文。 |
|
|
信封状态
|
status | True | string |
信封状态 |
|
身体
|
body | dynamic |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
信封 ID
|
envelopeId | string |
信封的 ID。 |
|
状态
|
status | string |
信封的状态。 |
|
状态日期时间
|
statusDateTime | string |
设置状态的日期/时间。 |
|
URI
|
uri | string |
DocuSign 中信封的 URI。 |
使用模板创建信封
使用指定的模板创建新信封。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
Template
|
templateId | True | string |
模板 ID |
|
信封状态
|
status | True | string |
信封状态 |
返回
使用模板批量发送信封
使用模板批量发送信封
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
批量发送列表 GUID
|
bulkSendListId | True | string |
批量发送列表 GUID |
|
模板编号
|
envelopeOrTemplateId | True | string |
输入模板 ID，或从下拉列表中选择模板 |
返回
- Body
- BulkSendListGuid
列出信封
此作基于信封状态、日期范围、收件人名称、收件人电子邮件地址、信封标题、文档名称或信封自定义字段值返回相关的 Docusign 信封。 输出是标题、说明、信封 ID、文档名称、发件人姓名、信封状态、状态日期、发送日期和信封的 URL，可用作在 Docusign 中查看信封的链接。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
收件人姓名
|
recipientName | string |
此作基于收件人姓名列出信封 |
|
|
收件人电子邮件
|
recipientEmailId | string |
按收件人电子邮件筛选信封 |
|
|
信封主题
|
envelopeTitle | string |
按信封主题筛选信封 |
|
|
自定义字段名称
|
customFieldName | string |
此作基于其自定义字段的名称列出信封 |
|
|
自定义字段值
|
customFieldValue | string |
按自定义字段值筛选 |
|
|
信封状态
|
envelopeStatus | string |
此作根据信封的状态列出信封 |
|
|
文件夹
|
folder_ids | string |
按所选文件夹筛选信封 |
|
|
订单依据
|
order_by | string |
按所选顺序对信封进行排序 |
|
|
返回信封
|
top | integer |
指定要返回的信封数（默认值为 10;最大值为 1,000） |
|
|
跳过信封
|
skip | integer |
指定要从开始跳过的信封数 |
|
|
开始日期
|
from_date | date-time |
输入 UTC 格式的开始日期时间：2017-05-02T01：44z |
|
|
结束日期
|
to_date | date-time |
以 UTC 格式输入结束日期时间：2017-05-02T01：44z。 |
返回
列出信封中的收件人
列出信封中的收件人
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
文件夹
|
folderId | True | string |
文件夹 ID |
|
信封
|
envelopeId | True | string |
信封 ID |
返回
列出信封中的文档
列出信封中的文档
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
信封
|
envelopeId | True | string |
信封 ID |
返回
列出模板
列出模板中的文档
列出模板中的文档
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
Template
|
templateId | True | string |
模板 ID |
返回
创建信封
创建新的空白信封。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
电子邮件主题
|
emailSubject | True | string |
电子邮件的主题。 |
|
电子邮件正文
|
emailBody | string |
电子邮件正文。 |
|
|
自定义字段
|
accountCustomFields | dynamic |
获取在帐户级别设置的自定义字段。 |
返回
创建批量发送列表
创建批量发送列表
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
批量发送列表名称
|
name | True | string |
批量发送列表名称 |
|
CSV 文件
|
csv | string |
上传 CSV 文件 |
返回
- Body
- BulkSendListGuid
发送信封
发送现有信封。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
信封
|
envelopeId | True | string |
信封 ID |
返回
- response
- object
取消信封
取消信封。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
信封
|
envelopeId | True | string |
信封 ID |
|
Void 原因
|
voidedReason | True | string |
无效的原因 |
返回
- response
- object
向信封添加文档
将文档添加到信封。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
信封
|
envelopeId | True | string |
信封 ID |
|
文档 Base64 *
|
documentBase64 | True | string |
文档内容的 Base64 |
|
文档类型 *
|
fileExtension | True | string |
pdf、docx 等。 |
|
文档名称 *
|
name | True | string |
文档名称 |
|
转换 Pdf 字段
|
transformPdfFields | string |
假 |
|
|
向收件人分配选项卡
|
assignTabsToRecipientId | string |
收件人 ID |
返回
- Body
- AddDocumentsResponse
向收件人添加验证类型
向收件人添加验证类型。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
信封
|
envelopeId | True | string |
信封 ID |
|
收件人 ID
|
recipientId | True | string |
收件人 ID |
|
收件人类型
|
recipientType | True | string |
收件人类型 |
|
验证类型
|
verificationType | True | string |
验证类型 |
|
其他收件人数据
|
additionalRecipientData | dynamic |
其他收件人数据。 |
启动 Docusign Maestro 工作流
启动 Docusign Maestro 工作流
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
工作流
|
workflowId | True | string |
输入工作流 ID 或从下拉列表中选择工作流名称 |
|
实例名称
|
instanceName | True | string |
Maestro 工作流实例的名称 |
|
变量
|
variable | dynamic |
返回
TriggerMaestroFlowResponse
- response
- object
在信封上为收件人添加选项卡
在信封上为收件人添加选项卡
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
信封
|
envelopeId | True | string |
信封 ID |
|
Recipient
|
recipientId | True | string |
收件人 ID |
|
Tab 类型
|
tabType | True | string |
Tab 类型 |
|
选项卡详细信息
|
tabDetails | True | dynamic |
所选定位点选项卡的详细信息。 |
返回
将收件人添加到信封（V2）
将收件人添加到信封。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
信封
|
envelopeId | True | string |
信封 ID |
|
收件人类型
|
recipientType | True | string |
收件人类型 |
|
客户端用户 ID
|
clientUserId | string |
嵌入式签名者的客户端用户 ID |
|
|
嵌入式收件人开始 URL
|
embeddedRecipientStartURL | string |
用于重定向嵌入收件人的发件人提供的 URL 字符串。 |
|
|
签名顺序
|
routingOrder | string |
收件人的签名顺序。 |
|
|
电子邮件通知语言
|
emailNotificationLanguage | string |
电子邮件通知的语言。 |
|
|
电子邮件通知主题
|
emailNotificationSubject | string |
电子邮件通知的主题。 |
|
|
电子邮件通知正文
|
emailNotificationBody | string |
电子邮件通知的正文。 |
|
|
注释
|
note | string |
收件人的自定义说明。 |
|
|
角色名称
|
roleName | string |
与收件人关联的角色名称。 |
|
|
SMS 国家/地区代码
|
countryCode | integer |
对于短信通知，国家/地区代码，不带前导 + 符号。 |
|
|
SMS 电话号码
|
phoneNumber | integer |
需要签名者电子邮件或短信电话。 排除电话号码的国家/地区代码。 |
|
|
签名组
|
signingGroupId | string |
签名组 |
|
|
签名类型
|
signatureType | string |
DocuSign 基于标准的签名 （SBS） 类型。 |
|
|
验证工作流
|
workflowId | string |
必须在此处选择具有笔签名类型的 IDV 工作流。 |
|
|
所选收件人类型的详细信息
|
additionalRecipientParams | dynamic |
所选收件人类型的详细信息。 |
返回
- Body
- Signer
将模板应用于文档
将模板应用于文档
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
信封 ID
|
envelopeId | True | string |
信封 ID |
|
Template
|
templateId | True | string |
Template |
|
保留模板收件人
|
preserve_template_recipient | string |
假 |
|
|
文档 ID
|
documentId | True | string |
文档 ID |
|
文档起始页
|
documentStartPage | True | string |
文档起始页 |
|
文档结束页
|
documentEndPage | True | string |
文档结束页 |
已弃用：从信封获取文档
从信封获取文档
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
信封
|
envelopeId | True | string |
信封 ID |
|
完成证书
|
certificate | True | boolean |
如果设置为 false，则会从下载中删除信封签名证书。 |
返回
- response
- GetDocumentsResponse
已弃用：使用模板创建信封
使用指定的模板创建新信封。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
Template
|
templateId | True | string |
模板 ID |
|
信封状态
|
status | True | string |
信封状态 |
|
自定义字段
|
accountCustomFields | True | dynamic |
获取在帐户级别设置的自定义字段。 |
返回
已弃用：使用模板和收件人创建信封
使用指定的模板创建新的信封并指定收件人。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
信封状态
|
status | True | string |
信封状态 |
|
Template
|
templateId | True | string |
模板 ID |
|
签名
|
signers | dynamic |
文档的签名者。 |
|
|
电子邮件主题
|
emailSubject | string |
电子邮件主题 |
|
|
电子邮件正文
|
emailBody | string |
电子邮件正文 |
返回
已弃用：将收件人添加到信封
将收件人添加到信封。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
信封
|
envelopeId | True | string |
信封 ID |
|
签名者名称
|
AddRecipientToEnvelopeName | True | string |
收件人的名称。 |
|
签名者电子邮件
|
AddRecipientToEnvelopeEmail | True | string |
收件人的电子邮件。 |
|
签名顺序
|
routingOrder | string |
文档中收件人的签名顺序。 |
|
|
角色
|
roleName | string |
签名者的角色。 |
返回
显示内部版本号（仅供参考）。请勿包含在执行流中）
更新信封上的收件人
更新信封上的收件人
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
信封
|
envelopeId | True | string |
信封 ID |
|
收件人 ID
|
recipientId | True | string |
收件人 ID |
|
签名类型
|
signatureType | string |
DocuSign 基于标准的签名 （SBS） 类型。 |
|
|
收件人类型
|
recipientType | True | string |
收件人类型 |
|
客户端用户 ID
|
clientUserId | string |
嵌入式签名者的客户端用户 ID |
|
|
嵌入式收件人开始 URL
|
embeddedRecipientStartURL | string |
用于重定向嵌入收件人的发件人提供的 URL 字符串。 |
|
|
签名顺序
|
routingOrder | string |
收件人的签名顺序。 |
|
|
电子邮件通知语言
|
emailNotificationLanguage | string |
电子邮件通知的语言。 |
|
|
电子邮件通知主题
|
emailNotificationSubject | string |
电子邮件通知的主题。 |
|
|
电子邮件通知正文
|
emailNotificationBody | string |
电子邮件通知的正文。 |
|
|
注释
|
note | string |
收件人的自定义说明。 |
|
|
角色名称
|
roleName | string |
与收件人关联的角色名称。 |
|
|
SMS 国家/地区代码
|
countryCode | integer |
对于短信通知，国家/地区代码，不带前导 + 符号。 |
|
|
SMS 电话号码
|
phoneNumber | integer |
需要签名者电子邮件或短信电话。 排除电话号码的国家/地区代码。 |
|
|
签名组
|
signingGroupId | string |
签名组 |
|
|
所选收件人类型的详细信息
|
additionalRecipientParams | dynamic |
所选收件人类型的详细信息。 |
返回
- Body
- Signer
更新信封上的收件人选项卡值
更新信封上的收件人选项卡值
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
信封
|
envelopeId | True | string |
信封 ID |
|
Recipient
|
recipientId | True | string |
收件人 ID |
|
类型
|
tabType | string |
Tab 类型 |
|
|
Id
|
tabId | string |
Id |
|
|
价值
|
value | string |
价值 |
更新信封自定义域
更新指定信封自定义域的值
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
信封
|
envelopeId | True | string |
信封 ID |
|
字段 ID
|
fieldId | True | string |
自定义字段 ID |
|
字段类型
|
fieldType | True | string |
自定义字段类型 |
|
Name
|
name | True | string |
自定义字段名称 |
|
价值
|
value | True | string |
自定义字段值 |
返回
更新信封预填充选项卡
更新预填充选项卡列表的值
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
信封
|
envelopeId | True | string |
信封 ID |
|
文档 ID
|
documentId | True | string |
文档 ID |
|
类型
|
tabType | string |
类型 |
|
|
Id
|
tabId | string |
Id |
|
|
价值
|
value | string |
价值 |
生成嵌入发件人 URL
生成嵌入发件人 URL
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
信封
|
envelopeId | True | string |
信封 ID |
|
打开
|
openIn | True | string |
打开 |
|
返回 URL
|
returnUrl | True | string |
返回 URL |
|
其他添加的 URL
|
additionalURL | dynamic |
其他添加的 URL。 |
返回
生成嵌入式签名 URL [已弃用]
生成嵌入式签名 URL
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
信封
|
envelopeId | True | string |
信封 ID |
|
签名者名称
|
signerName | True | string |
签名者名称 |
|
签名者电子邮件
|
signerEmail | True | string |
签名者电子邮件 |
|
客户端用户 ID
|
clientUserId | string |
必需，除非登录者是亲自登录。 为人员登录者留空 |
|
|
身份验证方法
|
authenticationMethod | True | string |
身份验证方法 |
|
返回 URL
|
returnUrl | True | string |
返回 URL |
|
其他添加的 URL
|
additionalURL | dynamic |
其他添加的 URL。 |
返回
生成嵌入式签名 URL （V2）
生成嵌入式签名 URL （V2）
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
信封
|
envelopeId | True | string |
信封 ID |
|
这是个人登录者吗？
|
isInPersonSigner | True | string |
Yes/No |
|
身份验证方法
|
authenticationMethod | True | string |
身份验证方法 |
|
返回 URL
|
returnUrl | True | string |
返回 URL |
|
其他添加的 URL
|
additionalURL | True | dynamic |
其他添加的 URL。 |
返回
登录
获取审核事件列表
获取审核事件列表
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
信封
|
envelopeId | True | string |
信封 ID |
返回
- response
- object
获取收件人选项卡的信息
返回给定收件人的选项卡的值
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
信封
|
envelopeId | True | string |
信封 ID |
|
收件人 ID
|
recipientId | True | string |
收件人 ID |
|
选项卡标签
|
tabLabel | True | string |
选项卡标签 |
返回
- Body
- Tab
重新发送信封
此作会重新发送 Docusign 信封，或向需要根据提供的 EnvelopeId 签署 Docusign 协议的收件人发送提醒。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
信封
|
envelopeId | True | string |
信封 ID |
返回
- response
- object
触发器
| 已弃用：信封状态更改时（连接） |
当信封状态更改时触发新流。 |
| 已弃用：当信封状态更改时（连接）（V2） |
当信封状态更改时触发新流。 |
| 当信封状态更改 （连接） （V3） |
当信封状态更改时触发新流。 |
已弃用：信封状态更改时（连接）
当信封状态更改时触发新流。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
连接名称
|
name | True | string | |
|
信封事件
|
envelopeEvents | True | string |
返回
已弃用：当信封状态更改时（连接）（V2）
当信封状态更改时触发新流。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
连接名称
|
name | True | string | |
|
信封事件
|
envelopeEvents | True | string |
返回
当信封状态更改 （连接） （V3）
当信封状态更改时触发新流。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
帐户
|
accountId | True | string |
帐户 ID |
|
连接名称
|
name | True | string | |
|
信封事件
|
envelopeEvents | True | string |
返回
定义
WebhookEnvelopeResponseV2
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
自定义字段
|
data.envelopeSummary.customFields | object |
表示此信封的自定义字段的键值对（其中键是字段名称，值为字段值）。 |
|
已创建信封 Date-Time
|
data.envelopeSummary.createdDateTime | date-time |
yyyy-MM-ddTHH：mm：ss.fffZ |
|
信封 ID
|
data.envelopeSummary.envelopeId | string | |
|
发送的信封 Date-Time
|
data.envelopeSummary.sentDateTime | date-time |
yyyy-MM-ddTHH：mm：ss.fffZ |
|
信封状态
|
data.envelopeSummary.status | string | |
|
电子邮件主题
|
data.envelopeSummary.emailSubject | string | |
|
发件人姓名
|
data.envelopeSummary.sender.userName | string | |
|
发件人的用户 ID
|
data.envelopeSummary.sender.userId | string | |
|
发件人的帐户 ID
|
data.envelopeSummary.sender.accountId | string | |
|
发件人的电子邮件地址
|
data.envelopeSummary.sender.email | string | |
|
签名
|
data.envelopeSummary.recipients.signers | array of object | |
|
选项卡
|
data.envelopeSummary.recipients.signers.tabs | object |
表示此收件人的选项卡（其中键是字段名称，值为字段值）的键值对。 |
|
收件人电子邮件
|
data.envelopeSummary.recipients.signers.email | string | |
|
收件人 ID
|
data.envelopeSummary.recipients.signers.recipientId | string | |
|
路由顺序
|
data.envelopeSummary.recipients.signers.routingOrder | string | |
|
收件人已发送 Date-Time
|
data.envelopeSummary.recipients.signers.sentDateTime | date-time |
yyyy-MM-ddTHH：mm：ss.fffZ |
|
收件人状态
|
data.envelopeSummary.recipients.signers.status | string |
收件人的状态。 |
|
收件人类型
|
data.envelopeSummary.recipients.signers.recipientType | string |
收件人的类型。 |
|
验证类型
|
data.envelopeSummary.recipients.signers.verificationType | string |
验证的类型。 |
|
收件人姓名
|
data.envelopeSummary.recipients.signers.name | string |
收件人的名称。 |
WebhookEnvelopeResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
自定义字段
|
customFields | object |
表示此信封的自定义字段的键值对（其中键是字段名称，值为字段值）。 |
|
已创建信封 Date-Time
|
DocuSignEnvelopeInformation.EnvelopeStatus.Created | date-time |
yyyy-MM-ddTHH：mm：ss.fffZ |
|
发件人的电子邮件地址
|
DocuSignEnvelopeInformation.EnvelopeStatus.Email | string | |
|
信封 ID
|
DocuSignEnvelopeInformation.EnvelopeStatus.EnvelopeID | string | |
|
发件人的 IP 地址
|
DocuSignEnvelopeInformation.EnvelopeStatus.SenderIPAddress | string | |
|
发送的信封 Date-Time
|
DocuSignEnvelopeInformation.EnvelopeStatus.Sent | date-time |
yyyy-MM-ddTHH：mm：ss.fffZ |
|
信封状态
|
DocuSignEnvelopeInformation.EnvelopeStatus.Status | string | |
|
Subject
|
DocuSignEnvelopeInformation.EnvelopeStatus.Subject | string | |
|
发件人姓名
|
DocuSignEnvelopeInformation.EnvelopeStatus.UserName | string | |
|
RecipientStatus
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus | array of object | |
|
选项卡
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.tabs | object |
表示此收件人的选项卡（其中键是字段名称，值为字段值）的键值对。 |
|
拒绝原因
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.DeclineReason | DeclineReasonWithoutType | |
|
收件人电子邮件
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Email | string | |
|
收件人 ID
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.RecipientId | string | |
|
路由顺序
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.RoutingOrder | string | |
|
收件人已发送 Date-Time
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Sent | date-time |
yyyy-MM-ddTHH：mm：ss.fffZ |
|
收件人状态
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Status | string |
收件人的状态。 |
|
收件人类型
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Type | string |
收件人的类型。 |
|
收件人姓名
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.UserName | string |
收件人的名称。 |
|
时区
|
DocuSignEnvelopeInformation.TimeZone | string | |
|
时区偏移量
|
DocuSignEnvelopeInformation.TimeZoneOffset | string |
GetDocumentsResponse
- 文件内容
- binary
AddRemindersResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
已启用提醒
|
reminderEnabled | string |
已启用提醒 |
FilteredEnvelopes
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Title
|
title | string |
信封的标题 |
|
Description
|
description | string |
信封活动的说明 |
|
信封 ID
|
envelopeId | string |
信封 ID |
|
文档
|
documents | string |
文档名称列表 |
|
收件人姓名
|
recipients | string |
收件人姓名列表 |
|
发件人姓名
|
sender | string |
发件人名称 |
|
状态
|
status | string |
信封的状态 |
|
状态日期
|
statusDate | string |
活动的上次状态更新 |
|
已发送日期
|
dateSent | date-time |
信封发送日期 |
|
URL
|
url | string |
信封的 URL |
SalesCopilotFilteredEnvelopes
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Title
|
title | string |
信封的标题 |
|
字幕
|
subTitle | string |
信封的子标题 |
|
URL
|
url | string |
信封的 URL |
|
其他属性
|
additionalPropertiesForSalesEnvelope.additionalPropertiesForSalesEnvelope | string |
其他属性 |
Activity
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Title
|
title | string |
此输出指示引文卡中活动的标题。 |
|
Description
|
description | string |
此输出指示见解的说明。 |
|
日期和时间
|
dateTime | date-time |
此输出表示与见解关联的时间。 |
|
URL
|
url | string |
此输出指示用于打开见解的 URL。 |
|
其他属性
|
additionalProperties.additionalProperties | string |
活动的其他属性 |
EmailSummary
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Title
|
Title | string |
此输出指示合作伙伴部分的标题，应仅包含合作伙伴的名称。 |
|
描述
|
Description | string |
此输出指示您希望包含在电子邮件摘要中的文本。 |
KeySales
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Title
|
Title | string |
此输出显示了见解引用卡片的标题。 |
|
描述
|
description | string |
此输出内容指示要包含在关键销售信息中的见解的文本。 |
|
信封的 URL
|
url | string |
此输出指示一个 URL，用于了解更多有关见解的信息。 |
|
与见解关联的时间
|
dateTime | string |
此输出表示与见解关联的时间。 |
|
其他属性
|
additionalProperties.additionalProperties | string |
此输出显示的附加属性以名称-值对形式出现，并由操作返回的每个相关洞察提供。 |
DocumentRecord
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
记录 ID
|
recordId | string |
此输出唯一标识作返回的每个相关记录。 |
|
记录类型显示名称
|
recordTypeDisplayName | string |
此输出指示作返回的每个相关记录的记录类型的显示名称。 |
|
以复数形式显示记录类型显示名称
|
recordTypePluralDisplayName | string |
此输出指示作返回的每个相关记录的记录类型的复数显示名称。 |
|
记录类型
|
recordType | string |
此输出指示作返回的每个相关记录的类型。 |
|
记录标题
|
recordTitle | string |
此输出指示作返回的每个相关记录的标题。 |
|
信封的 URL
|
url | string |
此输出指示作返回的每个相关记录的 URL。 |
|
其他属性
|
additionalProperties.additionalProperties | string |
此输出指示其他属性作为作返回的每个相关记录的名称/值对。 |
EmbeddedSenderResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
嵌入发件人 URL
|
url | string |
嵌入发件人视图的 URL。 |
EmbeddedSigningResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
URL
|
url | string |
嵌入式签名视图的 URL。 |
FilteredEnvelopeListResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
筛选信封
|
value | array of FilteredEnvelopes |
筛选的信封 |
|
更多信封结果
|
hasMoreResults | boolean |
显示信封是否超过“返回信封”字段中的指定数字 |
FilteredSalesCopilotEnvelopeListResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
筛选信封
|
value | array of SalesCopilotFilteredEnvelopes |
筛选的信封 |
|
hasMoreResults
|
hasMoreResults | boolean |
ActivityListResponseEnvelope
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
相关活动
|
value | array of Activity |
相关活动 |
|
hasMoreResults
|
hasMoreResults | boolean |
EmailSummaryResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
电子邮件摘要
|
value | array of EmailSummary |
关键销售 |
|
hasMoreResults
|
hasMoreResults | boolean |
KeySalesResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
关键销售'
|
value | array of KeySales |
关键销售 |
|
hasMoreResults
|
hasMoreResults | boolean |
DocumentRecordListResponseEnvelope
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
相关记录
|
value | array of DocumentRecord |
相关记录 |
|
hasMoreResults
|
hasMoreResults | boolean |
CreateEnvelopeResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
信封 ID
|
envelopeId | string |
信封的 ID。 |
|
模板 ID
|
templateId | string |
模板的 ID。 |
|
状态
|
status | string |
信封的状态。 |
|
状态日期时间
|
statusDateTime | string |
设置状态的日期/时间。 |
|
URI
|
uri | string |
DocuSign 中信封的 URI。 |
ListRecipientsResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
签名
|
signers | array of Signer |
签名 |
选项卡
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
选项卡名称
|
name | string |
选项卡的名称。 |
|
Tab 类型
|
tabType | string |
选项卡的类型。 |
|
选项卡标签
|
tabLabel | string |
选项卡的标签。 |
|
Tab 值
|
value | string |
选项卡的值。 |
|
选项卡 Id
|
tabId | string |
选项卡的 ID。 |
|
文档 ID
|
documentId | string |
文档的 ID。 |
|
收件人 ID
|
recipientId | string |
收件人的 ID。 |
|
预填充
|
prefill | boolean |
指示选项卡是否为预填充类型。 |
|
已选中
|
selected | string |
如果选项卡为复选框，则指示是否选中该选项卡。 |
RecipientTabsResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
收件人选项卡：
|
recipientTabs | array of Tab |
“收件人”选项卡 |
签名人
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
签名顺序
|
routingOrder | string |
文档中收件人的签名顺序。 |
|
角色
|
roleName | string |
签名者的角色。 |
|
收件人 ID
|
recipientId | string |
收件人的 ID。 |
|
Name
|
name | string |
收件人的名称。 |
|
Email
|
string |
收件人的电子邮件。 |
|
|
收件人类型
|
recipientType | string |
键入收件人。 |
|
验证类型
|
verificationType | string |
验证的类型。 |
|
收件人 Guid
|
recipientIdGuid | string |
收件人 Guid。 |
GetLoginAccountsResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
登录帐户
|
loginAccounts | array of LoginAccount |
登录帐户 |
LoginAccount
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Name
|
name | string |
帐户的名称。 |
|
帐户 ID guid
|
accountIdGuid | string |
帐户的 GUID。 |
ListTabsResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
选项卡
|
tabs | array of Tab |
选项卡 |
ListEnvelopeDocumentFieldsResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
自定义域
|
envelopeDocumentFields | array of EnvelopeDocumentField |
文档自定义字段 |
DocGenFormFieldsResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Docgen 字段
|
docgenFields | array of DocGenFormField |
Docgen 字段 |
DocGenFormField
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
文档 ID
|
documentId | string |
文档 ID。 |
|
标签
|
label | string |
标签。 |
|
类型
|
type | string |
类型。 |
|
Name
|
name | string |
名称。 |
|
价值
|
value | string |
价值。 |
ListTemplatesResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
信封模板
|
envelopeTemplates | array of EnvelopeTemplate |
可用的信封模板。 |
EnvelopeTemplate
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
模板 ID
|
templateId | string |
模板的 ID。 |
|
Name
|
name | string |
模板的名称。 |
BulkSendListGuid
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
批量发送列表 guid
|
listId | string |
批量发送列表 guid |
EnvelopeCustomFieldResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
字段 ID
|
fieldId | string |
信封自定义域的 ID。 |
|
字段类型
|
fieldType | string |
信封自定义域的类型。 |
|
Name
|
name | string |
信封自定义域的名称。 |
|
价值
|
value | string |
信封自定义域的值。 |
UpdateEnvelopeCustomFieldResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
字段 ID
|
fieldId | string |
信封自定义域的 ID。 |
|
字段类型
|
fieldType | string |
信封自定义域的类型。 |
|
Name
|
name | string |
信封自定义域的名称。 |
|
价值
|
value | string |
信封自定义域的值。 |
ListDocumentsResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
信封文档
|
envelopeDocuments | array of EnvelopeDocument |
附加到信封的文档。 |
ListTemplateDocumentsResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
模板文档
|
templateDocuments | array of EnvelopeDocument |
附加到模板的文档。 |
AddDocumentsResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
信封 ID
|
envelopeId | string |
信封的 ID。 |
|
信封文档
|
envelopeDocuments | array of EnvelopeDocument |
附加到信封的文档。 |
AddRecipientTabsResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
收件人选项卡
|
recipientTabs | array of RecipientTab |
添加到收件人的选项卡。 |
EnvelopeDocument
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Name
|
name | string |
文档的名称。 |
|
文档 ID
|
documentId | string |
文档的 ID。 |
|
文档 Guid
|
documentIdGuid | string |
文档的 GUID。 |
RecipientTab
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
选项卡 Id
|
tabId | string |
选项卡的 ID。 |
|
Tab 类型
|
tabType | string |
选项卡的类型。 |
EnvelopeDocumentField
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Name
|
name | string |
自定义域的名称。 |
|
价值
|
value | string |
自定义域的值。 |
DeclineReasonWithoutType
对象
这是 'object' 类型。