通过

SignRequest （预览版）

SignRequest 是一种安全且具有法律约束力的电子签名工具，使你和你的合作伙伴能够快速签署合同和其他文档，而无需打印、签名和扫描。

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

服务 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）
联系人​​
Email tech-support@signrequest.com
连接器元数据
发布者 SignRequest B.V.

限制

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

操作

Send SignRequest

创建并发送新的 SignRequest。

Send SignRequest

操作 ID:
SignrequestQuickCreateCreate

创建并发送新的 SignRequest。

参数

名称 密钥 必需 类型 说明
自动删除天数
 auto_delete_days integer

完成的文档（已签名/已取消/拒绝）将自动删除的天数
自动过期日期
 auto_expire_days integer

未完成的文档自动过期的天数
禁用附件
 disable_attachments boolean

禁用上传/添加附件
禁用区块链证明
 disable_blockchain_proof boolean

禁用在区块链集成中存储时间戳证明哈希。
停用日期
 disable_date boolean

禁用添加日期
禁用电子邮件
 disable_emails boolean

禁用所有 SignRequest 状态电子邮件以及包含已签名文档的电子邮件
禁用文本
 disable_text boolean

禁用添加文本
禁用文本签名
 disable_text_signatures boolean

禁用通过键入（文本）生成的签名的使用
禁用上传签名
 disable_upload_signatures boolean

禁用上传签名的使用（图像）
文档
 document uri
事件回调 URL
 events_callback_url uri

用于接收本文档 的事件回调 的 URL
外部 ID
 external_id string

用于引用外部系统中文档的 ID
文件
 file uri

原始文件的临时 URL 将在 5 分钟内过期
来自内容的文件
 file_from_content byte

Base64 编码的文档内容
来自内容名称的文件
 file_from_content_name string

文件名，包括扩展名。 使用 file_from_content时必需 。
来自 URL 的文件
 file_from_url uri

要由 SignRequest 下载的文档的可公开访问 URL
从电子邮件
 from_email email

发送 SignRequest 的用户的电子邮件（必须是经过验证的电子邮件）
从电子邮件名称
 from_email_name string

要用于 From 电子邮件标头的名称，例如 {from_email_name} <no-reply@signrequest.com>
前端 ID
 frontend_id string

与 SignRequest-js 客户端 结合使用的共享机密，以授予用户对不是文档团队成员的文档的访问权限
正在准备
 is_being_prepared boolean

让 SignRequest 的发送方在发送请求之前准备文档，请参阅： 使用 Web 界面进行准备
Message
 message string

要包含在 SignRequest 电子邮件中的邮件可能包含以下 html 标记：a、blockquotebabbracronymcode、、em、 和 iulliolstrong
Name
 name string

默认为文件名，包括扩展名
预填充标记复选框值
 checkbox_value boolean
预填充标记日期值
 date_value date
预填充标记外部 ID
 external_id string
预填充标记文本
 text string
准备 URL
 prepare_url uri
重定向 URL
 redirect_url uri

签名文档时 SignRequest 将重定向到的 URL
重定向 URL 被拒绝
 redirect_url_declined uri

当文档被拒绝时，SignRequest 将重定向到的 URL
所需的附件名称
 name True string
必需的附件 Uuid
 uuid string
发送提醒
 send_reminders boolean

自动提醒签名者签署文档，请参阅： 自动提醒
文档后签名者
 after_document uri
仅签名者批准
 approve_only boolean

要求用户批准文档（无需添加签名），请参阅： 仅批准
文件
 file uri
所需的附件名称
 name True string
必需的附件 Uuid
 uuid string
Name
 name string

默认为文件名
Uuid
 uuid string
签名者被拒绝
 declined boolean
登录者被拒绝
 declined_on date-time
签名者显示名称
 display_name string
已下载签名者
 downloaded boolean
签名者电子邮件
 email True email
已查看签名者电子邮件
 email_viewed boolean
Signer Emailed
 emailed boolean
签名者嵌入 URL
 embed_url uri
签名者嵌入 URL 用户 ID
 embed_url_user_id string
签名者名字
 first_name string
签名者强制语言
 force_language boolean
已转发的签名者
 forwarded boolean
正在转发的登录者
 forwarded_on date-time
签名者转发的原因
 forwarded_reason string
已转发到电子邮件的登录者
 forwarded_to_email email
登录人
 in_person boolean

当与发件人的嵌入 URL 结合使用时，发送方签名后，它们将被重定向到下一个 in_person 签名者，请参阅： 亲自签名
复选框值
 checkbox_value boolean
日期值
 date_value date
外部 ID
 external_id string
页面索引
 page_index True integer
占位符 uuid
 placeholder_uuid string
文本
 text string
类型
 type string
签名语言
 language string
签名者姓氏
 last_name string
