上次更新時間
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_AUTOMATICALLY | 當合約自動到期時 |
| 已共用 | 當合約已被參與者共用時 |
| EMAIL_VIEWED | 當收件人檢視「請簽署」郵件時 |
| EMAIL_BOUNCED | 當電子郵件從收件人的郵件伺服器退回時 |
| AUTO_CANCELLED_CONVERSION_PROBLEM | 當合約轉換失敗導致合約自動取消時 |
| PASSWORD_AUTHENTICATION_FAILED | 當密碼驗證失敗時 |
| KBA_AUTHENTICATION_FAILED | 當 KBA 驗證失敗時 |
| KBA_AUTHENTICATED | 當 KBA 驗證通過時 |
| 網頁身分驗證成功 | 當網頁身分驗證通過時 |
| 已指定網頁身分驗證 | 當要求網頁身分驗證時 |
| WIDGET_ENABLED | 當網頁表單從已停用狀態變更為已啟用狀態時 |
| WIDGET_DISABLED | 當網頁表單從已啟用狀態變更為已停用狀態時 |
| 已委派 | 當收件者委派合約時 |
| 自動委派 | 當合約因自動委派而遭到委派時 |
| 已更換簽署者 | 當寄件者更換合約收件者時 |
| 已保存至保存庫 | 當合約已啟用保存庫功能，且系統將回呼傳送至指定的保存庫以執行保存作業時 |
| 已刪除文件 | 當資料治理原則已啟用，且合約的文件已刪除時 |
| 草稿已修改 | 處於草稿狀態的合約已修改 |
| 已產生存取碼 | 當為收件者產生存取碼以授與 eSign 頁面的存取權時。 |
| 已使用存取碼 | 每次簽署者提交 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)。這樣做是因為我們不需要或不想要角色特定事件。 客戶可以從參與中取得該資訊，這將大幅增加上述「COMPLETED」的變化版本數量。 為了符合該情況，這些「...REQUESTED」事件已扁平化以符合。 |
| CREATED_FROM_WIDGET | 當使用者使用網頁表單時，合約會在簽署時建立 |
| CREATED_OFFLINE | 當合約或草稿在離線狀態下建立時 |
| CREATED_VIA_UPLOAD | 請參閱 CREATED。這是 Acrobat/Reader 中的「傳遞文件」功能。(「合約上傳者」) |
| CREATED_VIA_ACROBAT | 請參閱 CREATED。這是在 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 |
當協議已由表單填寫者填寫時 |
等待投遞 |
當協議等待確認時 |
待接受 |
當協議等待接受時 |
待填寫表單 |
當協議等待表單填寫時 |
