GetAccept

GetAccept 提供了一个销售支持平台，用于在一个位置设计、发送、推广、跟踪和电子签名销售文档，利用销售抵押品、合同管理、建议和电子签名。

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

服务	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	GetAccept API 团队
URL	https://app.getaccept.com/api
Email	integrations@getaccept.com

连接器元数据
发布者	GetAccept， Inc.
网站	https://www.getaccept.com
隐私策略	https://www.getaccept.com/privacy-policy
类别	销售和 CRM;生产力

GetAccept 提供了一个销售支持平台，用于在一个位置设计、发送、推广、跟踪和电子签名销售文档，利用销售抵押品、合同管理、建议和电子签名。 此连接器有助于自动执行文档存储、检索、任务分配和自定义通知的工作流。

先决条件

使用此连接需要 GetAccept 帐户。 转到 getaccept.com 注册免费帐户。

如何获取凭据？

只有有效的 GetAccept 帐户是必需的，因为 OAuth2 用于对 GetAccept 中的当前登录用户进行身份验证。

已知问题和限制

请与 [mailto：support@getaccept.com]（技术支持）联系，了解任何与集成相关的问题。

限制

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

操作

上传文档文件	可以一次上传一个文件并获取文件 ID。文件 ID 用于将文件与发送到收件人的 GetAccept 文档连接。 如果要上传互斥文件，请运行多个 POST。 默认情况下，我们仅接受最多 10 MB 的文件。 上传的文件需要在上传后的 48 小时内导入/添加到文档。 建议上传 PDF 文件，以确保发送时的外观相同。 可以转换其他文件类型，例如： Mirosoft Office：doc、docx、xl、xls、xlsx、pptx Mac：数字、关键图像：jpg、jpeg、png 其他：html、tex、csv
上传视频	可以上传附件文件以包含在发送的文档中。 成功的请求将返回attachment_id。 使用attachment_id向文档分配附件。
上传附件	可以上传附件文件以包含在发送的文档中。 成功的请求将返回attachment_id。 使用attachment_id向文档分配附件。
下载文档	文档文件始终可以下载，但最有可能在文档文件的状态为“已签名”时下载它。 可以选择接收下载 URL 或获取二进制文件。 在发出请求 10 分钟后，可访问下载 URL。
列出文档	获取可用文档的列表
列出模板	接收可用文档模板的列表。 可以在 GetAccept 的 Templates 部分下添加新模板。
列出用户	获取当前经过身份验证的实体的活动用户列表
列出联系人	接收当前实体的可用联系人列表。 添加为收件人的所有联系人都保存为联系人，可供稍后在该实体上使用。
列出视频	接收实体上可用视频的列表。 可以在移动应用或 GetAccept 中添加新视频。
列出附件	接收可用附件的列表。 可以使用新文档在 GetAccept 中添加新附件。
创建和发送文档或模板	必须创建一个文档才能将其发送给收件人。 创建文档时，可以使用file_id引用以前上传的文件，也可以选择创建文档并在 API 帖子中上传文件。 在创建文档 POST 中包含文件时，只能上传一个文件。 使用file_ids参数使用现有的上传文件（s），file_content将文档作为 base64 编码字符串发送，或使用文件参数执行多部分帖子。 所有收件人都必须具有有效的电子邮件或手机号码。 所有事件都使用请求者 IP 地址进行记录。 可以使用包含最终用户公共 IP 地址的标头CLIENT_IP替代此地址。
创建用户	这将在数据库中为当前实体创建新联系人
创建联系人	这将在数据库中为当前实体创建新联系人
发送现有文档	通过 GetAccept 发送文档时，我们会向所有收件人（每个收件人都包含唯一的安全链接）发送电子邮件。 此 API 调用会触发文档发送作，并且只能在document_status = 草稿的文档上执行。 文档将发送给创建文档时提供的收件人。 如果使用自签名选项创建文档，在发送之前，该文档也将由经过身份验证或指定的用户自行签名。
更新文档过期时间	使用此方法更新文档的到期日期和时间。
获取文档字段	获取文档或模板的字段列表。 可以在文档签名之前和之后使用。
获取文档收件人	获取特定文档的收件人列表。
获取文档详细信息	通过指定文档 ID 获取文档详细信息。
获取文档附件	通过指定文档 ID 获取文档附件。
获取模板字段	接收特定模板的字段列表。
获取模板定价表	接收特定模板的定价表项列表。
获取模板角色	接收特定模板的角色列表。
获取用户详细信息	此调用将返回单个用户的详细信息。 使用用户 ID 我接收当前经过身份验证的用户的详细信息和可用实体