签名者消息
 message string
签名者需要签名
 needs_to_sign boolean

如果用户 false 不需要签名，但将收到已签名文档和签名日志的副本，请参阅： 仅复制
仅签名者通知
 notify_only boolean

发送有关文档和已签名文档的副本和签名日志的通知，但不需要他们采取任何作，请参阅： 仅通知
签名者顺序
 order integer
签名者密码
 password string

在对文档进行签名之前，要求签名者输入此密码。 此字段仅写入。
签名者重定向 URL
 redirect_url uri
签名者重定向 URL 被拒绝
 redirect_url_declined uri
签名者已签名
 signed boolean
登录者
 signed_on date-time
签名者仅使用印章进行审批
 use_stamp_for_approve_only boolean

当签名者批准文档时，在文档上放置审批标记
签名者验证银行帐户
 verify_bank_account string
签名者验证电话号码
 verify_phone_number string
已查看签名者
 viewed boolean
团队
 subdomain string
Subject
 subject string

SignRequest 电子邮件的主题
Template
 template uri
已锁定短信验证
 text_message_verification_locked boolean

当为 true 时，需要文本消息验证，然后签名者才能查看文档
网址
 url uri
Uuid
 uuid string
人员
 who string

m：只有我， mo：我和其他人， o只有其他人

返回

Body
SignRequestQuickCreate

触发器

文档状态更改时

当 SignRequest 的文档状态更改时触发。

文档状态更改时

操作 ID:
WebhooksCreate

当 SignRequest 的文档状态更改时触发。

参数

名称 密钥 必需 类型 说明
已创建
 created date-time
事件类型
 event_type True string
Name
 name string

可选名称，用于轻松标识 Webhook 的用途
团队
 subdomain string
工作组名称
 name string
团队子域
 subdomain uri
团队 URL
 url uri
网址
 url uri
Uuid
 uuid string

返回

名称 路径 类型 说明
文档
 document Document

定义

文档

名称 路径 类型 说明
使用的文档 API
 api_used boolean

指示是否使用 API 创建文档
attachments
 attachments array of DocumentAttachment
文档自动删除之后
 auto_delete_after date-time

使用 auto_delete_days 计算的日期和时间，之后将自动删除已完成的文档（已签名/取消/拒绝）
文档自动删除天数
 auto_delete_days integer

完成的文档（已签名/已取消/拒绝）将自动删除的天数
文档自动过期
 auto_expire_after date-time

使用 auto_expire_days 计算的日期和时间，之后未完成的文档将自动过期
文档自动过期日期
 auto_expire_days integer

未完成的文档自动过期的天数
文档事件回调 URL
 events_callback_url uri

用于接收本文档 的事件回调 的 URL
文档外部 ID
 external_id string

用于引用外部系统中文档的 ID
文档文件
 file uri

原始文件的临时 URL 将在 5 分钟内过期
文档文件为 Pdf
 file_as_pdf uri

PDF 格式的原始文件的临时 URL 将在 5 分钟内过期
来自内容的文档文件
 file_from_content string

Base64 编码的文档内容
来自内容名称的文档文件
 file_from_content_name string

文件名，包括扩展名。 使用 file_from_content时必需 。
来自 sf 的文件
 file_from_sf FileFromSf
来自 URL 的文档文件
 file_from_url uri

要由 SignRequest 下载的文档的可公开访问 URL
文档前端 ID
 frontend_id string

与 SignRequest-js 客户端 结合使用的共享机密，以授予用户对不是文档团队成员的文档的访问权限
文档名称
 name string

默认为文件名，包括扩展名
文档 Pdf
 pdf uri

PDF 格式的已签名文档的临时 URL 将在 5 分钟内过期
prefill_tags
 prefill_tags array of InlinePrefillTags

预填充签名者输入数据，请参阅 预填充标记
文档处理
 processing boolean

指示对文档的更改是否正在处理，并且 PDF 可能已过期。 建议在下载 PDF 之前等待处理完成。 在处理完成之前，不会发送 Webhook。
文档沙盒
 sandbox boolean

指示是否在沙盒团队中创建文档
文档安全哈希
 security_hash string

PDF 内容的 SHA256 哈希
签名日志 Pdf
 signing_log.pdf uri

签名日志的临时 URL 将在 5 分钟内过期
签名日志安全哈希
 signing_log.security_hash string

PDF 内容的 SHA256 哈希
Signrequest 禁用附件
 signrequest.disable_attachments boolean

禁用上传/添加附件
Signrequest Disable Blockchain Proof
 signrequest.disable_blockchain_proof boolean

禁用在区块链集成中存储时间戳证明哈希。
Signrequest Disable Date
 signrequest.disable_date boolean

禁用添加日期
Signrequest 禁用电子邮件
 signrequest.disable_emails boolean

