上次更新日期：
2026年7月8日
以下是 v5 REST API 事件的详细列表。
| 事件类型 | 说明 |
| 已创建 | 创建协议或草稿时 |
| AGREEMENT_MODIFIED | 发送方修改协议 [在进行过程中修改文档] |
| USER_ACK_AGREEMENT_MODIFIED | 签名方在签名前确认修改时 |
| SIGNED | 协议通过书面签名流程完成签署 |
| ESIGNED | 当协议使用电子签名签署时 |
| DIGSIGNED | 使用数字签名签署协议时 |
| APPROVED | 协议获得审批时 |
| ACCEPTED | 协议被接受时 |
| DELIVERED | 协议交付时 |
| FORM_FILLED | 协议填写完成时 |
| OFFLINE_SYNC | 使用移动设备离线签署协议时 |
| UPLOADED_BY_SENDER | 发送方使用电子签名工作流程上传已签名协议时 |
| FAXED_BY_SENDER | 发送方使用传真工作流程上传已签名协议时 |
| SIGNATURE_REQUESTED | 当协议被发送给收件人进行签署时 |
| APPROVAL_REQUESTED | 当协议被发送给收件人进行审批时 |
| ACKNOWLEDGEMENT_REQUESTED | 当协议被发送给收件人进行确认时 |
| FORM_FILLING_REQUESTED | 当协议被发送给收件人进行表单填写时 |
| ACCEPTANCE_REQUESTED | 当协议发送给收件人供其接受时 |
| RECALLED | 当协议被发送方取消时 |
| REJECTED | 当协议被收件人拒绝时 |
| EXPIRED | 当发送方设置了自定义过期时间/日期且协议超过该时间/日期时 |
| EXPIRED_AUTOMATICALLY | 当协议自动过期时 |
| 已共享 | 当协议被参与者共享时 |
| EMAIL_VIEWED | 当收件人查看请签署电子邮件时 |
| EMAIL_BOUNCED | 当电子邮件从收件人的邮件服务器退回时 |
| AUTO_CANCELLED_CONVERSION_PROBLEM | 当协议转化失败导致协议自动取消时 |
| PASSWORD_AUTHENTICATION_FAILED | 当密码身份验证失败时 |
| KBA_AUTHENTICATION_FAILED | 当 KBA 身份验证失败时 |
| KBA_AUTHENTICATED | 当 KBA 身份验证通过时 |
| WEB_IDENTITY_AUTHENTICATED | 当 Web Identity 身份验证通过时 |
| WEB_IDENTITY_SPECIFIED | 当请求 Web Identity 身份验证时 |
| WIDGET_ENABLED | 当网页表单从禁用状态变为启用时 |
| WIDGET_DISABLED | 当网页表单从启用状态变为禁用时 |
| 已委派 | 当协议被接收者委托时 |
| AUTO_DELEGATED | 当协议因自动委派而被转交时 |
| REPLACED_SIGNER | 当协议接收者被发送者替换时 |
| VAULTED | 当协议启用了存储库功能并向提供的存储库发送回调以执行存储时 |
| DOCUMENTS_DELETED | 当启用数据治理策略并删除协议文档时 |
| DRAFT_MODIFIED | 草稿状态的协议已被修改 |
| ACCESS_CODE_GENERATED | 当生成访问权限代码以授权访问接收者的电子签名页面时 |
| ACCESS_CODE_CONSUMED | 每次签署者提交 ACCESS_CODE_GENERATED 时，都会记录 ACCESS_CODE_CONSUMED 事件。 |
| ACTION_AUTO_DELEGATED | 请参阅 AUTO_DELEGATED（此处添加"action"前缀，表示消息应基于角色）。 |
| ACTION_COMPLETED | 这是不符合任何特殊情况条件的通用情况：ACTION_COMPLETED_OFFLINE_HOSTED、ACTION_COMPLETED_OFFLINE、ACTION_COMPLETED_HOSTED、ACTION_COMPLETED_WIDGET_VERIFIED_API_TOKEN、ACTION_COMPLETED_WIDGET_VERIFICATION_WAIVED、ACTION_COMPLETED_WIDGET_VERIFIED |
| ACTION_COMPLETED_HOSTED | 在线托管 |
| ACTION_COMPLETED_OFFLINE | 通用离线签名情况 |
| ACTION_COMPLETED_OFFLINE_HOSTED | 使用 API 主机离线电子签名 |
| ACTION_COMPLETED_WIDGET_VERIFIED | 签名者完成了正常的电子邮件验证。 仅当网页表单签名者是第一个参与者时。后续签名者触发 ESIGNED 事件。 |
| ACTION_COMPLETED_WIDGET_VERIFIED_API_TOKEN | 这是在网页表单电子签名后，用户通过 API 令牌验证其签名之后发生的情况 |
| ACTION_COMPLETED_WIDGET_VERIFICATION_WAIVED | 当发送者不要求对其小组件进行电子邮件验证时会发生这种情况 |
| ACTION_DELEGATED | 请参阅 DELEGATED，此处添加"action"前缀，表示消息应基于角色。 |
| ACTION_REPLACED_SIGNER | 签名者已被发送者替换。 |
| ACTION_REQUESTED | 旧的特定角色事件已合并为一个事件（ACKNOWLEDGMENT_REQUESTED、ACCEPTANCE_REQUESTED、APPROVAL_REQUESTED、FORM_FILLING_REQUESTED、SIGNATURE_REQUESTED）。这样做是因为我们不需要也不想要特定于角色的事件。客户端可以从参与中获得该信息，这将大大增加上述"已完成"的变体数量。为了与此匹配，这些"...已请求"事件被展平以进行匹配。 |
| CREATED_FROM_WIDGET | 当用户使用网页表单时，协议在签名时创建。 |
| CREATED_OFFLINE | 当协议或草稿离线创建时 |
| CREATED_VIA_UPLOAD | 请参阅 CREATED。这是 acrobat/reader 中的"传递文档"功能。（"协议上传者"） |
| CREATED_VIA_ACROBAT | 请参阅 CREATED。这是从 Acrobat（嵌入式发送页面）使用时的 Acrobat"发送以供签名"功能。（"协议从 Acrobat 上传者"） |
| CREATED_VIA_READER | 请参阅 CREATED。这是从 Acrobat（嵌入式发送页面）使用时的 Reader"发送以供签名"功能。（"协议从 Reader 上传者"） |
| ACTIVATED | %s 被以下用户激活 |
| DIGITAL_SIGN_UIDAI_SIGNER_CONSENT | UIDAI 用户同意事件 |
| DEACTIVATED | %s 被以下用户停用 |
| DOWNLOADED | 文档下载者 |
| FAXIN_RECEIVED | 已收到传真签名。 |
| 修改日期 | 处于草稿状态的协议可以包含以下事件类型：CREATED、MODIFIED、CANCELLED、FINALIZED、DELETED，但只返回 CREATED 和 MODIFIED。FINALIZED 作为 MODIFIED 返回，DELETED 则被隐藏。 |
| 其他 | 将来，可能会向 EchoSign 应用程序添加上述状态以外的其他状态。出于向后兼容性考虑，现有 API 客户端将收到状态 OTHER。在这种情况下，您可能需要将客户端应用程序更新至最新版本的 API 以接收新状态。 |
| 已支付 | 付款人 |
| PRESIGNED | 协议已由以下人员签署 |
| RECALLED_MAX_SIGNING_KBA_ATTEMPTS | 由于 KBA 尝试次数超限而自动取消。这曾经是 "MAX_SIGNING_KBA_ATTEMPTS_EXCEEDED" 事件。 |
| RECALLED_MAX_SIGNING_PASSWORD_ATTEMPTS | 由于密码尝试次数超限而自动取消。这曾经是 "MAX_SIGNING_PASSWORD_ATTEMPTS_EXCEEDED" 事件。 |
| RECALLED_MAX_SIGNING_PHONE_ATTEMPTS | 由于电话尝试次数超限而自动取消。这曾经是 "MAX_SIGNING_PHONE_ATTEMPTS_EXCEEDED" 事件。 |
| SENDER_CREATED_NEW_REVISION | 已创建文档的新修订版本。 |
| SIGNING_URL_REQUESTED | 签名 URL 已被以下用户请求： |
| READY_TO_VAULT | 协议已准备好存储 |
| WRITTEN_DOWNLOAD | 协议已由以下人员下载以供签名 |
| 书面签名 | 协议已由以下人员手动签名 |
协议状态列表如下：
状态 |
说明 |
等待签名 |
协议发送供签名时 |
已签名 |
当协议签署时 |
已批准 |
协议获得批准时 |
已中止 |
已取消或删除的协议 |
已过期 |
协议过期时 |
已存档 |
协议存档时 |
预填 |
协议处于预填状态且发件人需要预填某些字段时 |
制作中 |
当协议处于编写状态时 |
等待验证 |
通过网页表单创建协议且网页表单签名者尚未验证其电子邮件时 |
等待审批 |
协议等待审批时 |
DELIVERED |
经过认证的收件人确认协议时 |
ACCEPTED |
接受者接受协议时 |
FORM_FILLED |
表单填写者填写协议时 |
派送中 |
当协议已发出待确认时 |
已发出待接受 |
当协议已发出待接受时 |
已发出待填写表单 |
当协议处于表单填写阶段时 |