上传文档文件

操作 ID:

UploadDocument

可以一次上传一个文件并获取文件 ID。文件 ID 用于将文件与发送到收件人的 GetAccept 文档连接。 如果要上传互斥文件，请运行多个 POST。 默认情况下，我们仅接受最多 10 MB 的文件。 上传的文件需要在上传后的 48 小时内导入/添加到文档。

建议上传 PDF 文件，以确保发送时的外观相同。 可以转换其他文件类型，例如：

Mirosoft Office：doc、docx、xl、xls、xlsx、pptx Mac：数字、关键图像：jpg、jpeg、png 其他：html、tex、csv

参数

名称	密钥	必需	类型	说明
文件内容	file_content		string	将文件作为 base64 编码发送。 请注意，base64 编码文件将增加文件大小，%
文件名	file_name		string	文档的文件名，扩展名。 这将有助于转换不同的文件类型。
文件 URL	file_url		string	文档文件的 URL。 文件必须可供下载，无需任何授权

返回

名称	路径	类型	说明
file_id	file_id	string	创建文档时要在file_ids中使用的上传文件的 ID
file_status	file_status	string	上传文件的状态

上传视频

操作 ID:

UploadVideo

可以上传附件文件以包含在发送的文档中。 成功的请求将返回attachment_id。 使用attachment_id向文档分配附件。

参数

名称	密钥	必需	类型	说明
文件内容	file_content		string	将文件作为 base64 编码发送。 请注意，base64 编码文件将增加文件大小，%
文件名	file_name		string	文档的文件名，扩展名。 这将有助于转换不同的文件类型。
文件 URL	file_url		string	文档文件的 URL。 文件必须可供下载，无需任何授权

返回

名称	路径	类型	说明
文件状态	file_status	string	视频的状态
文件名	filename	string	视频的文件名
职位编号	job_id	string	正在转换和压缩视频的处理作业的 ID。 使用 /video/job/<ID> 轮询作业状态更新。
视频 ID	video_id	string	创建文档时要在video_id中使用的上传视频的 ID

上传附件

操作 ID:

UploadAttachment

可以上传附件文件以包含在发送的文档中。 成功的请求将返回attachment_id。 使用attachment_id向文档分配附件。

参数

名称	密钥	必需	类型	说明
文件内容	file_content		string	将文件作为 base64 编码发送。 请注意，base64 编码文件将增加文件大小，%
文件名	file_name		string	文档的文件名，扩展名。 这将有助于转换不同的文件类型。
文件 URL	file_url		string	文档文件的 URL。 文件必须可供下载，无需任何授权

返回

名称	路径	类型	说明
文件名	filename	string	附件的文件名
附件 ID	id	string	创建文档时要在attachment_id中使用的上传附件的 ID
附件标题	title	string	附件的标题
附件类型	type	string	附件的类型

下载文档

操作 ID:

DownloadDocument

文档文件始终可以下载，但最有可能在文档文件的状态为“已签名”时下载它。

可以选择接收下载 URL 或获取二进制文件。

在发出请求 10 分钟后，可访问下载 URL。

参数

名称	密钥	必需	类型	说明
文档 ID	documentId	True	string	文档 ID
直接返回二进制文件	direct		string	直接返回二进制文件

返回

名称	路径	类型	说明
document_url	document_url	string
文件	file	string

列出文档

操作 ID:

ListDocuments

获取可用文档的列表

参数

名称	密钥	必需	类型	说明
状态筛选列表	filter		string	状态筛选列表
如何对结果进行排序	sort_by		string	如何对结果进行排序
结果排序顺序	sort_order		string	结果排序顺序
包括团队成员的文档	showteam		boolean	包括团队成员的文档
包括实体中的所有文档	showall		boolean	包括实体中的所有文档
外部 ID	external_id		string	外部 ID 是一个自定义字段，其中包含 GetAccept 外部系统中的唯一记录标识符
Offset	offset		number	从记录 x 开始列表直到限制
限度	limit		number	要列出的记录数

返回

文档列表

物品

Documents

列出模板

操作 ID:

ListTemplates

接收可用文档模板的列表。 可以在 GetAccept 的 Templates 部分下添加新模板。