禁用所有 SignRequest 状态电子邮件以及包含已签名文档的电子邮件
Signrequest 禁用文本
 signrequest.disable_text boolean

禁用添加文本
Signrequest 禁用文本签名
 signrequest.disable_text_signatures boolean

禁用通过键入（文本）生成的签名的使用
Signrequest 禁用上传签名
 signrequest.disable_upload_signatures boolean

禁用上传签名的使用（图像）
来自电子邮件的 Signrequest
 signrequest.from_email email

发送 SignRequest 的用户的电子邮件（必须是经过验证的电子邮件）
来自电子邮件名称的 Signrequest
 signrequest.from_email_name string

要用于 From 电子邮件标头的名称，例如 {from_email_name} <no-reply@signrequest.com>
Signrequest 正在准备中
 signrequest.is_being_prepared boolean

让 SignRequest 的发送方在发送请求之前准备文档，请参阅： 使用 Web 界面进行准备
Signrequest 消息
 signrequest.message string

要包含在 SignRequest 电子邮件中的邮件可能包含以下 html 标记：a、blockquotebabbracronymcode、、em、 和 iulliolstrong
Signrequest Prepare Url
 signrequest.prepare_url uri
Signrequest 重定向 URL
 signrequest.redirect_url uri

签名文档时 SignRequest 将重定向到的 URL
Signrequest 重定向 URL 已拒绝
 signrequest.redirect_url_declined uri

当文档被拒绝时，SignRequest 将重定向到的 URL
required_attachments
 signrequest.required_attachments array of RequiredAttachment
Signrequest Send Reminders
 signrequest.send_reminders boolean

自动提醒签名者签署文档，请参阅： 自动提醒
签名
 signrequest.signers array of Signer
Signrequest 主题
 signrequest.subject string

SignRequest 电子邮件的主题
已锁定 Signrequest 短信验证
 signrequest.text_message_verification_locked boolean

当为 true 时，需要文本消息验证，然后签名者才能查看文档
Signrequest Uuid
 signrequest.uuid string
Signrequest Who
 signrequest.who string

m：只有我， mo：我和其他人， o只有其他人
文档状态
 status string

co： converting， ： new， nese： sent， vi： viewed， si： signed， do： downloadedsd， ： signed and downloaded， ca： cancelled， de： declined， ec： error converting， es： error sent， xp： expired
工作组名称
 team.name string
团队子域
 team.subdomain uri
团队 URL
 team.url uri
文档模板
 template uri
文档 URL
 url uri
用户
 user User
文档 Uuid
 uuid string

DocumentAttachment

名称 路径 类型 说明
文档附件文档
 document uri
文档附件文件
 file uri

文档附件的临时 URL 将在 5 分钟内过期
内容中的文档附件文件
 file_from_content string

Base64 编码的文档内容
内容名称中的文档附件文件
 file_from_content_name string

文件名，包括扩展名。 使用 file_from_content时必需 。
URL 中的文档附件文件
 file_from_url uri

要由 SignRequest 下载的文档的可公开访问 URL
文档附件名称
 name string

默认为文件名，包括扩展名
文档附件 URL
 url uri
文档附件 Uuid
 uuid string

FileFromSf

名称 路径 类型 说明
对象 ID
 object_id string
对象类型
 object_type string
Uid
 uid string

InlinePrefillTags

预填充签名者输入数据，请参阅 预填充标记

名称 路径 类型 说明
预填充标记复选框值
 checkbox_value boolean
预填充标记日期值
 date_value date
预填充标记外部 ID
 external_id string
预填充标记文本
 text string

RequiredAttachment

名称 路径 类型 说明
所需的附件名称
 name string
必需的附件 Uuid
 uuid string

SignRequestQuickCreate

名称 路径 类型 说明
自动删除天数
 auto_delete_days integer

完成的文档（已签名/已取消/拒绝）将自动删除的天数
自动过期日期
 auto_expire_days integer

未完成的文档自动过期的天数
禁用附件
 disable_attachments boolean

禁用上传/添加附件
禁用区块链证明
 disable_blockchain_proof boolean

禁用在区块链集成中存储时间戳证明哈希。
停用日期
 disable_date boolean

禁用添加日期
禁用电子邮件
 disable_emails boolean

禁用所有 SignRequest 状态电子邮件以及包含已签名文档的电子邮件
禁用文本
 disable_text boolean

禁用添加文本
禁用文本签名
 disable_text_signatures boolean

禁用通过键入（文本）生成的签名的使用
禁用上传签名
 disable_upload_signatures boolean

禁用上传签名的使用（图像）
文档
 document uri
事件回调 URL
 events_callback_url uri

用于接收本文档 的事件回调 的 URL
外部 ID
 external_id string

用于引用外部系统中文档的 ID
文件
 file uri