参数

名称	密钥	必需	类型	说明
全部显示	showall		string	显示实体的所有模板
文件夹 ID	folder_id		string	显示特定文件夹中的模板

返回

名称	路径	类型	说明
templates	templates	array of object
tags	templates.tags	string
创建时间	templates.created_at	string
external_editor_type	templates.external_editor_type	string
field_count	templates.field_count	integer
id	templates.id	string
is_editable	templates.is_editable	boolean
is_private	templates.is_private	boolean
姓名	templates.name	string
page_count	templates.page_count	integer
role_count	templates.role_count	integer
sender_name	templates.sender_name	string
sender_thumb_url	templates.sender_thumb_url	string
thumb_url	templates.thumb_url	string
类型	templates.type	string
user_id	templates.user_id	string
video_id	templates.video_id	string
video_thumb_url	templates.video_thumb_url	string

列出用户

操作 ID:

ListUsers

获取当前经过身份验证的实体的活动用户列表

返回

用户列表

用户

Users

列出联系人

操作 ID:

ListContacts

接收当前实体的可用联系人列表。 添加为收件人的所有联系人都保存为联系人，可供稍后在该实体上使用。

返回

联系人列表

联系人

Contacts

列出视频

操作 ID:

ListVideos

接收实体上可用视频的列表。 可以在移动应用或 GetAccept 中添加新视频。

返回

名称	路径	类型	说明
videos	videos	array of object
编辑	videos.editable	boolean
发表	videos.published	boolean
保存	videos.saved	boolean
thumb_url	videos.thumb_url	string
video_id	videos.video_id	string
video_title	videos.video_title	string
video_type	videos.video_type	string
video_url	videos.video_url	string

列出附件

操作 ID:

ListAttachments

接收可用附件的列表。 可以使用新文档在 GetAccept 中添加新附件。

返回

附件列表

附件

Attachments

创建和发送文档或模板

操作 ID:

CreateDocument

必须创建一个文档才能将其发送给收件人。 创建文档时，可以使用file_id引用以前上传的文件，也可以选择创建文档并在 API 帖子中上传文件。 在创建文档 POST 中包含文件时，只能上传一个文件。

使用file_ids参数使用现有的上传文件（s），file_content将文档作为 base64 编码字符串发送，或使用文件参数执行多部分帖子。

所有收件人都必须具有有效的电子邮件或手机号码。

所有事件都使用请求者 IP 地址进行记录。 可以使用包含最终用户公共 IP 地址的标头CLIENT_IP替代此地址。

参数

名称	密钥	必需	类型	说明
ID	id		string	从列表或上传后收到的附件 ID
需要视图	require_view		boolean	要求收件人查看附件
类型	type		string	文件或外部文件是上传的文件，外部文件是指向外部文件的链接
字段 ID	id		string	自定义模板字段的 ID
字段名称	name		string	自定义模板字段的名称
字段值	value		string	自定义模板字段的值
货币	currency		string	货币，例如 SEK
区域设置	locale		string	区域设置，例如 sv-SE
显示名称	display_name		string	定价表的显示名称
外部 ID	external_id		string	外部 ID 表示第三方系统中的摘要对象
表 ID	id		string	表 ID
预计算总计	pre_calculated		boolean	如果应预先计算定价表总计
显示名称	display_name		string	定价表的显示名称
ID	id		string	节 ID
Rows	rows			具有值对象的数组，其中包含column_id数组，值
已启用	enabled		boolean	是否应启用节折扣
统一费用	flat_fee		boolean	如果分区应使用统一费用折扣
折扣值	value		string	分区折扣的值
已启用	enabled		boolean	是否应启用节价格
统一费用	flat_fee		boolean	如果节应使用统一费用定价
价格值	value		string	分区价格的值
已启用	enabled		boolean	是否应启用节税
统一费用	flat_fee		boolean	如果节应使用统一费用税
税值	value		string	节税的值
已启用	enabled		boolean	是否应启用定价表折扣
统一费用	flat_fee		boolean	如果定价表应使用统一费用折扣
折扣值	value		string	摘要折扣的值
已启用	enabled		boolean	是否应启用定价表价格
统一费用	flat_fee		boolean	如果定价表应使用统一费用定价
价格值	value		string	摘要价格的值
已启用	enabled		boolean	如果应启用定价表税
统一费用	flat_fee		boolean	如果定价表应使用统一费用税
价值	value		string	摘要税的值
到期日期	expiration_date		date-time	文档应过期的日期和时间
外部 ID	external_id		string	用于标识的外部系统 ID
文件内容	file_content		string	Base64 编码的文件内容
文件 ID	file_ids		string	上传文件时收到的逗号分隔的唯一文件 ID
文件名	file_name		string	文档的文件名，扩展名。 这将有助于转换不同的文件类型。
文件 URL	file_url		string	文档文件的 URL。 文档必须公开才能下载
自动发送	is_automatic_sending		boolean	如果创建后应发送文档
发送提醒	is_reminder_sending		boolean	应发送自动提醒
计划发送	is_scheduled_sending		boolean	如果计划将来发送
对文档进行签名	is_signing		boolean	是否应发送文档进行签名
手写签名	is_signing_biometric		boolean	使用手写签名
允许签名传输	is_signing_forward		boolean	收件人是否能够转移签名权限
使用缩写进行签名	is_signing_initials		boolean	使用收件人缩写对文档进行签名
发送短信	is_sms_sending		boolean	文档是否应通过文本发送到收件人移动设备
文档名称	name	True	string	输入文档的名称
公司名称	company_name		string	收件人的公司名称
公司编号	company_number		string	收件人的公司编号
Email	email		string	收件人的电子邮件地址
名字	first_name		string	收件人名字
姓氏	last_name		string	收件人的姓氏
手机	mobile		string	采用国际格式的移动电话
注释	note		string	收件人的其他说明
签名顺序	order_num		integer	如果启用了签名顺序
收件人类型	role		string	文档中的收件人类型
模板角色	role_name		string	模板中角色的名称
验证 EID	verify_eid		boolean	使用 EID 进行验证
EID 类型	verify_eid_type		string	要用于个人验证的 EID 类型
启用问题	verify_qna		boolean	是否应提出问题
验证答案	verify_qna_answer		string	问题的答案
打开时的问题	verify_qna_open		boolean	打开文档前应提出问题
验证问题	verify_qna_question		string	要求验证的问题
签名问题	verify_qna_sign		boolean	签名前是否应提出问题
验证短信	verify_sms		boolean	通过短信验证收件人
在打开时验证短信	verify_sms_open		boolean	在打开时验证短信
通过短信进行验证	verify_sms_sign		boolean	在签名之前，短信应验证收件人
计划发送日期	scheduled_sending_time		date-time	应发送文档的日期和时间
发件人电子邮件替代	sender_email		string	从经过身份验证的用户以外的其他电子邮件发送
发件人用户替代	sender_id		string	从身份验证以外的其他用户发送
模板编号	template_id		string	选择要用于发送的模板
文档类型	type		string	设置文档的类型/类别
文档值	value		integer	交易或文档的值
视频 ID	video_id		string	选择要用于发送的视频

返回

文档是一个或多个上传的文件，要发送给用户创建的一个或多个收件人。

文档

Document

创建用户

操作 ID:

CreateUser

这将在数据库中为当前实体创建新联系人

参数

名称	密钥	必需	类型	说明
company_name	company_name		string	关联公司名称
company_number	company_number		string	关联公司编号
电子邮件	email		string	联系人的电子邮件地址
first_name	first_name		string	联系人的名字
fullname	fullname		string	用于指定全名而不是名字/姓氏
last_name	last_name		string	联系人的姓氏
移动	mobile		string	国际格式的移动电话号码
注意	note		string	联系人的可选内部说明
phone	phone		string	国际格式的电话号码
title	title		string	联系人的标题，例如 CEO，销售经理

返回

用户由其电子邮件地址定义，并连接到一个或多个实体。

用户角色

管理员：

• 查看所有文档
• 编辑所有文档
• 更改实体设置、信息和计费
• 将新用户添加到实体
• 分配实体角色

经理：

• 查看团队文档
• 编辑所有文档
• 将新用户添加到实体

实体

实体是顶部节点，所有用户和相应的文档都连接到实体。 实体通常与大型组织中的公司、国家/地区或部门相同。

用户

User

创建联系人

操作 ID:

CreateContact

这将在数据库中为当前实体创建新联系人

参数