原始文件的临时 URL 将在 5 分钟内过期
来自内容的文件
 file_from_content byte

Base64 编码的文档内容
来自内容名称的文件
 file_from_content_name string

文件名，包括扩展名。 使用 file_from_content时必需 。
来自 URL 的文件
 file_from_url uri

要由 SignRequest 下载的文档的可公开访问 URL
从电子邮件
 from_email email

发送 SignRequest 的用户的电子邮件（必须是经过验证的电子邮件）
从电子邮件名称
 from_email_name string

要用于 From 电子邮件标头的名称，例如 {from_email_name} <no-reply@signrequest.com>
前端 ID
 frontend_id string

与 SignRequest-js 客户端 结合使用的共享机密，以授予用户对不是文档团队成员的文档的访问权限
正在准备
 is_being_prepared boolean

让 SignRequest 的发送方在发送请求之前准备文档，请参阅： 使用 Web 界面进行准备
Message
 message string

要包含在 SignRequest 电子邮件中的邮件可能包含以下 html 标记：a、blockquotebabbracronymcode、、em、 和 iulliolstrong
Name
 name string

默认为文件名，包括扩展名
prefill_tags
 prefill_tags array of InlinePrefillTags

预填充签名者输入数据，请参阅 预填充标记
准备 URL
 prepare_url uri
重定向 URL
 redirect_url uri

签名文档时 SignRequest 将重定向到的 URL
重定向 URL 被拒绝
 redirect_url_declined uri

当文档被拒绝时，SignRequest 将重定向到的 URL
required_attachments
 required_attachments array of RequiredAttachment

签名者上传所需的附件
发送提醒
 send_reminders boolean

自动提醒签名者签署文档，请参阅： 自动提醒
签名
 signers array of Signer
团队
 subdomain string
Subject
 subject string

SignRequest 电子邮件的主题
Template
 template uri
已锁定短信验证
 text_message_verification_locked boolean

当为 true 时，需要文本消息验证，然后签名者才能查看文档
网址
 url uri
Uuid
 uuid string
人员
 who string

m：只有我， mo：我和其他人， o只有其他人

签名人

名称 路径 类型 说明
文档后签名者
 after_document uri
仅签名者批准
 approve_only boolean

要求用户批准文档（无需添加签名），请参阅： 仅批准
attachments
 attachments array of SignerAttachment
签名者被拒绝
 declined boolean
登录者被拒绝
 declined_on date-time
签名者显示名称
 display_name string
已下载签名者
 downloaded boolean
签名者电子邮件
 email email
已查看签名者电子邮件
 email_viewed boolean
Signer Emailed
 emailed boolean
签名者嵌入 URL
 embed_url uri
签名者嵌入 URL 用户 ID
 embed_url_user_id string
签名者名字
 first_name string
签名者强制语言
 force_language boolean
已转发的签名者
 forwarded boolean
正在转发的登录者
 forwarded_on date-time
签名者转发的原因
 forwarded_reason string
已转发到电子邮件的登录者
 forwarded_to_email email
登录人
 in_person boolean

当与发件人的嵌入 URL 结合使用时，发送方签名后，它们将被重定向到下一个 in_person 签名者，请参阅： 亲自签名
输入
 inputs array of SignerInputs
签名语言
 language string
签名者姓氏
 last_name string
签名者消息
 message string
签名者需要签名
 needs_to_sign boolean

如果用户 false 不需要签名，但将收到已签名文档和签名日志的副本，请参阅： 仅复制
仅签名者通知
 notify_only boolean

发送有关文档和已签名文档的副本和签名日志的通知，但不需要他们采取任何作，请参阅： 仅通知
签名者顺序
 order integer
签名者密码
 password string

在对文档进行签名之前，要求签名者输入此密码。 此字段仅写入。
签名者重定向 URL
 redirect_url uri
签名者重定向 URL 被拒绝
 redirect_url_declined uri
签名者已签名
 signed boolean
登录者
 signed_on date-time
签名者仅使用印章进行审批
 use_stamp_for_approve_only boolean

当签名者批准文档时，在文档上放置审批标记
签名者验证银行帐户
 verify_bank_account string
签名者验证电话号码
 verify_phone_number string
已查看签名者
 viewed boolean

SignerAttachment

名称 路径 类型 说明
文件
 file uri
for_attachment
 for_attachment RequiredAttachment
Name
 name string

默认为文件名
Uuid
 uuid string

SignerInputs

名称 路径 类型 说明
复选框值
 checkbox_value boolean
日期值
 date_value date
外部 ID
 external_id string
页面索引
 page_index integer
占位符 uuid
 placeholder_uuid string
文本
 text string
类型
 type string

用户

名称 路径 类型 说明
用户显示名称
 display_name string
用户电子邮件地址
 email email
用户名
 first_name string
用户名
 last_name string