名称	密钥	必需	类型	说明
公司名称	company_name		string	关联公司名称
公司编号	company_number		string	关联公司编号
Email	email		string	联系人的电子邮件地址
名字	first_name		string	联系人的名字
全名	fullname		string	用于指定全名而不是名字/姓氏
姓氏	last_name		string	联系人的姓氏
手机	mobile		string	国际格式的移动电话号码
注释	note		string	联系人的可选内部说明
电话	phone		string	国际格式的电话号码
Title	title		string	联系人的标题，例如 CEO，销售经理

返回

名称	路径	类型	说明
触点 ID	contact_id	string	创建的联系人的 ID

发送现有文档

操作 ID:

SendDocument

通过 GetAccept 发送文档时，我们会向所有收件人（每个收件人都包含唯一的安全链接）发送电子邮件。 此 API 调用会触发文档发送作，并且只能在document_status = 草稿的文档上执行。 文档将发送给创建文档时提供的收件人。

如果使用自签名选项创建文档，在发送之前，该文档也将由经过身份验证或指定的用户自行签名。

参数

名称	密钥	必需	类型	说明
文档 ID	documentId	True	string	文档 ID
sender_email	sender_email		email	使用此地址可以指定用于对文档进行自签名的发件人用户/所有者。
sender_id	sender_id		string	使用此 ID 指定要用于对文档进行自签名的发件人用户/所有者。

返回

文档是一个或多个上传的文件，要发送给用户创建的一个或多个收件人。

文档

Document

更新文档过期时间

操作 ID:

UpdateExpiration

使用此方法更新文档的到期日期和时间。

参数

名称	密钥	必需	类型	说明
文档 ID	documentId	True	string	文档 ID
到期日期	expiration_date		date-time	文档应过期的日期和时间（UTC）
发送通知	send_notification		boolean	是否应向收件人发送有关更新的通知

返回

名称	路径	类型	说明
状态	status	integer	更新状态

获取文档字段

操作 ID:

ListDocumentFields

获取文档或模板的字段列表。 可以在文档签名之前和之后使用。

参数

名称	密钥	必需	类型	说明
文档 ID	documentId	True	string	文档 ID

返回

字段列表

Fields

Fields

获取文档收件人

操作 ID:

ListRecipients

获取特定文档的收件人列表。

参数

名称	密钥	必需	类型	说明
文档 ID	documentId	True	string	文档 ID

返回

收件人列表

收件人

Recipients

获取文档详细信息

操作 ID:

GetDocumentDetails

通过指定文档 ID 获取文档详细信息。

参数

名称	密钥	必需	类型	说明
文档 ID	documentId	True	string	文档 ID

返回

文档是一个或多个上传的文件，要发送给用户创建的一个或多个收件人。

文档

Document

获取文档附件

操作 ID:

GetDocumentAttachments

通过指定文档 ID 获取文档附件。

参数

名称	密钥	必需	类型	说明
文档 ID	documentId	True	string	文档 ID

返回

附件列表

附件

Attachments

获取模板字段

操作 ID:

ListFields

接收特定模板的字段列表。

参数

名称	密钥	必需	类型	说明
模板编号	templateId	True	string	模板编号

返回

字段列表

Fields

Fields

获取模板定价表

操作 ID:

GetPricingTables

接收特定模板的定价表项列表。

参数

名称	密钥	必需	类型	说明
模板编号	templateId	True	string	模板编号

返回

定价表

Pricing

PricingTables

获取模板角色

操作 ID:

ListRoles

接收特定模板的角色列表。

参数

名称	密钥	必需	类型	说明
模板编号	templateId	True	string	模板编号

返回

名称	路径	类型	说明
roles	roles	array of object
电子邮件	roles.email	string
first_name	roles.first_name	string
last_name	roles.last_name	string
移动	roles.mobile	string
角色	roles.role	string
role_id	roles.role_id	string
role_name	roles.role_name	string

获取用户详细信息

操作 ID:

GetUserDetails

此调用将返回单个用户的详细信息。 使用用户 ID 我接收当前经过身份验证的用户的详细信息和可用实体

参数

名称	密钥	必需	类型	说明
用户 ID	userId	True	string	用户 ID

返回

用户由其电子邮件地址定义，并连接到一个或多个实体。

用户角色

管理员：

• 查看所有文档
• 编辑所有文档
• 更改实体设置、信息和计费
• 将新用户添加到实体
• 分配实体角色

经理：

• 查看团队文档
• 编辑所有文档
• 将新用户添加到实体

实体

实体是顶部节点，所有用户和相应的文档都连接到实体。 实体通常与大型组织中的公司、国家/地区或部门相同。

用户

User

触发器

文档签名后	当文档已由所有签名方签名时触发
文档被拒绝时	当任何收件人拒绝文档时触发
查看文档后	当任何收件人审阅文档时触发
订阅文档事件	此调用将创建新的订阅。 响应将包装在数组中，即使针对单个对象，也根据 REST 挂钩标准。 事件 document.created - 文档已创建 document.sent - 发送文档 document.viewed - 发送文档 document.signed - 文档已签名 document.approved - 已批准文档 document.expired - 文档已过期 document.rejected - 文档被拒绝 document.downloaded - 下载文档 document.printed - 打印文档 document.forwarded - 已转发文档 document.partially_signed - 文档已部分签名 document.commented - 文档已注释 document.hardbounced - 文档已硬启动 document.imported - 导入文档

文档签名后

操作 ID:

CreateSignedSubscription

当文档已由所有签名方签名时触发

参数

名称	密钥	必需	类型	说明
所有实体用户	global		boolean	如果 Webhook 应捕获所有实体用户的事件。
错误电子邮件	notification_email		string	如果事件失败，请向此电子邮件发送通知，而不是发送方
有效负载	payload		string	要发布的其他有效负载数据

返回

Webhook 负载

Webhook

Webhook

文档被拒绝时

操作 ID:

CreateRejectedSubscription

当任何收件人拒绝文档时触发

参数

名称	密钥	必需	类型	说明
所有实体用户	global		boolean	如果 Webhook 应捕获所有实体用户的事件。
错误电子邮件	notification_email		string	如果事件失败，请向此电子邮件发送通知，而不是发送方
有效负载	payload		string	要发布的其他有效负载数据

返回

Webhook 负载

Webhook

Webhook

查看文档后

操作 ID:

CreateReviewedSubscription

当任何收件人审阅文档时触发

参数

名称	密钥	必需	类型	说明
所有实体用户	global		boolean	如果 Webhook 应捕获所有实体用户的事件。
错误电子邮件	notification_email		string	如果事件失败，请向此电子邮件发送通知，而不是发送方
有效负载	payload		string	要发布的其他有效负载数据

返回

Webhook 负载

Webhook

Webhook

订阅文档事件

操作 ID:

CreateSubscription

此调用将创建新的订阅。 响应将包装在数组中，即使针对单个对象，也根据 REST 挂钩标准。

事件

• document.created - 文档已创建
• document.sent - 发送文档
• document.viewed - 发送文档
• document.signed - 文档已签名
• document.approved - 已批准文档
• document.expired - 文档已过期
• document.rejected - 文档被拒绝
• document.downloaded - 下载文档
• document.printed - 打印文档
• document.forwarded - 已转发文档
• document.partially_signed - 文档已部分签名
• document.commented - 文档已注释
• document.hardbounced - 文档已硬启动
• document.imported - 导入文档

参数

名称	密钥	必需	类型	说明
选择事件	event	True	string	事件触发器
所有实体用户	global		boolean	如果 Webhook 应捕获所有实体用户的事件。
错误电子邮件	notification_email		string	如果事件失败，请向此电子邮件发送通知，而不是发送方
有效负载	payload		string	要发布的其他有效负载数据

返回

Webhook 负载

Webhook

Webhook

定义

附件

文档附件

名称	路径	类型	说明
访问收件人	access_recipient_names	array of string	有权访问附件的收件人
Description	attachment_description	string	附件的说明
下载 URL	attachment_download_url	string	用于下载附件的 URL
文件扩展名	attachment_extension	string	附件的文件扩展名
Filename	attachment_filename	string	附件的文件名
ID	attachment_id	string	附件的 ID
预览 URL	attachment_preview_url	string	用于预览附件的内部 URL
Title	attachment_title	string	附件的标题
类型	attachment_type	string	附件的类型
URL	attachment_url	string	附件的 URL
最后一个视图	last_attachment_view	string	上次查看附件的日期和时间
受限访问	restrict_access	boolean	附件具有受限访问权限

附件

附件列表

名称	路径	类型	说明
attachments	attachments	array of Attachment

联系人​​

每个唯一的电子邮件地址（或手机号码）都定义为联系人。

名称	路径	类型	说明
公司 ID	company_id	string	公司 ID
公司徽标	company_logo_url	string	公司徽标
公司名称	company_name	string	联系人的公司名称
公司编号	company_number	string	联系人的公司编号
触点 ID	contact_id	string	触点 ID
已创建	created_at	string	创建联系人的日期
文档	document_count	number	联系人的文档数
联系人电子邮件	email	string	已创建文档的名称
名字	first_name	string	联系人的名字
全名	fullname	string	联系人的全名
性别	gender	string	收件人的性别
姓氏	last_name	string	联系人的姓氏
手机	mobile	string	联系人的移动电话号码
注释	note	string	联系人说明
Thumb URL	thumb_url	string	联系人的拇指 URL
Title	title	string	联系人的标题

联系人

联系人列表

名称	路径	类型	说明
contacts	contacts	array of Contact

文档

文档是一个或多个上传的文件，要发送给用户创建的一个或多个收件人。

名称	路径	类型	说明
标记	tags	string	文档标记
自动聊天文本	auto_comment_text	string	自动聊天文本
公司名称	company_name	string	公司名称
创建时间	created_at	string	创建文档时
下载 URL	download_url	string	用于下载已签名文档的 URL
电子邮件	email_send_message	string	发送电子邮件
电子邮件主题	email_send_subject	string	电子邮件主题文本
到期日期	expiration_date	string	文档到期日期
外部客户端 ID	external_client_id	string
外部编辑器 ID	external_editor_id	string	外部编辑器中的 ID
外部编辑器类型	external_editor_type	string
外部 ID	external_id	string
字段计数	field_count	integer	文档中的字段数
ID	id	string
自动注释	is_auto_comment	boolean	如果启用了自动聊天注释
自动批注电子邮件	is_auto_comment_email	boolean	如果启用了自动聊天电子邮件
标识收件人	is_identify_recipient	boolean	如果文档已启用标识收件人
是专用的	is_private	boolean	如果文档为专用文档
发送提醒	is_reminder_sending	boolean	如果启用了自动提醒
计划发送	is_scheduled_sending	boolean	如果文档已计划发送
自签名	is_selfsign	boolean	如果文档已由发件人自签名
已签名	is_signed	boolean	如果文档已签名
可签名文档	is_signing	boolean	如果文档可签名
手写签名	is_signing_biometric	boolean	如果启用了手写签名
允许签名传输	is_signing_forward	boolean	如果启用了签名权限转移
签名顺序	is_signing_order	boolean	如果启用了收件人签名订单
有视频	is_video	boolean	如果文档有简介视频
Name	name	string	文档名称
父 ID	parent_id	string	以前的文档版本的 ID
预览 URL	preview_url	string	指向文档内部预览的链接
recipients	recipients	array of Recipient
计划发送时间	scheduled_sending_time	string	计划发送文档的时间
发送日期	send_date	string	文档发送日期
发件人电子邮件	sender_email	string	发件人用户的电子邮件地址
发件人名称	sender_name	string	发件人用户的名称
发送方指纹 URL	sender_thumb_url	string	发送方用户的拇指图像
签名日期	sign_date	string	文档签名日期
状态	status	string	文档的当前状态
Thumb URL	thumb_url	string	文档的拇指图像
类型	type	string	文档类型
唯一 ID	unique_id	integer	文档的唯一 ID
用户 ID	user_id	string	发送方用户的 ID
价值	value	integer	文档的值

文档

文档列表

名称	路径	类型	说明
tags	tags	string
company_name	company_name	string
创建时间	created_at	string
expiration_date	expiration_date	string
id	id	string
is_private	is_private	boolean
is_signing	is_signing	boolean
姓名	name	string
sender_name	sender_name	string
sender_thumb	sender_thumb	string
状态	status	string
类型	type	string
value	value	integer

EditorField

编辑器字段详细信息

名称	路径	类型	说明
ID	id	string	ID
标签	input_settings.label	string	标签
选项	input_settings.options	array of string	选项
必选	input_settings.required	boolean	必选
类型	input_settings.type	string	类型
收件人 ID	recipient_id	string	收件人 ID
类型	type	string	类型
用户 ID	user_id	string	用户 ID

领域

字段详细信息

名称	路径	类型	说明
公司名称	company_name	string	公司名称
公司编号	company_number	string	公司编号
字段 ID	field_id	string	字段 ID
标签	field_label	string	标签
选项	field_options	array of object	选项
价值	field_options.value	string
类型	field_type	string	类型
价值	field_value	string	价值
is_collectable	is_collectable	boolean	收集字段
is_editable	is_editable	boolean	可编辑字段
is_required	is_required	boolean	必填字段
页面 ID	page_id	string	页面 ID
收件人 ID	recipient_id	string	收件人 ID
收件人姓名	recipient_name	string	收件人姓名
角色名称	role_name	string	角色名称

Fields

字段列表

名称	路径	类型	说明
editor_fields	editor_fields	array of EditorField
fields	fields	array of Field

PricingColumn

定价表列

名称	路径	类型	说明
ID	column_id	string	ID
显示名称	display_name	string	显示名称
已启用	enabled	boolean	已启用
Name	name	string	Name

PricingSection

定价表部分

名称	路径	类型	说明
columns	columns	array of PricingColumn
显示名称	display_name	string	显示名称
Name	name	string	Name
ID	section_id	string	ID

PricingTable

定价表

名称	路径	类型	说明
货币	currency_settings.currency	string	货币
区域设置	currency_settings.locale	string	区域设置
预计算总计	pre_calculated	boolean	预计算总计
部分	sections	array of PricingSection
ID	table_id	string	表 ID

PricingTables

定价表

名称	路径	类型	说明
pricing_tables	pricing_tables	array of PricingTable

Recipient

连接到文档的每个唯一电子邮件地址（或手机号码）都是收件人。

名称	路径	类型	说明
公司名称	company_name	string	收件人的公司名称
公司编号	company_number	string	收件人的公司编号
文档 URL	document_url	string	要查看/签名的收件人的唯一 URL
收件人电子邮件	email	string	收件人的电子邮件
名字	first_name	string	收件人的名字
全名	fullname	string	收件人的全名
性别	gender	string	收件人的性别
ID	id	string	收件人的 ID
姓氏	last_name	string	收件人的姓氏
手机	mobile	string	收件人的移动电话号码
注释	note	string	收件人备注
签名顺序 num	order_num	string	收件人的签名顺序
状态	status	string	收件人的状态
Thumb URL	thumb_url	string	收件人的 Thumb URL
Title	title	string	收件人的标题

收件人

收件人列表

名称	路径	类型	说明
recipients	recipients	array of Recipient

用户

用户由其电子邮件地址定义，并连接到一个或多个实体。

用户角色

管理员：

• 查看所有文档
• 编辑所有文档
• 更改实体设置、信息和计费
• 将新用户添加到实体
• 分配实体角色

经理：

• 查看团队文档
• 编辑所有文档
• 将新用户添加到实体

实体

实体是顶部节点，所有用户和相应的文档都连接到实体。 实体通常与大型组织中的公司、国家/地区或部门相同。

名称	路径	类型	说明
应用模式	app_mode	string
disallow_create	disallow_create	boolean
Email	email	string	用户电子邮件地址
实体 ID	entity_id	string
实体名称	entity_name	string
名字	first_name	string	用户的名字
ID	id	string	用户的 ID
语言	language	string
姓氏	last_name	string	用户的姓氏
移动	mobile	string	国际格式的移动电话号码
注释	note	string	用户可选内部说明
电话	phone	string	国际格式的电话号码
角色	role	string
跳过发送邀请	skip_invitation	boolean
状态	status	string
团队 ID	team_id	string
Thumb URL	thumb_url	string
Timezone	timezone	string
Title	title	string	用户的标题，例如 CEO，销售经理

用户

用户列表

名称	路径	类型	说明
users	users	array of object
Email	users.email	string
名字	users.first_name	string
上次登录	users.last_login	string
姓氏	users.last_name	string
用户名	users.name	string
角色	users.role	string
状态	users.status	string
工作组名称	users.team_name	string
用户 ID	users.user_id	string

Webhook

Webhook 负载

名称	路径	类型	说明
自定义字段	custom_fields	object
文档	document	Document	文档是一个或多个上传的文件，要发送给用户创建的一个或多个收件人。
实体自定义域	entity.custom_domain	string	实体的自定义域设置
默认电子邮件	entity.email_send_message	string	默认电子邮件
默认电子邮件主题	entity.email_send_subject	string	默认电子邮件主题
实体子域	entity.sub_domain	string	实体的子域
事件名称	event	string
事件作	event_action	string
事件类型	event_type	string
Recipient	recipient	Recipient	连接到文档的每个唯一电子邮件地址（或手机号码）都是收件人。
订阅编号	subscription_id	string