Foxit 電子簽約（預覽）

Foxit eSign 是一款電子簽名解決方案，讓您能在線傳送、簽署及管理文件，省去列印、掃描或郵寄的需求。 上傳您的文件，定義簽名欄位，並寄送給收件人，以快速且具法律效力的電子簽名。

此連接器適用於以下產品和區域：

服務 Class Regions
Copilot Studio 進階 除以下部分外，所有Power Automate區域：
     - 美國政府 （GCC）
     - 美國政府（海灣合作委員會高中）
     - 由 21Vianet 營運的中國雲
     - 美國國防部 （DoD）
邏輯應用程式 標準 所有 Logic Apps 區域， 但下列區域除外：
     - Azure Government regions
     - Azure中國地區
     - 美國國防部 （DoD）
Power Apps 進階 除以下部分外，所有Power Apps區域
     - 美國政府 （GCC）
     - 美國政府（海灣合作委員會高中）
     - 由 21Vianet 營運的中國雲
     - 美國國防部 （DoD）
Power Automate（自動化服務） 進階 除以下部分外，所有Power Automate區域：
     - 美國政府 （GCC）
     - 美國政府（海灣合作委員會高中）
     - 由 21Vianet 營運的中國雲
     - 美國國防部 （DoD）
連絡人​​
名稱 Foxit eSign 支援
URL https://www.foxit.com
Email api@foxit.com
連接器中繼資料
Publisher Foxit 軟體公司
網站 https://www.foxit.com/esign-pdf/
隱私策略 https://www.foxit.com/company/privacy-policy.html
類別 生產力;內容和文件

福克西特電子信訊

Foxit eSign 是一款企業級電子簽章解決方案，讓企業能完全在線傳送、簽署及管理具法律效力的文件，免除列印、掃描或郵寄的需求。 上傳您的文件，定義簽名欄位，並寄送給收件人，以便快速且安全地完成電子簽章。 Foxit eSign 完全符合包括 ESIGN 和 UETA 在內的主要電子簽章法規，使用加密技術保護文件在運送中及靜止狀態，並支援多重身份驗證，確保只有授權簽署者才能存取並簽署您的文件。

Foxit eSign for Microsoft Power Automate 連接器讓您能自動化完整的文件簽署流程——從建立信封並送出簽名，到追蹤狀態、下載已完成的文件、管理範本，以及在信封事件發生時觸發下游操作。

Publisher：Foxit Corporation

Prerequisites

要使用此連接器，您需要：

  • Microsoft Power Apps或Power Automate方案，附有客製化接頭或高級接頭接入
  • Foxit eSign 帳號 — 在這裡建立一個
  • 您的 Foxit eSign 帳戶已啟用 API 存取（詳見下方取得憑證）

取得憑證

  1. 如果你還沒有 Foxit eSign 帳號，請註冊一個。
  2. 請聯絡 Foxit 銷售團隊，申請在您的帳戶上啟用 API 存取權。 一旦核准，API 存取權將在你的帳戶上啟用。
  3. 在 Power Automate 中，在連接器列表中搜尋 Foxit eSign，並選擇建立連線。
  4. 您將被導向至 Foxit eSign 登入頁面。 請使用您的 Foxit eSign 登入憑證以授權連線。
  5. 一旦授權，連線即可在你的流程中使用。

使用者入門

建立連線後，你可以開始使用 Foxit eSign 連接器建立流程：

  • 當信封事件發生時（例如所有當事人都已簽署）時，使用 觸發器 自動啟動流程。
  • 使用 動作 建立信封、發送簽名提醒、下載已完成的文件、管理範本等。
  • 串連多個動作——例如，從範本建立信封，等待觸發器完全執行，然後下載簽署文件並存入 SharePoint。

支援的觸發器

Trigger Description
當信封寄出時 當信封寄給收件人時會觸發。 需要將 Webhook 等級設定為 帳戶。
當信封被查看時 當收件人打開並查看信封時會觸發。
當信封被簽署時 當收件人簽署信封時會點火。
當包絡被取消時 當收件人或寄件人取消信封時，會觸發警報。
當信封完全執行時 當所有收件人簽名且信封完整完成後，才會點火。
當信封被刪除時 當信封被刪除時會觸發。

支援的動作

信封

動作 Description
從網址建立信封 使用公開可存取的 PDF URL 建立並寄送信封。
從 Base64 建立信封 使用 Base64 編碼的 PDF 文件建立並寄送信封。
從範本建立信封 從現有的 Foxit eSign 範本建立並寄送信封。
獲取信封詳情 取得信封的完整細節及當前狀態。
取得信封ID 根據濾波條件擷取包絡 ID 清單。
發送簽名提醒 向待簽收信封的通知人發送提醒通知。
下載信封檔案 下載所有已簽署的文件，並以壓縮檔形式下載信封。
下載單一文件 PDF 從信封下載一份文件，格式為 PDF。
將信封移至回收桶 將一個或多個信封移至回收桶。
取消信封 取消信封並通知收件人。
刪除信封 永久刪除一個或多個信封。
取得信封活動歷史 取得信封的完整活動日誌。
取得已刪除的信封歷史 可取得帳戶中刪除信封的紀錄。

範本

動作 Description
從網址建立範本 使用公開可存取的 PDF URL 建立可重複使用的簽署範本。
從 Base64 建立範本 使用 Base64 編碼的 PDF 文件建立可重複使用的簽署範本。
取得範本詳情 擷取特定範本的完整細節，包括欄位定義。
依範本 ID 取得範本 透過 ID 取得一個或多個範本的詳細資訊。
取得所有範本清單 取得帳號中所有可用的範本。

Webhooks

動作 Description
列出所有 Webhook 頻道 回傳帳號中所有已設定的 webhook 通道清單。
取得 Webhook 頻道詳情 擷取特定 webhook 頻道的詳細資訊。

電子郵件群組

動作 Description
建立電子郵件群組 建立一個新的電子郵件群組，作為信封中的收件人使用。
獲取電子郵件群組詳情 取得電子郵件群組的詳細資訊與成員資料。

報告

動作 Description
下載報告 下載以 Microsoft Excel 格式的帳戶活動報告。

已知問題和限制

  • 速率限制：Foxit eSign API 允許 每個帳戶每 5 分鐘最多 4,000 次請求。 超出此限制的請求會收到 429 Too Many Requests 回應。 建議在流程中實作帶有指數退量的重試邏輯，以優雅地處理這件事。

  • 檔案大小限制：每份文件的最大檔案大小為 25 MB。 這個限制適用於單一檔案，不包括整個信封大小。

  • Webhook 自動取消訂閱：由於 Foxit eSign 網頁掛鉤刪除 API 的限制（使用 POST 方法而非 DELETE），Power Automate 無法在基於觸發器的流程被刪除或修改時自動清理 webhook 頻道訂閱。 在關閉流程時，請使用 「List All Webhook Channels」 動作來識別活躍頻道，並在停用流程時使用 Foxit eSign 入口網站移除訂閱。

  • 當信封發送時 — 僅限帳戶等級：「當信封發送時」觸發器僅在 Webhook 等級設為 帳戶時觸發。 對於在 API App 層級建立的包絡，它不會觸發。 設定此觸發器時，請務必選擇帳號等級。

  • 區域可用性：該連接器同時適用於北美（NA1）及歐盟區域帳戶。 設定連線時選擇正確的伺服器區域。 連接錯誤區域會導致認證失敗。

  • Base64 文件大小：使用 Base64 的建立信封或 Base64 的建立範本動作時，Base64 編碼的字串必須對應的原始檔案大小不得超過 25 MB。

支援

如需開發者支援，請聯絡 Foxit eSign 團隊。devsupport@foxitsoftware.com

若要提交支援案件，請造訪 https://kb.foxit.com/s/submit-a-case。

節流限制

名稱 呼叫 續約期間
每個連線的 API 呼叫 100 60 秒鐘

動作

下載信封檔案

從信封下載完成的文件作為檔案。
下載單一文件 PDF

從信封下載一份文件，格式為 PDF 檔案。
下載報告

下載信封活動報告，作為 Microsoft Excel 檔案。 使用篩選器依狀態、日期範圍、信封名稱、作者或簽名者縮小搜尋範圍。
依範本 ID 取得範本

透過 ID 取得一個或多個範本的詳細資訊。
列出所有 Webhook 頻道

回傳你帳號中所有已設定的 webhook 通道清單。
刪除信封

永久刪除一個或多個信封。
取得 Webhook 頻道詳情

擷取特定 webhook 頻道的詳細資訊。
取得信封 ID

回傳一份依狀態篩選的信封 ID 清單。 用這個來找特定州的信封。
取得信封活動歷史

取得信封的完整活動日誌，顯示收件人與寄件人所採取的所有行動。
取得已刪除的信封歷史

取得已刪除或移入回收站的信封歷史紀錄。
取得所有範本清單

會回傳你帳號中所有可用的範本清單。
取得範本詳情

取得特定範本的完整細節，包括欄位與收件人。
取消信封

取消寄出的信封。 收件人將無法再簽署這些文件。
取消訂閱 Webhook 觸發器

透過頻道 ID 刪除一個活躍的 webhook 頻道訂閱。 使用此操作來清理不再需要的 webhook 訂閱。
將信封移至回收桶

將一個或多個信封移至回收桶。 回收筒裡的信封不會永久刪除。
建立電子郵件群組

建立一個新的電子郵件群組，可以同時寄信封給多個收件人。
從 Base64 建立信封

使用 Base64 編碼的 PDF 文件建立並寄送信封。
從 Base64 建立範本

使用 Base64 編碼的 PDF 字串建立新範本。 當你的 PDF 檔案已經以 Base64 字串形式存在於流程中時，例如來自 SharePoint 或 OneDrive 文件時，請使用此方法。
從範本建立信封

使用現有範本建立並寄送信封。 收件人資料可自訂。
從網址建立信封

使用公開可存取的 PDF URL 建立並寄送信封。 提供文件網址及收件人資訊以啟動簽署程序。
從網址建立範本

使用公開可存取的 PDF URL 建立新範本。
獲取信封詳情

可取得信封的完整資料，包括狀態、收件人及文件。
獲取電子郵件群組詳情

取得現有電子郵件群組的詳細資訊。
發送簽名提醒

向待接收信封的收件人發送提醒通知，提示他們完成簽名。

下載信封檔案

作業識別碼：
DownloadEnvelopeFiles

從信封下載完成的文件作為檔案。

參數

名稱 機碼 必要 類型 Description
信封 ID
 folderId True string

你想下載文件信封的唯一識別碼。

傳回

response
binary

下載單一文件 PDF

作業識別碼：
DownloadSingleDocumentPDF

從信封下載一份文件，格式為 PDF 檔案。

參數

名稱 機碼 必要 類型 Description
信封 ID
 folderId True string

可下載文件信封的唯一識別碼。
文件編號
 docNumber True string

文件索引可下載，從1開始。

傳回

response
binary

下載報告

作業識別碼：
DownloadReport

下載信封活動報告，作為 Microsoft Excel 檔案。 使用篩選器依狀態、日期範圍、信封名稱、作者或簽名者縮小搜尋範圍。

參數

名稱 機碼 必要 類型 Description
envelopeStatus
 status string

我們用來篩選報告的資料夾狀態
創建日期
 creationDateFrom string

創世日期範圍的開始。 接受格式：YYYY-MM-DD。
創建日期至
 creationDateTo string

創立日期範圍結束。 接受格式：YYYY-MM-DD。
信封名稱
 folderName string

任何包含此字串的資料夾。
包含欄位
 includeFields string

將 true（true）設為 'true'，以包含報表中的包絡欄位值。 預設為「false」。
作者Email
 authorEmail string

請篩選報告，只包含由該作者電子郵件地址製作的信封。
簽署者電子郵件
 signerEmail string

請篩選報告，只包含該電子郵件地址為簽署人的信封。

傳回

報告檔案
binary

依範本 ID 取得範本

作業識別碼：
GetTemplatesbyTemplateIds

透過 ID 取得一個或多個範本的詳細資訊。

參數

名稱 機碼 必要 類型 Description
範本識別碼
 templateIds True array of integer

一組範本 ID 陣列需要取回。

傳回

名稱 路徑 類型 Description
Result
 result string

指出要求是否成功。
全模板
 total_templates integer

回傳的模板總數。
範本列表
 templateIdList object

一個以範本 ID 為關鍵字的範本資料映射。 每個條目都包含範本細節及其欄位。

列出所有 Webhook 頻道

作業識別碼：
ListallWebhookChannels

回傳你帳號中所有已設定的 webhook 通道清單。

傳回

名稱 路徑 類型 Description
Result
 result string

指出要求是否成功。
全頻道
 total_channel integer

帳號中已設定的 webhook 通道總數。
網路鉤頻道
 templatesList array of object

帳號內所有 webhook 頻道的清單。
頻道識別碼
 templatesList.channelId integer

webhook 通道的唯一識別碼。
公司編號
 templatesList.companyId integer

這個頻道所屬的公司帳號。
頻道名稱
 templatesList.channelName string

webhook 頻道的名稱。
Webhook 網址
 templatesList.webhookUrl string

當訂閱事件發生時，Foxit eSign 會呼叫的網址。
網鉤祕密
 templatesList.webhookSecret string

用於驗證 webhook 有效載荷的秘密金鑰。
建立日期
 templatesList.dateCreated integer

頻道創建日期，單位為 Unix 毫秒。
更新日期
 templatesList.dateUpdated integer

頻道最後更新的日期，以 Unix 毫秒計。
Webhook 層級
 templatesList.webhookLevel string

Webhook 頻道的範圍。 要麼是「帳戶」（所有信封的觸發器），要嘛是「API App」（只觸發透過 API 建立的信封）。
現況
 templatesList.status string

頻道目前的狀態。 要麼是「主動」，要麼是「非活躍」。
寄出的信封
 templatesList.eventsSubscribedMap.folder_sent boolean

當信封寄給收件人時會觸發。
已檢視的信封
 templatesList.eventsSubscribedMap.folder_viewed boolean

當收件人打開信封時觸發。
信封簽名
 templatesList.eventsSubscribedMap.folder_signed boolean

當信封由收件人簽名時觸發。
信封取消
 templatesList.eventsSubscribedMap.folder_cancelled boolean

當信封被取消時觸發。
已執行的信封
 templatesList.eventsSubscribedMap.folder_executed boolean

當所有當事人都簽署完畢且信封完全執行時觸發。
信封已刪除
 templatesList.eventsSubscribedMap.folder_deleted boolean

當信封被刪除時會觸發。

刪除信封

作業識別碼：
DeleteEnvelopes

永久刪除一個或多個信封。

參數

名稱 機碼 必要 類型 Description
資料夾 ID
 folderIds True array of integer

一組可以操作的信封 ID 陣列。

傳回

名稱 路徑 類型 Description
Result
 result string

顯示手術是否成功。

取得 Webhook 頻道詳情

作業識別碼：
GetWebhookChannelDetails

擷取特定 webhook 頻道的詳細資訊。

參數

名稱 機碼 必要 類型 Description
頻道識別碼
 channelId True string

要取回的唯一 webhook 通道識別碼。

傳回

名稱 路徑 類型 Description
Result
 result string

指出要求是否成功。
ID
 channel.channelId integer

webhook 通道的唯一識別碼。
公司編號
 channel.companyId integer

這個頻道所屬的公司帳號。
名稱
 channel.channelName string

webhook 頻道的名稱。
Webhook 網址
 channel.webhookUrl string

當訂閱事件發生時，Foxit eSign 會呼叫的網址。
網鉤祕密
 channel.webhookSecret string

用於驗證 webhook 有效載荷的秘密金鑰。
建立日期
 channel.dateCreated integer

頻道創建日期，單位為 Unix 毫秒。
更新日期
 channel.dateUpdated integer

頻道最後更新的日期，以 Unix 毫秒計。
Webhook 層級
 channel.webhookLevel string

Webhook 頻道的範圍。 要麼是「帳戶」（所有信封的觸發器），要嘛是「API App」（只觸發透過 API 建立的信封）。
現況
 channel.status string

頻道目前的狀態。 要麼是「主動」，要麼是「非活躍」。
寄出的信封
 channel.eventsSubscribedMap.folder_sent boolean

當信封寄給收件人時會觸發。
已檢視的信封
 channel.eventsSubscribedMap.folder_viewed boolean

當收件人打開信封時觸發。
信封簽名
 channel.eventsSubscribedMap.folder_signed boolean

當信封由收件人簽名時觸發。
信封取消
 channel.eventsSubscribedMap.folder_cancelled boolean

當信封被取消時觸發。
已執行的信封
 channel.eventsSubscribedMap.folder_executed boolean

當所有當事人都簽署完畢且信封完全執行時觸發。
信封已刪除
 channel.eventsSubscribedMap.folder_deleted boolean

當信封被刪除時會觸發。

取得信封 ID

作業識別碼：
GetEnvelopeIds

回傳一份依狀態篩選的信封 ID 清單。 用這個來找特定州的信封。

參數

名稱 機碼 必要 類型 Description
日期開始
 dateFrom True string

信封製作日期範圍的起始。 接受格式：YYYY-MM-DD。
日期至
 dateTo True string

信封末端的創建日期範圍。 接受格式：YYYY-MM-DD。 dateTo 的值必須在 dateFrom 值後 6 個月內。
現況
 status string

依狀態過濾信封。 接受的值：執行、分享、草稿、部分簽署、取消、過期、刪除。 若未填寫，任何狀態的信封都會被退回。

傳回

名稱 路徑 類型 Description
Result
 result string

指出要求是否成功。
Message
 message string

一則摘要訊息，顯示回傳了多少個信封 ID。
信封識別碼
 allFolderIds array of integer

符合篩選條件的信封 ID 清單。 使用這些 ID 搭配「取得信封詳情」來取得完整的信封資訊。

取得信封活動歷史

作業識別碼：
GetEnvelopeActivityHistory

取得信封的完整活動日誌，顯示收件人與寄件人所採取的所有行動。

參數

名稱 機碼 必要 類型 Description
信封 ID
 folderId True integer

你想取得活動歷史的信封唯一識別碼。

傳回

名稱 路徑 類型 Description
Result
 result string

指出要求是否成功。
信封 ID
 details.folderId integer

信封的唯一識別碼。
隨函附上的文件
 details.enclosedDocuments string

信封內附文件名稱。
收件者
 details.envelopeRecipients string

信封上寫著所有收件人的名字。
Author
 details.author string

是創建信封的使用者姓名。
現況
 details.status string

信封目前狀態（例如：共享、執行、取消）。
最新活動日期
 details.latestActivityDate string

信封上最近活動的日期和時間。
建立日期
 details.dateCreated string

信封製作的日期和時間。
發送日期
 details.dateSent string

信封寄給收件人的日期和時間。
Activities
 details.activities array of object

這是對這個信封所採取的所有行動的時間順序清單。
Activity
 details.activities.activity string

這是對事件經過的人類易讀描述。
動作
 details.activities.action string

執行的動作類型（例如，建立、邀請已發送、開啟、查看、簽署）。
User
 details.activities.user string

執行該動作的使用者姓名。
信封狀態
 details.activities.folderStatus string

當時信封的狀態。
Time
 details.activities.time string

行動發生的日期和時間。
Source
 details.activities.source string

執行動作的來源（例如，網路）。
IP 位址
 details.activities.ipAddress string

操作所用的 IP 位址（若有的話）。

取得已刪除的信封歷史

作業識別碼：
GetDeletedEnvelopeHistory

取得已刪除或移入回收站的信封歷史紀錄。

參數

名稱 機碼 必要 類型 Description
信封 ID
 folderId True string

你想取得刪除歷史信封的唯一識別碼。

傳回

名稱 路徑 類型 Description
Result
 result string

指出要求是否成功。
已刪除的信封資訊
 Deleted Folder Log Info array of object

關於被刪除信封的摘要資訊。
信封 ID
 Deleted Folder Log Info.folderId integer

刪除信封的唯一識別碼。
信封名稱
 Deleted Folder Log Info.folderName string

刪除信封的名字。
文件名稱
 Deleted Folder Log Info.documentName string

刪除信封裡的文件名稱。
文件識別碼
 Deleted Folder Log Info.documentId string

刪除信封中文件的唯一識別碼。
刪除日期
 Deleted Folder Log Info.deletionDate integer

信封被刪除的日期和時間，以 Unix 毫秒計。
刪除者
 Deleted Folder Log Info.deletedBy string

刪除信封的使用者姓名。
刪除日誌歷史
 Deleted Folder Log History array of object

所有刪除操作的逐步記錄。
演出
 Deleted Folder Log History.partiesName string

執行刪除步驟的使用者姓名。
Source
 Deleted Folder Log History.source string

刪除的來源（例如：Web、API）。
Event
 Deleted Folder Log History.event string

執行的特定刪除動作（例如，刪除資料夾、刪除所有相關方）。

取得所有範本清單

作業識別碼：
GetalistofallTemplates

會回傳你帳號中所有可用的範本清單。

傳回

名稱 路徑 類型 Description
Result
 result string

指出要求是否成功。
全模板
 total_templates integer

你帳號中的模板總數。
範本清單
 templatesList array of object

帳號中所有可用的範本清單。
範本識別碼
 templatesList.templateId integer

範本的唯一識別碼。 使用這個 ID 搭配「從範本建立信封」來發送簽名範本。
範本名稱
 templatesList.templateName string

範本的名稱。
範本說明
 templatesList.templateDesc string

範本的描述。
範本類型
 templatesList.templateType string

範本的類型或類別。
建立日期
 templatesList.templateCreationDate integer

模板創建日期，以 Unix 毫秒為單位。
最後更新日期
 templatesList.templateLastUpdateDate integer

模板最後更新的日期，單位為 Unix 毫秒。
可編輯
 templatesList.editable boolean

顯示範本是否可編輯。
政黨數量
 templatesList.numberOfParties integer

範本中定義的簽署方數量。
公司編號
 templatesList.companyId integer

範本所屬的公司帳號。
與大家分享
 templatesList.shareAll boolean

顯示該範本是否與帳號中的所有使用者共享。
合作對象識別碼
 templatesList.templateCreatedBy.partyId integer

使用者的唯一標識碼。
名字
 templatesList.templateCreatedBy.firstName string

使用者的名字。
姓氏
 templatesList.templateCreatedBy.lastName string

使用者的姓氏。
Email
 templatesList.templateCreatedBy.emailId string

使用者的電子郵件地址。
合作對象識別碼
 templatesList.templateLastUpdatedBy.partyId integer

使用者的唯一標識碼。
名字
 templatesList.templateLastUpdatedBy.firstName string

使用者的名字。
姓氏
 templatesList.templateLastUpdatedBy.lastName string

使用者的姓氏。
Email
 templatesList.templateLastUpdatedBy.emailId string

使用者的電子郵件地址。

取得範本詳情

作業識別碼：
GetTemplateDetails

取得特定範本的完整細節，包括欄位與收件人。

參數

名稱 機碼 必要 類型 Description
範本識別碼
 templateId True string

範本的唯一識別碼。

傳回

名稱 路徑 類型 Description
Result
 result string

指出要求是否成功。
ID
 template.templateId integer

範本的唯一識別碼。
名稱
 template.templateName string

範本的名稱。
Description
 template.templateDesc string

範本的描述。
類型
 template.templateType string

範本的類型。
建立日期
 template.templateCreationDate integer

模板創建日期，以 Unix 毫秒為單位。
最後更新日期
 template.templateLastUpdateDate integer

模板最後更新的日期，單位為 Unix 毫秒。
可編輯
 template.editable boolean

顯示範本是否可編輯。
政黨數量
 template.numberOfParties integer

範本中定義的簽署方數量。
總頁數
 template.totalPages integer

範本文件的總頁數。
公司編號
 template.companyId integer

範本所屬的公司帳號。
與大家分享
 template.shareAll boolean

顯示該範本是否與帳號中的所有使用者共享。
自訂名稱模式
 template.templateCustomName string

自訂名稱模式套用在這個範本中建立的信封。
隊伍許可
 template.templatePartyPermissions array of object

此範本中定義的接收者角色及其簽署權限清單。
合作對象識別碼
 template.templatePartyPermissions.template_party_id integer

這個範本隊伍條目的唯一 ID。
ID
 template.templatePartyPermissions.templateId integer

這個隊伍所屬模板的 ID。
許可
 template.templatePartyPermissions.templatePermissions string

該方的簽署權限（例如，FILL_FIELDS_AND_SIGN）。
簽署訂單
 template.templatePartyPermissions.partySequence integer

這是這場派對的簽署順序位置。
派對角色
 template.templatePartyPermissions.templatePartyRole string

這個隊伍被分配的角色名稱。 用這個數值來用這個範本製作信封。
合作對象識別碼
 template.templatePartyPermissions.partyId integer

如果是預先分配，則需提供分配至此角色的隊伍ID。
合作對象識別碼
 template.templateCreatedBy.partyId integer

使用者的唯一標識碼。
名字
 template.templateCreatedBy.firstName string

使用者的名字。
姓氏
 template.templateCreatedBy.lastName string

使用者的姓氏。
Email
 template.templateCreatedBy.emailId string

使用者的電子郵件地址。
部門
 template.templateCreatedBy.department string

使用者的部門。
Title
 template.templateCreatedBy.title string

使用者的職稱。
作用中
 template.templateCreatedBy.active boolean

顯示使用者帳號是否仍在使用中。
合作對象識別碼
 template.templateLastUpdatedBy.partyId integer

使用者的唯一標識碼。
名字
 template.templateLastUpdatedBy.firstName string

使用者的名字。
姓氏
 template.templateLastUpdatedBy.lastName string

使用者的姓氏。
Email
 template.templateLastUpdatedBy.emailId string

使用者的電子郵件地址。
部門
 template.templateLastUpdatedBy.department string

使用者的部門。
Title
 template.templateLastUpdatedBy.title string

使用者的職稱。
作用中
 template.templateLastUpdatedBy.active boolean

顯示使用者帳號是否仍在使用中。
所有領域
 allfields array of object

此範本中定義的所有欄位清單。
欄位標籤識別碼
 allfields.fieldTagId integer

欄位的唯一識別碼。
範本識別碼
 allfields.templateId integer

該欄位所屬範本的 ID。
公司編號
 allfields.companyId integer

該欄位所屬的公司帳戶。
欄位類型
 allfields.fieldType string

欄位的類型（例如 signfield、initialfield、textfield、datefield、checkboxfield、securedfield、attachmentfield）。
頁碼
 allfields.documentPageNumber integer

文件中放置此欄位的頁碼。
責任方
 allfields.partyResponsible integer

負責完成此欄位的隊伍序號。
派對順序
 allfields.partyResponsibleSequence integer

負責方的順序位置。
醫生領域識別碼
 allfields.docFieldId string

文件中此欄位的識別碼。
依賴
 allfields.dependent boolean

表示該欄位的可見性是否依賴於另一個欄位的值。
制表序列
 allfields.tabOrder integer

用來在欄位間導航的制表順序。
為必填項目
 allfields.required boolean

指示是否必須填寫此欄位才能簽署文件。
自訂欄位名稱
 allfields.customFieldName string

此欄位為自訂名稱。
分享全部
 allfields.shareAll boolean

顯示此欄位是否與所有使用者共享。
允許編輯
 allfields.allowEdit boolean

顯示此欄位是否可由收件人編輯。
文字欄位名稱
 allfields.textfieldName string

文字欄位的標籤（當 fieldType 為「textfield」時適用）。
價值
 allfields.value string

欄位的預先填入或輸入值。
字型大小
 allfields.fontSize integer

此欄位中使用的字體大小。
字體顏色
 allfields.fontColor string

此欄位文字使用的字體顏色（例如 #000000）。
唯讀
 allfields.readOnly boolean

顯示該欄位是否為唯讀，且收件人無法編輯。
多線鐵路
 allfields.multiLine boolean

表示該文字欄位是否接受多行輸入（當 fieldType 為「textfield」時適用）。
字數限制
 allfields.characterLimit integer

欄位中允許的最大字元數（當 fieldType 為「textfield」時適用）。
日期欄位名稱
 allfields.datefieldName string

日期欄位的標籤（當 fieldType 為 'datefield' 時適用）。
日期格式
 allfields.dateFormat string

此欄位所使用的日期格式（例如 MM/DD/YYYY）（當 fieldType 為「datefield」時適用）。
勾選框名稱
 allfields.cbname string

勾選框欄位的標籤（當 fieldType 為「checkboxfield」時適用）。
核取方塊小組
 allfields.cbgroup string

此核取方塊的群組名稱，當多個核取方塊連結時使用（當fieldType為「checkboxfield」時適用）。
已核對
 allfields.checked boolean

表示勾選框是否預設被勾選（適用於 fieldType 為「checkboxfield」）。
已確保的場地名稱
 allfields.securedfieldName string

受保護欄位的標籤（當 fieldType 為 'securedfield' 時適用）。
展示角色
 allfields.charToDisplay integer

在安全欄位值結束時，應顯示的未遮罩字元數量（當fieldType為「securedfield」時適用）。
簽章識別碼
 allfields.signatureId string

簽章的 ID 適用於此符號欄位（當 fieldType 為「signfield」時適用）。
初始圖像
 allfields.initialImage string

該欄位的縮寫影像資料套用於此欄位（當fieldType為「initialfield」時適用）。
附件欄位名稱
 allfields.attachmentfieldName string

attachment 欄位名稱（當 fieldType 為 'attachmentfield' 時適用）。
附件說明
 allfields.attachmentfieldDescription string

描述要附加什麼（適用於 fieldType 為「attachmentfield」）。

取消信封

作業識別碼：
CancelEnvelope

取消寄出的信封。 收件人將無法再簽署這些文件。

參數

名稱 機碼 必要 類型 Description
信封 ID
 folderId True integer

信封的編號來取消。
取消原因
 reason_for_cancellation True string

取消這個信封的原因。 這會記錄在信封活動歷史中。

傳回

名稱 路徑 類型 Description
Result
 result string

指出要求是否成功。
取消的信封識別碼
 folders cancelled array of integer

成功取消的信封ID清單。

取消訂閱 Webhook 觸發器

作業識別碼：
DeleteTriggerWebhookChannel

透過頻道 ID 刪除一個活躍的 webhook 頻道訂閱。 使用此操作來清理不再需要的 webhook 訂閱。

參數

名稱 機碼 必要 類型 Description
頻道識別碼
 channelId True integer

要刪除的 webhook 頻道 ID。

將信封移至回收桶

作業識別碼：
MoveEnvelopestoRecycleBin

將一個或多個信封移至回收桶。 回收筒裡的信封不會永久刪除。

參數

名稱 機碼 必要 類型 Description
資料夾 ID
 folderIds True array of integer

一組可以操作的信封 ID 陣列。

傳回

名稱 路徑 類型 Description
Result
 result string

顯示手術是否成功。

建立電子郵件群組

作業識別碼：
CreateEmailGroup

建立一個新的電子郵件群組，可以同時寄信封給多個收件人。

參數

名稱 機碼 必要 類型 Description
群組名稱
 emailGroupName True string

新電子郵件群組的名稱。
群組描述
 emailGroupDescription string

電子郵件群組的可選描述。
允許進階電子郵件驗證
 allowAdvancedEmailValidation boolean

啟用後，Foxit eSign 會驗證群組中所有電子郵件地址均可聯絡，然後再發送。
名字
 firstName True string

收件者的名字。
姓氏
 lastName True string

收件者的姓氏。
Email
 emailId True string

收件者的電子郵件地址。

傳回

名稱 路徑 類型 Description
Result
 result string

指出要求是否成功。
Message
 message string

一個確認已執行動作的訊息。
群組識別碼
 emailGroup.groupId integer

電子郵件群組的唯一識別碼。 寄信封給群組時使用這個 ID。
群組名稱
 emailGroup.groupName string

電子郵件群組名稱。
群組描述
 emailGroup.groupDesc string

電子郵件群組的描述。
建立日期
 emailGroup.dateCreated integer

電子郵件群組成立的日期，以 Unix 毫秒計。
公司編號
 emailGroup.companyId integer

這個電子郵件群組所屬的公司帳號。
Parties
 emailGroup.parties array of object

電子郵件群組中的收件人名單。
名字
 emailGroup.parties.firstName string

收件者的名字。
姓氏
 emailGroup.parties.lastName string

收件者的姓氏。
Email
 emailGroup.parties.emailId string

收件者的電子郵件地址。

從 Base64 建立信封

作業識別碼：
CreateEnvelopefromBase64

使用 Base64 編碼的 PDF 文件建立並寄送信封。

參數

名稱 機碼 必要 類型 Description
信封名稱
 folderName True string

這個信封的名字。
輸入類型
 inputType string

文件來源的輸入類型。 此動作固定在 base64。
Base64 檔案字串
 base64FileString True array of string

一組 Base64 編碼的 PDF 文件可供傳送。
檔案名稱
 fileNames True array of string

每個文件的顯示名稱陣列，順序與 Base64 檔案字串陣列相同。
名字
 firstName True string

收件者的名字。
姓氏
 lastName True string

收件者的姓氏。
Email 地址
 emailId True string

收件者的電子郵件地址。
使用權限
 permission True string
排序
 sequence True integer

使用此欄位將序號指派給收件人列表中的收件人。 請為每個隊伍使用以 1 開頭的獨特序號，例如 1、2、3、4......如果同一個人在簽名流程中出現多次，請每次重複接收者時分配不同的序列。
signerAuthLevels
 signerAuthLevel string

簽署者用於驗證目的所使用的認證層級
是佔位符
 isPlaceholder boolean

用這個欄位來啟動派對，是佔位符。 註：1. firstName、lastName、emailId 參數的值必須是該方的空欄。 2. 要加入佔位符，必須要求一位收件人獲得「PARTY_ASSIGNER」權限。
收件者角色
 partyRole string

使用此欄位來指派佔位符的角色。
允許更名
 allowNameChange string

值可以是真或假，使用此參數允許簽署者在完成簽名前更新名字和姓氏。
工作流程序列
 workflowSequence integer

為此收件人指派一個工作流程序號。 啟用登入序列後，收件人會依序收到簽名邀請。
主機電子郵件識別碼
 hostEmailId string

In-Person 管理員的電子郵件地址。
存取代碼
 userDefinedAccessCode string

當「signerAuthLevel」值被設定為「使用者定義存取碼」以進行驗證時，該參數將包含存取碼。 註：1. 代碼不區分大小寫。 2. 系統不會傳送這個代碼，所以你必須直接與簽署人分享。 3. 存取碼可包含字母表、數字及以下特殊字元：@，&，{,}%，（，），~，|,!,+，^。
Party 是電子郵件群組
 partyIsEmailGroup boolean

在大量創建隊伍時使用這個參數。 註： 若此參數為真，該方的名字、姓氏和電子郵件ID將被忽略。
電子郵件群組識別碼
 emailGroupId integer

把你想用來建立大量群組的群組ID傳給電子郵件。
單一簽名者批量
 allowSingleSignerInBulk boolean

使用此參數允許只有一人登入電子郵件群組。
撥號代碼
 dialingCode string

使用此欄位將撥入代碼分配給收件人的國家撥號前綴。
行動電話號碼
 mobileNumber string

使用此欄位將手機號碼指派給收件人列表中的收件人。
欄位
 Fields object
立即發送
 sendNow boolean

啟用後，Foxit eSign 會立即向每位收件人的電子郵件地址發送獨特的簽名連結。 關閉這個功能，可以把信封存成草稿。
建立嵌入式簽署會話
 createEmbeddedSigningSession True boolean

簽署會話令牌會在不發送電子郵件給收件人的情況下產生。
為所有參與者建立嵌入式簽署會議
 createEmbeddedSigningSessionForAllParties boolean

若設定為 true，信封中每個收件人都會產生一個嵌入的簽名 URL。
程序文字標籤
 processTextTags True boolean

價值可以是真或假。 此欄位用來判斷 Foxit eSign 是否應解析文件中的文字標籤，並將其轉換為 Foxit eSign 欄位。
工藝雜技場
 processAcroFields True boolean

此欄位用來判斷 Foxit eSign 是否應解析 AcroFields 的文件，並將其轉換為 Foxit eSign 欄位。
登入順序
 signInSequence boolean

此欄位用來判斷收件人是否會依序簽署信封文件。 如果是錯誤，則所有收件人會同時收到邀請郵件。 若屬實，則在前一位收件人完成所需任務（如簽署文件或填寫欄位等）後，依序收到邀請郵件。
面對面啟用
 inPersonEnable boolean

此欄位用於啟動面對面簽署流程，該流程可在任何裝置上輕鬆完成，且在必要時避免電子郵件簽名。 如果錯誤，則所有收件人會同時收到邀請郵件。 若屬實，現場管理員會收到邀請電子郵件，啟動簽署者簽署程序。
修正接收方
 fixRecipientParties boolean

如果成立，則在嵌入的發送視窗中，無法更改已加入此請求的信封當事人。
修正文件
 fixDocuments boolean

如果屬實，則在內嵌的傳送中無法更改已加入此請求的信封文件。
傳送成功網址
 sendSuccessUrl string

輸入登陸頁的絕對網址，簽署者在成功將資料夾傳送到嵌入的發送視窗後，會被重新導向到該網址。
發送錯誤網址
 sendErrorUrl string

輸入登陸頁的絕對網址，若在嵌入的發送視窗中傳送資料夾時出現錯誤，簽署者會被重新導向該網址。
建立嵌入式發送會話
 createEmbeddedSendingSession boolean

若設為 true，則會產生嵌入的令牌以開啟 Foxit eSign 的文件準備檢視。
嵌入簽署者電子郵件識別碼
 embeddedSignersEmailIds array of string

一組收件人的電子郵件 ID，需要為這些收件人建立嵌入式簽署會話。 收件人的電子郵件 ID 會被加入當事人清單。
簽名成功網址
 signSuccessUrl string

輸入簽署者的絕對網址，成功登入嵌入簽名檢視後，簽署者會被重新導向。
招牌拒絕網址
 signDeclineUrl string

輸入簽署者的絕對網址，若簽署者拒絕登入，則會被重新導向。
稍後簽署網址
 signLaterUrl string

輸入簽名者的絕對網址，若簽署者選擇稍後在內嵌簽名檢視中簽署，將被重新導轉至該網址。
符號錯誤網址
 signErrorUrl string

輸入簽署者的絕對網址，若在嵌入簽署檢視中出現錯誤，簽署者會被重新導向。
允許立即發送與嵌入式簽署會話
 allowSendNowAndEmbeddedSigningSession boolean

若設定為真，Foxit eSign 會向每位收件人發送獨特的簽署連結。 這只適用於參數 sendNow 和 createEmbeddedSigningSession 為真時。
進階電子郵件驗證
 allowAdvancedEmailValidation boolean

當設定為真實時，驗證雙方的電子郵件地址。
簽署成功 所有相關方 網址
 signSuccessUrlAllParties boolean

若設定為 true，簽署者成功簽署後將被導向至 signSuccessUrl 中提供的網址。 這只適用於 sendNow 為真時。
電子郵件範本ID
 emailTemplateId integer

傳送電子郵件範本 ID 以發送非預設郵件範本的電子郵件範本。
簽署者指令識別碼
 signerInstructionId integer

傳遞指令 ID 以傳送非預設簽署指令的簽署者指令。
確認指示ID
 confirmationInstructionId string

傳送確認指令 ID 以傳送非預設確認指令的確認指令。
主題顏色
 themeColor string

輸入 CSS 值來設定主題顏色。
會話結束
 sessionExpire boolean

設為 true 以啟動嵌入簽署會話的到期。
到期日
 expiry integer

如果 sessionExpire 為真，則必須如此。 輸入嵌入簽署會話到期後毫秒的持續時間。
依賴欄位名稱
 dependentFieldName True string

由父欄位控制可見性的欄位名稱。
母田名稱
 parentFieldName True string

控制依賴欄位可見性的父欄位名稱。 支援的父欄位類型：textfield、textbox、checkbox、radiobutton、下拉選單。
母欄位值
 parentFieldValue True string

觸發依賴欄位變得可見的父欄位值。 對於勾選框和無線按鈕欄位，請使用勾選或未勾選。
選項
 options True string

新增文字基礎父欄位的匹配選項。 接受的值：isblank、allowNull、contains。
後設資料
 metadata object

這應該是關鍵值對。 最多允許 1000 對關鍵值對。
寄件者電子郵件
 senderEmail string

請在你的帳戶中輸入另一位使用者的電子郵件，該資料夾將用於將此文件資料夾寄送給收件人。
隱藏 新增我按鈕
 hideAddMeButton boolean

如果屬實，它會在嵌入的發送會話中隱藏收件人方的「新增我」按鈕。
隱藏新增按鈕
 hideAddNewButton boolean

如果是這樣，它會在嵌入的發送會話中隱藏收件人方的「新增新」按鈕。
隱藏新增群組按鈕
 hideAddGroupButton boolean

如果屬實，它會在嵌入的發送會話中隱藏收件人方的「新增群組」按鈕。
隱藏收件人欄位名稱
 hideFieldNameForRecipients boolean

隱藏收件人欄位名稱，用於資料輸入欄位與進階欄位。 （除了單選按鈕、勾選框、圖片和超連結）。
隱藏邊框勾選框
 hideCheckboxBorder boolean

勾選框的邊界會隱藏在已執行的文件中。
隱藏簽署者選擇選項
 hideSignerSelectOption boolean

如果屬實，它會在嵌入的發送會話中隱藏收件人方的「現有簽署人姓名/電子郵件」輸入框。
隱藏簽署者行動
 hideSignerActions boolean

若屬實，則會隱藏簽署方在嵌入傳送會話中對接收方的「編輯」、「變更」與「移除」操作。
隱藏發送者名稱
 hideSenderName boolean

若屬實，則會在嵌入的發送會話中隱藏收件人名稱。
隱藏資料夾名稱
 hideFolderName boolean

如果是這樣，它會在兩個嵌入式工作階段的導覽中隱藏資料夾名稱。
隱藏文件名稱
 hideDocumentsName boolean

如果是這樣，它會在兩個嵌入的會話中隱藏文件名稱。
隱藏拒絕簽署
 hideDeclineToSign boolean

如果屬實，它會隱藏簽署者「拒絕簽署」的選項。
隱藏更多行動
 hideMoreAction boolean

如果是真的，它會在發送/簽署時隱藏「更多動作」按鈕。 若為「立即傳送」：為真，則不會隱藏任何資訊。
隱藏 傳送按鈕
 hideSendButton boolean

如果是真的，它會在嵌入的發送會話中隱藏「發送」按鈕。
隱藏下一個必要欄位btn
 hideNextRequiredFieldbtn boolean

若設為 true，則隱藏將簽署者移至下一個必填欄位的導航按鈕。
需要同時進行嵌入式會話
 requiredBothEmbeddedSession boolean

如果屬實，它會同時產生嵌入的發送與簽署 URL。
信封密碼
 folderPassword string

簽署者/作者必須使用此密碼才能開啟數位簽署文件。 若參數保持空白，則無需密碼即可開啟數位簽署文件。
啟用逐步啟用
 enableStepByStep boolean

以便在嵌入的發送會話中啟用逐步操作。
隱藏 新增政黨選項
 hideAddPartiesOption boolean

如果是真的，它會在草稿和範本建立模式中隱藏「新增政黨」的選項。
自我簽名
 selfSign boolean

它透過 API 實現嵌入式自我簽名功能。 此參數僅在 createEmbeddedSendingSession 參數為真時適用。
自我簽名成功網址
 selfSignerSuccessUrl string

在你的網站或應用程式中輸入登陸頁的絕對網址，使用者在成功自我簽名並將資料夾傳送到嵌入的發送視窗後，會被重新導向到該網址。

傳回

名稱 路徑 類型 Description
ID
 folder.folderId integer

新建立信封的唯一ID。 在後續操作中用這個字串來參考這個信封。
名稱
 folder.folderName string

新創造的信封名稱。
自訂名稱
 folder.folderCustomName string

信封的自訂名稱。
Password
 folder.folderPassword string

信封的存取密碼（如果設定好了）。
創作者識別碼
 folder.folderAuthorId integer

信封創建者的唯一識別碼。
創作者名字
 folder.folderAuthorFirstName string

信封製作者的名字。
創作者姓氏
 folder.folderAuthorLastName string

信封製作者的姓氏。
創作者電子郵件
 folder.folderAuthorEmail string

信封製作者的電子郵件地址。
創作者角色
 folder.folderAuthorRole string

信封製作者的角色。
公司編號
 folder.folderCompanyId integer

擁有信封的公司的唯一識別碼。
建立日期
 folder.folderCreationDate integer

信封創建日期（Unix 時間戳記，單位為毫秒）。
傳送日期
 folder.folderSentDate integer

信封寄出日期（Unix 時間戳記，毫秒）。
現況
 folder.folderStatus string

信封目前狀態。
自訂欄位 1
 folder.custom_field1 string

信封的第一個自訂元資料欄位。
自訂欄位 2
 folder.custom_field2 string

信封的第二個自訂元資料欄位。
後設資料
 folder.metadata string

與信封相關的自訂元資料。
文件識別碼
 folder.folderDocumentIds array of integer

信封內的文件識別碼清單。
Documents
 folder.documentsList array of object

信封裡的文件清單。
文件識別碼
 folder.documentsList.documentId integer

檔的唯一標識碼。
合約 ID
 folder.documentsList.contractId integer

合約的唯一識別碼。
公司編號
 folder.documentsList.companyId integer

公司的唯一識別碼。
作者
 folder.documentsList.contractCreatedBy integer

創建合約者的使用者ID。
創建日期
 folder.documentsList.contractCreatedOn string

合約成立的日期和時間。
合約類型
 folder.documentsList.contractType string

合約的類型。
合約狀態
 folder.documentsList.contractStatus string

合約目前狀態。
可編輯
 folder.documentsList.editable boolean

表示該項目是否可編輯。
版本識別碼
 folder.documentsList.contractVersionId integer

合約版本的唯一識別碼。
版本名稱
 folder.documentsList.contractVersionName string

合約版本的名稱。
版本描述
 folder.documentsList.contractVersionDesc string

這是合約版本的描述。
版本製作
 folder.documentsList.versionCreatedby integer

創建此版本者的使用者ID。
建立於
 folder.documentsList.versionCreatedOn string

這個版本的製作日期和時間。
版本號碼
 folder.documentsList.contractVersionNumber integer

合約的版本號。
交易來源
 folder.documentsList.contractTransactionSource string

就是啟動合約交易的來源系統。
收件者
 folder.folderRecipientParties array of object

這個信封的收件人名單。
收件者 ID
 folder.folderRecipientParties.partyId integer

收件者的唯一識別碼。
收件者 ID
 folder.folderRecipientParties.partyDetails.partyId integer

收件者的唯一識別碼。
名字
 folder.folderRecipientParties.partyDetails.firstName string

收件人的名字。
姓氏
 folder.folderRecipientParties.partyDetails.lastName string

收件人的姓氏。
Email 地址
 folder.folderRecipientParties.partyDetails.emailId string

收件者的電子郵件地址。
預留位置
 folder.folderRecipientParties.partyDetails.placeholder boolean

表示該隊伍是否為佔位收件人。
地址
 folder.folderRecipientParties.partyDetails.address string

收件人的實體地址。
建立日期
 folder.folderRecipientParties.partyDetails.dateCreated integer

記錄建立日期（Unix 時間戳，單位為毫秒）。
拒絕寄出電子郵件
 folder.folderRecipientParties.partyDetails.optOutEmails boolean

顯示收件人是否選擇不接收電子郵件通知。
唯一收件人 ID
 folder.folderRecipientParties.partyDetails.uniquePartyId string

此接收者的唯一系統識別碼。
認證等級
 folder.folderRecipientParties.partyDetails.authenticationLevel string

此收件人所需的認證方式。
密碼更新日期
 folder.folderRecipientParties.partyDetails.passwordUpdateDate string

密碼最後更新的日期。
密碼更新狀態
 folder.folderRecipientParties.partyDetails.passwordUpdateStatus boolean

顯示密碼是否已更新。
公司編號
 folder.folderRecipientParties.partyDetails.companyId integer

公司的唯一識別碼。
使用者角色
 folder.folderRecipientParties.partyDetails.userRole string

指派給使用者的角色。
部門
 folder.folderRecipientParties.partyDetails.department string

使用者所屬的部門。
Title
 folder.folderRecipientParties.partyDetails.title string

使用者的職稱。
作用中
 folder.folderRecipientParties.partyDetails.active boolean

顯示使用者或紀錄是否為啟用狀態。
地區設定
 folder.folderRecipientParties.partyDetails.requestLocale string

使用者的地點設定。
與部門分享
 folder.folderRecipientParties.partyDetails.share_among_department boolean

表示信封是否跨部門共享。
撥號代碼
 folder.folderRecipientParties.partyDetails.dialingCode string

電話號碼的國際撥號代碼。
行動電話號碼
 folder.folderRecipientParties.partyDetails.mobileNumber string

行動電話號碼。
狀態過濾器
 folder.folderRecipientParties.partyDetails.docStatusFilter string

文件狀態篩選器。
日期濾鏡
 folder.folderRecipientParties.partyDetails.docDateFilter string

文件日期的篩選器。
安全現場存取
 folder.folderRecipientParties.partyDetails.userSecureFieldAccess boolean

顯示使用者是否能存取安全欄位。
展開側邊欄
 folder.folderRecipientParties.partyDetails.expandSidebar boolean

顯示側邊欄是否預設展開。
進階電子郵件驗證
 folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation boolean

顯示是否啟用了進階電子郵件驗證。
管理員 ID
 folder.folderRecipientParties.partyDetails.managerId string

使用者管理者的唯一識別碼。
登入次數
 folder.folderRecipientParties.partyDetails.loginCount integer

使用者登入的次數。
密碼重設電子郵件
 folder.folderRecipientParties.partyDetails.sendMailForPasswordReset boolean

指示是否應該發送密碼重設郵件。
部門識別碼
 folder.folderRecipientParties.partyDetails.departmentId string

部門的唯一識別碼。
主要連隊
 folder.folderRecipientParties.partyDetails.userPrimaryCompany integer

與使用者相關的主要公司。
裝置類型
 folder.folderRecipientParties.partyDetails.deviceType string

所使用的裝置類型。
裝置令牌
 folder.folderRecipientParties.partyDetails.deviceToken string

裝置的推播通知令牌。
分包商說明
 folder.folderRecipientParties.partyDetails.subcontractorDescription string

分包商或外部簽約人的描述。
分包商組織
 folder.folderRecipientParties.partyDetails.subcontractorOrganization string

分包商或外部簽約人的組織名稱。
分包商新增日期
 folder.folderRecipientParties.partyDetails.subcAddedDate integer

分包商加入日期（Unix 時間戳，以毫秒計）。
Source
 folder.folderRecipientParties.partyDetails.source string

外部簽署者所從的來源系統。
撥號代碼
 folder.folderRecipientParties.dialingCode string

電話號碼的國際撥號代碼。
行動電話號碼
 folder.folderRecipientParties.mobileNumber string

行動電話號碼。
簽章類型
 folder.folderRecipientParties.signerSignatureType string

簽署人會使用的簽名類型。
許可
 folder.folderRecipientParties.contractPermissions string

該方獲得合約許可。
簽署訂單
 folder.folderRecipientParties.partySequence integer

這位收件人的簽約訂單序號。
工作流程序列
 folder.folderRecipientParties.workflowSignSequence integer

工作流程簽名序號。
信封 ID
 folder.folderRecipientParties.envelopeId integer

信封的唯一識別碼。
收件人公司識別碼
 folder.folderRecipientParties.partyCompanyId integer

與此收件人關聯的公司唯一識別碼。
共享模式
 folder.folderRecipientParties.sharingMode string

這個信封的分享模式。
收件人存取網址
 folder.folderRecipientParties.folderAccessURL string

收件人可用來存取並簽名信封的網址。
安全性模式
 folder.folderRecipientParties.securityMode string

安全模式套用在這個信封上。
Comments
 folder.folderRecipientParties.extraComments string

信封附有額外評論。
允許更名
 folder.folderRecipientParties.allowNameChange boolean

表示收件人是否被允許更新姓名。
名稱更新
 folder.folderRecipientParties.signerNameUpdated boolean

表示簽署人是否已更新姓名。
簽署者認證等級
 folder.folderRecipientParties.signerAuthenticationLevel string

簽署者所需的認證等級。
存取代碼
 folder.folderRecipientParties.userDefinedAccessCode string

為簽署者定義的自訂存取碼。
簽章識別碼
 folder.folderRecipientParties.signatureId string

簽名的唯一識別碼。
收件者角色
 folder.folderRecipientParties.partyRole string

指派給此收件人在簽署工作流程中的角色。
連隊場地
 folder.folderRecipientParties.companyFieldValue string

簽名中公司名稱欄位的價值。
標題欄位
 folder.folderRecipientParties.titleFieldValue string

簽名中標題欄位的值。
簽約原因
 folder.folderRecipientParties.reasonSigning string

收件人簽署文件的原因。
新增付款欄位
 folder.folderRecipientParties.payFieldAdded boolean

顯示是否新增了付款欄位。
收款人
 folder.folderRecipientParties.payee boolean

表示該收款人是否為收款人。
定期付款
 folder.folderRecipientParties.recurringFieldExist boolean

表示是否存在持續支付欄位。
列印與簽名完成
 folder.folderRecipientParties.printAndSignCompleted boolean

表示印刷與簽名程序是否完成。
有薪
 folder.folderRecipientParties.paid boolean

顯示付款是否已完成。
允許可選簽署人
 folder.folderRecipientParties.allowOptionalSigner boolean

表示該收件人是否為可選簽署者。
可選簽字者
 folder.folderRecipientParties.optionalSigners array of integer

此信封的可選簽署方身份證清單。
作者簽名網址
 folder.folderAccessURLForAuthor string

寄件人可用來存取信封的網址。
草稿存取網址
 folder.draftFolderAccessURL string

用來存取信封草稿版本的網址。
董事會簽署
 folder.boardRoomSign boolean

指示是否啟用董事會簽署模式。
包含標誌
 folder.includeLogo boolean

顯示電子郵件中是否包含公司標誌。
按鈕背景色
 folder.email_btnBgColor string

電子郵件按鈕的背景色。
按鈕文字顏色
 folder.email_btnTxtColor string

電子郵件按鈕的文字顏色。
電子郵件標誌
 folder.emailTemplateLogo string

電子郵件範本中使用的標誌網址。
電子郵件範本ID
 folder.emailTemplateId integer

電子郵件範本的唯一識別碼。
電子郵件標頭
 folder.emailHeader string

通知郵件中使用的標頭文字。
電子郵件頁尾
 folder.emailFooter string

通知郵件中使用的頁尾文字。
清洗預定
 folder.purgeFlag boolean

指示信封是否排定清除。
清洗開始日期
 folder.purgeStartDate string

清洗預定開始的日期。
清洗結束日期
 folder.purgeEndDate string

清除預定完成的日期。
批量發送 ID
 folder.bulkId integer

批量發送操作的唯一識別碼。
執行標誌令
 folder.enforceSignWorkflow boolean

表示收件人是否必須依照指定順序簽名。
目前步驟
 folder.currentWorkflowStep integer

這是目前簽署流程的步驟。
交易來源
 folder.transactionSource string

發起此交易的來源系統。
可編輯
 folder.editable boolean

表示該項目是否可編輯。
In-Person 簽名
 folder.inPersonSignable boolean

說明信封是否可親自簽名。
覆寫提醒
 folder.overrideAccountReminders boolean

顯示帳號層級提醒設定是否被覆寫。
覆寫授權
 folder.overrideAccountRecipientDelegation boolean

顯示帳號層級委派設定是否被覆蓋。
允許授權
 folder.allowRecipientsToDelegate boolean

表示收件人是否被允許委派簽署工作。
ID
 folder.envelopeId integer

信封的唯一識別碼。
名稱
 folder.envelopeName string

信封的名字。
發起人 ID
 folder.envelopeOriginatorId integer

創建信封使用者的唯一識別碼。
公司編號
 folder.envelopeCompanyId integer

擁有信封的公司的唯一識別碼。
Date
 folder.envelopeDate integer

信封創建日期（Unix 時間戳記，單位為毫秒）。
同日
 folder.envelopeSharedDate integer

信封被分享的日期（Unix 時間戳記，以毫秒計）。
現況
 folder.envelopeStatus string

信封目前狀態。
合約識別碼
 folder.envelopeContractIds array of integer

與此信封相關的合約ID清單。
收件人權限
 folder.envelopePartyPermissions array of object

這個信封的收件人權限清單。
收件者 ID
 folder.envelopePartyPermissions.partyId integer

收件者的唯一識別碼。
收件者 ID
 folder.envelopePartyPermissions.partyDetails.partyId integer

收件者的唯一識別碼。
名字
 folder.envelopePartyPermissions.partyDetails.firstName string

收件人的名字。
姓氏
 folder.envelopePartyPermissions.partyDetails.lastName string

收件人的姓氏。
Email 地址
 folder.envelopePartyPermissions.partyDetails.emailId string

收件者的電子郵件地址。
預留位置
 folder.envelopePartyPermissions.partyDetails.placeholder boolean

表示該隊伍是否為佔位收件人。
地址
 folder.envelopePartyPermissions.partyDetails.address string

收件人的實體地址。
建立日期
 folder.envelopePartyPermissions.partyDetails.dateCreated integer

記錄建立日期（Unix 時間戳，單位為毫秒）。
拒絕寄出電子郵件
 folder.envelopePartyPermissions.partyDetails.optOutEmails boolean

顯示收件人是否選擇不接收電子郵件通知。
唯一收件人 ID
 folder.envelopePartyPermissions.partyDetails.uniquePartyId string

此接收者的唯一系統識別碼。
認證等級
 folder.envelopePartyPermissions.partyDetails.authenticationLevel string

此收件人所需的認證方式。
密碼更新日期
 folder.envelopePartyPermissions.partyDetails.passwordUpdateDate string

密碼最後更新的日期。
密碼更新狀態
 folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus boolean

顯示密碼是否已更新。
公司編號
 folder.envelopePartyPermissions.partyDetails.companyId integer

公司的唯一識別碼。
使用者角色
 folder.envelopePartyPermissions.partyDetails.userRole string

指派給使用者的角色。
部門
 folder.envelopePartyPermissions.partyDetails.department string

使用者所屬的部門。
Title
 folder.envelopePartyPermissions.partyDetails.title string

使用者的職稱。
作用中
 folder.envelopePartyPermissions.partyDetails.active boolean

顯示使用者或紀錄是否為啟用狀態。
地區設定
 folder.envelopePartyPermissions.partyDetails.requestLocale string

使用者的地點設定。
與部門分享
 folder.envelopePartyPermissions.partyDetails.share_among_department boolean

表示信封是否跨部門共享。
撥號代碼
 folder.envelopePartyPermissions.partyDetails.dialingCode string

電話號碼的國際撥號代碼。
行動電話號碼
 folder.envelopePartyPermissions.partyDetails.mobileNumber string

行動電話號碼。
狀態過濾器
 folder.envelopePartyPermissions.partyDetails.docStatusFilter string

文件狀態篩選器。
日期濾鏡
 folder.envelopePartyPermissions.partyDetails.docDateFilter string

文件日期的篩選器。
安全現場存取
 folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess boolean

顯示使用者是否能存取安全欄位。
展開側邊欄
 folder.envelopePartyPermissions.partyDetails.expandSidebar boolean

顯示側邊欄是否預設展開。
進階電子郵件驗證
 folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation boolean

顯示是否啟用了進階電子郵件驗證。
管理員 ID
 folder.envelopePartyPermissions.partyDetails.managerId string

使用者管理者的唯一識別碼。
登入次數
 folder.envelopePartyPermissions.partyDetails.loginCount integer

使用者登入的次數。
密碼重設電子郵件
 folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset boolean

指示是否應該發送密碼重設郵件。
部門識別碼
 folder.envelopePartyPermissions.partyDetails.departmentId string

部門的唯一識別碼。
主要連隊
 folder.envelopePartyPermissions.partyDetails.userPrimaryCompany integer

與使用者相關的主要公司。
裝置類型
 folder.envelopePartyPermissions.partyDetails.deviceType string

所使用的裝置類型。
裝置令牌
 folder.envelopePartyPermissions.partyDetails.deviceToken string

裝置的推播通知令牌。
分包商說明
 folder.envelopePartyPermissions.partyDetails.subcontractorDescription string

分包商或外部簽約人的描述。
分包商組織
 folder.envelopePartyPermissions.partyDetails.subcontractorOrganization string

分包商或外部簽約人的組織名稱。
分包商新增日期
 folder.envelopePartyPermissions.partyDetails.subcAddedDate integer

分包商加入日期（Unix 時間戳，以毫秒計）。
Source
 folder.envelopePartyPermissions.partyDetails.source string

外部簽署者所從的來源系統。
撥號代碼
 folder.envelopePartyPermissions.dialingCode string

電話號碼的國際撥號代碼。
行動電話號碼
 folder.envelopePartyPermissions.mobileNumber string

行動電話號碼。
簽章類型
 folder.envelopePartyPermissions.signerSignatureType string

簽署人會使用的簽名類型。
許可
 folder.envelopePartyPermissions.contractPermissions string

該方獲得合約許可。
簽署訂單
 folder.envelopePartyPermissions.partySequence integer

這位收件人的簽約訂單序號。
工作流程序列
 folder.envelopePartyPermissions.workflowSignSequence integer

工作流程簽名序號。
信封 ID
 folder.envelopePartyPermissions.envelopeId integer

信封的唯一識別碼。
收件人公司識別碼
 folder.envelopePartyPermissions.partyCompanyId integer

與此收件人關聯的公司唯一識別碼。
共享模式
 folder.envelopePartyPermissions.sharingMode string

這個信封的分享模式。
收件人存取網址
 folder.envelopePartyPermissions.folderAccessURL string

收件人可用來存取並簽名信封的網址。
安全性模式
 folder.envelopePartyPermissions.securityMode string

安全模式套用在這個信封上。
Comments
 folder.envelopePartyPermissions.extraComments string

信封附有額外評論。
允許更名
 folder.envelopePartyPermissions.allowNameChange boolean

表示收件人是否被允許更新姓名。
名稱更新
 folder.envelopePartyPermissions.signerNameUpdated boolean

表示簽署人是否已更新姓名。
簽署者認證等級
 folder.envelopePartyPermissions.signerAuthenticationLevel string

簽署者所需的認證等級。
存取代碼
 folder.envelopePartyPermissions.userDefinedAccessCode string

為簽署者定義的自訂存取碼。
簽章識別碼
 folder.envelopePartyPermissions.signatureId string

簽名的唯一識別碼。
收件者角色
 folder.envelopePartyPermissions.partyRole string

指派給此收件人在簽署工作流程中的角色。
連隊場地
 folder.envelopePartyPermissions.companyFieldValue string

簽名中公司名稱欄位的價值。
標題欄位
 folder.envelopePartyPermissions.titleFieldValue string

簽名中標題欄位的值。
簽約原因
 folder.envelopePartyPermissions.reasonSigning string

收件人簽署文件的原因。
新增付款欄位
 folder.envelopePartyPermissions.payFieldAdded boolean

顯示是否新增了付款欄位。
收款人
 folder.envelopePartyPermissions.payee boolean

表示該收款人是否為收款人。
定期付款
 folder.envelopePartyPermissions.recurringFieldExist boolean

表示是否存在持續支付欄位。
列印與簽名完成
 folder.envelopePartyPermissions.printAndSignCompleted boolean

表示印刷與簽名程序是否完成。
有薪
 folder.envelopePartyPermissions.paid boolean

顯示付款是否已完成。
認證等級
 folder.envelopeAuthenticationLevel string

信封所需的認證等級。
單一簽名者批量
 folder.allowSingleSignerInBulk boolean

表示是否允許單簽名者在批量傳送模式中使用。
File-Based 命名
 folder.folderNameBasedOnFileNaming boolean

顯示資料夾名稱是否基於檔案名稱。
醫生 File-Based 名稱
 folder.documentNameBasedOnFileNaming boolean

顯示文件名稱是否基於檔案名稱。
證書 File-Based 名稱
 folder.certificateNameBasedOnFileNaming boolean

顯示憑證名稱是否基於檔案名稱。
預執行檔案命名
 folder.enableFileNamingBeforeExecution boolean

指示文件執行前是否啟用檔案命名。
收款人新增
 folder.payeeAddedd boolean

表示是否已新增收款人。
Self-Signing 啟用
 folder.selfSignerEnabled boolean

指示是否啟用自簽模式。
公證人啟用
 folder.notaryEnabled boolean

顯示是否啟用公證人簽名。
能見度有限
 folder.limitedVisibilityFlag boolean

表示此包絡是否啟用有限可見性。
標示後可見度
 folder.postSigningVisibility boolean

顯示是否啟用簽署後可視性。
濕簽名
 folder.wetSignatureEnabled boolean

顯示是否啟用濕簽名。
合併啟用
 folder.mergeEnabled boolean

顯示文件合併是否啟用。
嵌入式簽署會議
 embeddedSigningSessions array of object

嵌入式簽名會的清單，每位收件人一次。 只有當 createEmbeddedSigningSession 為真時才會出現。
簽署者電子郵件
 embeddedSigningSessions.emailIdOfSigner string

本次嵌入式簽署會議收件人的電子郵件地址。
簽署權杖
 embeddedSigningSessions.embeddedToken string

這位收件人嵌入簽名會的獨特代幣。
簽署會話網址
 embeddedSigningSessions.embeddedSessionURL string

收件人可開啟或嵌入的網址，以便簽署該文件。
嵌入式發送令牌
 embeddedToken string

嵌入發送會話的令牌。 只有當 createEmbeddedSendingSession 為真時才會出現。
發送會話網址
 embeddedSessionURL string

信封作者準備並寄出信封時，開啟或嵌入的網址。 只有當 createEmbeddedSendingSession 為真時才會出現。
Result
 result string

運算的結果。
Message
 message string

一則描述操作結果的訊息。

從 Base64 建立範本

作業識別碼：
CreateTemplatefromBase64

使用 Base64 編碼的 PDF 字串建立新範本。 當你的 PDF 檔案已經以 Base64 字串形式存在於流程中時，例如來自 SharePoint 或 OneDrive 文件時，請使用此方法。

參數

名稱 機碼 必要 類型 Description
範本名稱
 templateName True string

範本的名稱。 必須以 .pdf 擴展結尾（例如，onboarding.pdf）。
Base64 檔案串
 base64FileString True string

PDF的BASE64字串用於範本建立。 當你建立範本時，它應該是公開可存取的。
輸入類型
 inputType True string

文件的輸入法。 這個動作一定要設定為「base64」。
程序文字標籤
 processTextTags True boolean

啟用後，Foxit eSign 會掃描文件中的文字標籤，並自動將其轉換為簽名欄位。
工藝雜技場
 processAcroFields True boolean

啟用後，Foxit eSign 會掃描文件中的 AcroFields，並自動將其轉換為簽名欄位。
分享全部
 shareAll True boolean

請將此範本分享給你帳號中的所有使用者。
政黨數量
 numberOfParties True integer

此範本的接收方數量。 必須少於20。
主題顏色
 themeColor string

CSS 顏色值用來自訂嵌入範本會話的主題（例如 #42caf4）。
作者Email
 authorEmail string

該範本作者為該帳戶中另一位使用者的電子郵件地址。
建立嵌入範本會話
 createEmbeddedTemplateSession boolean

若設定為 true，會建立一個嵌入範本會話，讓你可以直接開啟 Foxit eSign 範本編輯器，並將欄位拖放到範本上。
重定向網址
 redirectURL string

如果「建立嵌入範本會話」為真，使用者點擊「儲存並關閉」後，請在嵌入範本編輯器中重新導向的網址。
隱藏 傳送範本
 hideSendTemplate boolean

如果是真的，Send 按鈕會隱藏在嵌入的範本編輯器中。
修正接收方
 fixRecipientParties boolean

若屬實，已新增的收件人在嵌入模板編輯器中無法更改。
欄位
 Fields object
使用權限
 permission True string
排序
 sequence True integer

此隊伍唯一的序號，從 1 開始。 在啟用登入序列時定義簽署順序。
收件者角色
 partyRole True string

模板中分配給這個隊伍的角色。
隱藏更多行動
 hideMoreAction boolean

如果是真的，「更多動作」按鈕會隱藏在嵌入的範本會話中。
隱藏與分享
 hideShareWithAll boolean

如果是真的，則「全體分享」選項隱藏在嵌入的範本會話中。
隱藏新增隊伍
 hideAddParty boolean

如果屬實，所有新增隊伍的選項都隱藏在嵌入的範本會話中。
隱藏我按鈕
 hideMeButton boolean

如果屬實，接收方的「我」按鈕隱藏在嵌入的範本會話中。
隱藏他人按鈕
 hideOthersButton boolean

如果屬實，接收方的「其他人」按鈕隱藏在嵌入的範本會話中。
隱藏收件人欄位名稱
 hideFieldNameForRecipients boolean

若屬實，欄位名稱在資料輸入及進階欄位時會被隱藏，收件人無法取得。
隱藏邊框勾選框
 hideCheckboxBorder boolean

若為真，則執行文件中隱藏了勾取框邊框。

傳回

名稱 路徑 類型 Description
Result
 result string

表示操作是否成功（例如「成功」）。
Message
 message string

行動結果的描述。
ID
 template.templateId integer

所建立範本的唯一 ID。 用這個範本來建立信封。
名稱
 template.templateName string

範本的名稱。
Description
 template.templateDesc string

範本的描述。
類型
 template.templateType string

範本的類型。
建立日期
 template.templateCreationDate string

模板建立的日期。
最後更新日期
 template.templateLastUpdateDate string

模板最後更新的日期。
可編輯
 template.editable boolean

顯示範本是否可編輯。
政黨數量
 template.numberOfParties integer

範本中定義的接收方數量。
總頁數
 template.totalPages integer

範本文件的總頁數。
公司編號
 template.companyId integer

這個範本所屬公司的 ID。
與眾共享
 template.shareAll boolean

顯示此範本是否與帳號內所有使用者共享。
隊伍許可
 template.templatePartyPermissions array of object

此範本中定義的接收者角色及其權限清單。
合作對象識別碼
 template.templatePartyPermissions.template_party_id integer

這個範本隊伍條目的唯一 ID。
ID
 template.templatePartyPermissions.templateId integer

這個隊伍所屬模板的 ID。
許可
 template.templatePartyPermissions.templatePermissions string

該方的簽署權限（例如，FILL_FIELDS_AND_SIGN）。
簽署訂單
 template.templatePartyPermissions.partySequence integer

這是這場派對的簽署順序位置。
派對角色
 template.templatePartyPermissions.templatePartyRole string

範本中分配給這個隊伍的角色名稱。 用這個方法從範本建立信封。
使用者識別碼
 template.templateCreatedBy.partyId integer

使用者的唯一 ID。
名字
 template.templateCreatedBy.firstName string

使用者的名字。
姓氏
 template.templateCreatedBy.lastName string

使用者的姓氏。
Email
 template.templateCreatedBy.emailId string

使用者的電子郵件地址。
範本欄位
 allfields array of object

範本中定義的所有簽名與表單欄位清單。
欄位識別碼
 allfields.fieldTagId integer

欄位的唯一識別碼。
範本識別碼
 allfields.templateId integer

該欄位所屬範本的 ID。
公司編號
 allfields.companyId integer

該欄位所屬的公司帳戶。
欄位類型
 allfields.fieldType string

欄位的類型（例如 signfield、initialfield、textfield、datefield、checkboxfield、securedfield、attachmentfield）。
頁碼
 allfields.documentPageNumber integer

文件中放置此欄位的頁碼。
責任方
 allfields.partyResponsible integer

負責填寫此欄位的黨序號。
派對順序
 allfields.partyResponsibleSequence integer

負責方的順序位置。
野戰文件編號
 allfields.docFieldId string

此欄位的文件層級識別碼。
是相依的
 allfields.dependent boolean

表示該欄位的可見性是否依賴於另一個欄位的值。
制表序列
 allfields.tabOrder integer

用來在欄位間導航的制表順序。
為必填項目
 allfields.required boolean

指示是否必須填入此欄位後，文件才能簽署。
自訂欄位名稱
 allfields.customFieldName string

此欄位為自訂名稱。
分享全部
 allfields.shareAll boolean

顯示此欄位是否與所有使用者共享。
允許編輯
 allfields.allowEdit boolean

顯示此欄位是否可由收件人編輯。
文字欄位名稱
 allfields.textfieldName string

文字欄位的標籤（當 fieldType 為「textfield」時適用）。
價值
 allfields.value string

欄位的預先填入或輸入值。
字型大小
 allfields.fontSize integer

此欄位中使用的字體大小。
字體顏色
 allfields.fontColor string

此欄位文字使用的字體顏色（例如 #000000）。
唯讀
 allfields.readOnly boolean

顯示該欄位是否為唯讀，且收件人無法編輯。
多線鐵路
 allfields.multiLine boolean

表示該文字欄位是否接受多行輸入（當 fieldType 為「textfield」時適用）。
字數限制
 allfields.characterLimit integer

欄位中允許的最大字元數（當 fieldType 為「textfield」時適用）。
日期欄位名稱
 allfields.datefieldName string

日期欄位的標籤（當 fieldType 為 'datefield' 時適用）。
日期格式
 allfields.dateFormat string

此欄位所使用的日期格式（例如 MM/DD/YYYY）（當 fieldType 為「datefield」時適用）。
勾選框名稱
 allfields.cbname string

勾選框欄位的標籤（當 fieldType 為「checkboxfield」時適用）。
核取方塊小組
 allfields.cbgroup string

此勾選框的群組名稱（適用於fieldType為「checkboxfield」）。
已核對
 allfields.checked boolean

表示勾選框是否預設被勾選（適用於 fieldType 為「checkboxfield」）。
已確保的場地名稱
 allfields.securedfieldName string

受保護欄位的標籤（當 fieldType 為 'securedfield' 時適用）。
展示角色
 allfields.charToDisplay integer

在安全欄位值結束時，應顯示的未遮罩字元數量（當fieldType為「securedfield」時適用）。
簽章識別碼
 allfields.signatureId string

簽章的 ID 適用於此符號欄位（當 fieldType 為「signfield」時適用）。
初始圖像
 allfields.initialImage string

該欄位的縮寫影像資料套用於此欄位（當fieldType為「initialfield」時適用）。
附件欄位名稱
 allfields.attachmentfieldName string

attachment 欄位名稱（當 fieldType 為 'attachmentfield' 時適用）。
附件說明
 allfields.attachmentfieldDescription string

描述要附加什麼（適用於 fieldType 為「attachmentfield」）。

從範本建立信封

作業識別碼：
CreateEnvelopefromTemplate

使用現有範本建立並寄送信封。 收件人資料可自訂。

參數

名稱 機碼 必要 類型 Description
信封名稱
 folderName string

文件資料夾名稱。 若未提供此值，則文件資料夾名稱與範本名稱相同。
範本識別碼
 templateIds True array of integer

一個你想用來建立這個資料夾文件的範本 ID 陣列。
欄位
 fields object

你可以將範本中使用的欄位值傳遞，預先填充到從範本建立的文件中。 FIELD_NAME 是範本中使用欄位的名稱。 FIELD_VALUE 是文件欄位的值。
進階電子郵件驗證
 allowAdvancedEmailValidation boolean

當設定為真實時，驗證雙方的電子郵件地址。
名字
 firstName True string

收件者的名字。
姓氏
 lastName True string

收件者的姓氏。
Email 地址
 emailId True string

收件者的電子郵件地址。
使用權限
 permission True string
排序
 sequence True integer

使用此欄位將序號指派給收件人列表中的收件人。 請為每個隊伍使用以 1 開頭的獨特序號，例如 1、2、3、4......如果同一個人在簽名流程中出現多次，請每次重複接收者時分配不同的序列。
signerAuthLevels
 signerAuthLevel string

簽署者用於驗證目的所使用的認證層級
是佔位符
 isPlaceholder boolean

用這個欄位來啟動派對，是佔位符。 註：1. firstName、lastName、emailId 參數的值必須是該方的空欄。 2. 要加入佔位符，必須要求一位收件人獲得「PARTY_ASSIGNER」權限。
收件者角色
 partyRole string

使用此欄位來指派佔位符的角色。
允許更名
 allowNameChange string

值可以是真或假，使用此參數允許簽署者在完成簽名前更新名字和姓氏。
工作流程序列
 workflowSequence integer

為此收件人指派一個工作流程序號。 啟用登入序列後，收件人會依序收到簽名邀請。
主機電子郵件識別碼
 hostEmailId string

In-Person 管理員的電子郵件地址。
存取代碼
 userDefinedAccessCode string

當「signerAuthLevel」值被設定為「使用者定義存取碼」以進行驗證時，該參數將包含存取碼。 註：1. 代碼不區分大小寫。 2. 系統不會傳送這個代碼，所以你必須直接與簽署人分享。 3. 存取碼可包含字母表、數字及以下特殊字元：@，&，{,}%，（，），~，|,!,+，^。
Party 是電子郵件群組
 partyIsEmailGroup boolean

在大量創建隊伍時使用這個參數。 註： 若此參數為真，該方的名字、姓氏和電子郵件ID將被忽略。
電子郵件群組識別碼
 emailGroupId integer

把你想用來建立大量群組的群組ID傳給電子郵件。
單一簽名者批量
 allowSingleSignerInBulk boolean

使用此參數允許只有一人登入電子郵件群組。
撥號代碼
 dialingCode string

使用此欄位將撥入代碼分配給收件人的國家撥號前綴。
行動電話號碼
 mobileNumber string

使用此欄位將手機號碼指派給收件人列表中的收件人。
信封密碼
 folderPassword string

簽署者/作者必須使用此密碼才能開啟數位簽署文件。 若參數保持空白，則無需密碼即可開啟數位簽署文件。
登入順序
 signInSequence boolean

此欄位用來判斷收件人是否會依序簽署信封文件。 如果是錯誤，則所有收件人會同時收到邀請郵件。 若屬實，則在前一位收件人完成所需任務（如簽署文件或填寫欄位等）後，依序收到邀請郵件。
面對面啟用
 inPersonEnable boolean

此欄位用於啟動面對面簽署流程，該流程可在任何裝置上輕鬆完成，且在必要時避免電子郵件簽名。 如果錯誤，則所有收件人會同時收到邀請郵件。 若屬實，現場管理員會收到邀請電子郵件，啟動簽署者簽署程序。
立即發送
 sendNow boolean

啟用後，Foxit eSign 會立即向每位收件人的電子郵件地址發送獨特的簽名連結。 關閉這個功能，可以把信封存成草稿。
簽署成功 所有相關方 網址
 signSuccessUrlAllParties boolean

若設定為 true，簽署者成功簽署後將被導向至 signSuccessUrl 中提供的網址。 這只適用於 sendNow 為真時。
建立嵌入式發送會話
 createEmbeddedSendingSession boolean

若設為 true，則會產生嵌入的 URL，以開啟 Foxit eSign 的文件準備檢視。
修正接收方
 fixRecipientParties boolean

如果成立，則在嵌入的發送視窗中，無法更改已加入此請求的信封當事人。
修正文件
 fixDocuments boolean

如果屬實，則在內嵌的傳送中無法更改已加入此請求的信封文件。
傳送成功網址
 sendSuccessUrl string

輸入登陸頁的絕對網址，簽署者在成功將資料夾傳送到嵌入的發送視窗後，會被重新導向到該網址。
發送錯誤網址
 sendErrorUrl string

輸入登陸頁的絕對網址，若在嵌入的發送視窗中傳送資料夾時出現錯誤，簽署者會被重新導向該網址。
隱藏簽署者選擇選項
 hideSignerSelectOption boolean

如果屬實，它會在嵌入的發送會話中隱藏收件人方的「現有簽署人姓名/電子郵件」輸入框。
隱藏簽署者行動
 hideSignerActions boolean

若屬實，則會隱藏簽署方在嵌入傳送會話中對接收方的「編輯」、「變更」與「移除」操作。
隱藏發送者名稱
 hideSenderName boolean

若屬實，則會在嵌入的發送會話中隱藏收件人名稱。
隱藏 傳送按鈕
 hideSendButton boolean

如果是真的，它會在嵌入的發送會話中隱藏「發送」按鈕。
隱藏資料夾名稱
 hideFolderName boolean

如果是這樣，它會在兩個嵌入式工作階段的導覽中隱藏資料夾名稱。
隱藏文件名稱
 hideDocumentsName boolean

如果是這樣，它會在兩個嵌入的會話中隱藏文件名稱。
隱藏 新增我按鈕
 hideAddMeButton boolean

如果屬實，它會在嵌入的發送會話中隱藏收件人方的「新增我」按鈕。
隱藏新增按鈕
 hideAddNewButton boolean

如果是這樣，它會在嵌入的發送會話中隱藏收件人方的「新增新」按鈕。
隱藏新增群組按鈕
 hideAddGroupButton boolean

如果屬實，它會在嵌入的發送會話中隱藏收件人方的「新增群組」按鈕。
建立嵌入式簽署會話
 createEmbeddedSigningSession boolean

簽署會話令牌會在不發送電子郵件給收件人的情況下產生。
為所有參與者建立嵌入式簽署會議
 createEmbeddedSigningSessionForAllParties boolean

若設為 true，信封中每個收件人都會產生嵌入的簽名 URL。 若錯誤，則只有嵌入簽署者電子郵件 ID 中列出的收件人會收到嵌入會話。
嵌入簽署者電子郵件識別碼
 embeddedSignersEmailIds array of string

一組收件人的電子郵件 ID，需要為這些收件人建立嵌入式簽署會話。 收件人的電子郵件 ID 會被加入當事人清單。
簽名成功網址
 signSuccessUrl string

輸入簽署者的絕對網址，成功登入嵌入簽名檢視後，簽署者會被重新導向。
招牌拒絕網址
 signDeclineUrl string

輸入簽署者的絕對網址，若簽署者拒絕登入，則會被重新導向。
稍後簽署網址
 signLaterUrl string

輸入簽名者的絕對網址，若簽署者選擇稍後在內嵌簽名檢視中簽署，將被重新導轉至該網址。
符號錯誤網址
 signErrorUrl string

輸入簽署者的絕對網址，若在嵌入簽署檢視中出現錯誤，簽署者會被重新導向。
隱藏下一個必填欄位 BTN
 hideNextRequiredFieldBtn boolean

若設為 true，則隱藏將簽署者移至下一個必填欄位的導航按鈕。
主題顏色
 themeColor string

輸入 CSS 值來設定主題顏色。
隱藏拒絕簽署
 hideDeclineToSign boolean

若設為 true，則會隱藏簽署畫面中的「拒絕簽署」選項。
隱藏更多行動
 hideMoreAction boolean

若設為 true，則會隱藏發送與簽署會話中的「更多動作」按鈕。 當「立即送出」為真時，則無效。
隱藏 新增政黨選項
 hideAddPartiesOption boolean

若設為 true，則隱藏了在草稿與模板建立模式中新增政黨的選項。
會話結束
 sessionExpire boolean

設為 true 以啟動嵌入簽署會話的到期。
到期日
 expiry integer

如果 sessionExpire 為真，則必須如此。 輸入嵌入簽署會話到期後毫秒的持續時間。
寄件者電子郵件
 senderEmail string

請在你的帳戶中輸入另一位使用者的電子郵件，該資料夾將用於將此文件資料夾寄送給收件人。
允許立即發送與嵌入式簽署會話
 allowSendNowAndEmbeddedSigningSession boolean

若設定為 true，Foxit eSign 會向每位收件人發送簽名邀請郵件，並為包含在嵌入式簽署者電子郵件中的收件人產生嵌入的簽名連結。 電子郵件和嵌入連結同時啟用。
啟用逐步啟用
 enableStepByStep boolean

以便在嵌入的發送會話中啟用逐步操作。

傳回

名稱 路徑 類型 Description
Result
 result string

表示操作是否成功（例如「成功」）。
Message
 message string

行動結果的描述。
嵌入式簽署會議
 embeddedSigningSessions array of object

嵌入式簽名會的清單，每位收件人一次。 只有當 createEmbeddedSigningSession 為真時才會出現。
簽署者電子郵件
 embeddedSigningSessions.emailIdOfSigner string

本次嵌入式簽署會議收件人的電子郵件地址。
簽署權杖
 embeddedSigningSessions.embeddedToken string

這位收件人嵌入簽名會的獨特代幣。
簽署會話網址
 embeddedSigningSessions.embeddedSessionURL string

收件人可開啟或嵌入的網址，以便簽署該文件。
嵌入式發送令牌
 embeddedToken string

嵌入發送會話的令牌。 只有當 createEmbeddedSendingSession 為真時才會出現。
發送會話網址
 embeddedSessionURL string

信封作者準備並寄出信封時，開啟或嵌入的網址。 只有當 createEmbeddedSendingSession 為真時才會出現。
ID
 folder.folderId integer

建立信封的唯一 ID。 在後續行動中，請用此來參考信封。
名稱
 folder.folderName string

信封的名字。
自訂名稱
 folder.folderCustomName string

信封被賦予的自訂名稱。
Password
 folder.folderPassword string

信封上的密碼（如果有的話）。
作者編號
 folder.folderAuthorId integer

創建信封的使用者唯一 ID。
作者名字
 folder.folderAuthorFirstName string

信封製作者的名字。
作者姓氏
 folder.folderAuthorLastName string

信封製作者的姓氏。
作者Email
 folder.folderAuthorEmail string

信封製作者的電子郵件地址。
作者角色
 folder.folderAuthorRole string

信封製作者的角色。
公司編號
 folder.folderCompanyId integer

信封所屬公司的獨特識別碼。
建立日期
 folder.folderCreationDate integer

信封的製作日期和時間，以 Unix 毫秒計。
傳送日期
 folder.folderSentDate integer

信封寄給收件人的日期與時間，單位為 Unix 毫秒。
現況
 folder.folderStatus string

信封目前狀態（例如：已分享、已執行、已完成、已取消）。
自訂欄位 1
 folder.custom_field1 string

信封上的自訂欄位 1 值。
自訂欄位 2
 folder.custom_field2 string

信封上設定的自訂欄位 2 值。
後設資料
 folder.metadata string

任何與信封相關的額外元資料。
文件識別碼
 folder.folderDocumentIds array of integer

這個信封裡附有的文件識別碼清單。
Documents
 folder.documentsList array of object

信封內附有每份文件的詳細資訊。
文件識別碼
 folder.documentsList.documentId integer

檔的唯一標識碼。
合約 ID
 folder.documentsList.contractId integer

與本文件相關的合約唯一識別碼。
公司編號
 folder.documentsList.companyId integer

這份文件所屬公司的唯一識別碼。
作者
 folder.documentsList.contractCreatedBy integer

創建合約者的使用者ID。
創建日期
 folder.documentsList.contractCreatedOn string

合約成立的日期。
合約類型
 folder.documentsList.contractType string

合約的類型。
文件狀態
 folder.documentsList.contractStatus string

文件目前簽署狀態（例如：WAITING_FOR_SIGNATURE、已執行）。
可編輯
 folder.documentsList.editable boolean

指示文件是否可編輯。
版本識別碼
 folder.documentsList.contractVersionId integer

目前文件版本的唯一 ID。
版本名稱
 folder.documentsList.contractVersionName string

目前文件版本的名稱。
版本描述
 folder.documentsList.contractVersionDesc string

目前文件版本的說明。
版本製作
 folder.documentsList.versionCreatedby integer

創建此文件的使用者 ID 版本。
建立於
 folder.documentsList.versionCreatedOn string

此文件版本的建立日期。
版本號碼
 folder.documentsList.contractVersionNumber integer

文件的版本號碼。
交易來源
 folder.documentsList.contractTransactionSource string

合約交易的來源。
收件者
 folder.folderRecipientParties array of object

此信封的收件人名單，包括他們的簽名連結。
收件者 ID
 folder.folderRecipientParties.partyId integer

收件者的唯一識別碼。
收件者 ID
 folder.folderRecipientParties.partyDetails.partyId integer

收件者的唯一識別碼。
名字
 folder.folderRecipientParties.partyDetails.firstName string

收件人的名字。
姓氏
 folder.folderRecipientParties.partyDetails.lastName string

收件人的姓氏。
Email
 folder.folderRecipientParties.partyDetails.emailId string

收件者的電子郵件地址。
是佔位符
 folder.folderRecipientParties.partyDetails.placeholder boolean

表示此收件人是否為佔位符。
地址
 folder.folderRecipientParties.partyDetails.address string

收件人的地址。
帳號建立日期
 folder.folderRecipientParties.partyDetails.dateCreated integer

收件人帳號建立的日期，以 Unix 毫秒計。
拒絕寄出電子郵件
 folder.folderRecipientParties.partyDetails.optOutEmails boolean

顯示收件人是否選擇不接收電子郵件通知。
唯一政黨識別碼
 folder.folderRecipientParties.partyDetails.uniquePartyId string

接收者擁有唯一的字串識別碼。
認證層級
 folder.folderRecipientParties.partyDetails.authenticationLevel string

該收件人所需的認證等級。
公司編號
 folder.folderRecipientParties.partyDetails.companyId integer

收件人所屬公司的識別碼。
使用者角色
 folder.folderRecipientParties.partyDetails.userRole string

受贈者在其組織中的角色。
部門
 folder.folderRecipientParties.partyDetails.department string

收件人所在的部門。
Title
 folder.folderRecipientParties.partyDetails.title string

收件人的職稱。
作用中
 folder.folderRecipientParties.partyDetails.active boolean

顯示收件人的帳號是否仍在使用中。
撥號代碼
 folder.folderRecipientParties.partyDetails.dialingCode string

收件人電話號碼的國家撥號代碼。
行動電話號碼
 folder.folderRecipientParties.partyDetails.mobileNumber string

收件人的手機號碼。
分包商說明
 folder.folderRecipientParties.partyDetails.subcontractorDescription string

如適用，請提供分包商的描述。
分包商組織
 folder.folderRecipientParties.partyDetails.subcontractorOrganization string

如適用，請提供分包商的組織名稱。
分包商新增日期
 folder.folderRecipientParties.partyDetails.subcAddedDate integer

分包商加入的日期，以 Unix 毫秒為單位。
Source
 folder.folderRecipientParties.partyDetails.source string

收件人被加入的來源。
撥號代碼
 folder.folderRecipientParties.dialingCode string

收件人手機號碼的國家撥號代碼。
行動電話號碼
 folder.folderRecipientParties.mobileNumber string

收件人的手機號碼。
簽章類型
 folder.folderRecipientParties.signerSignatureType string

這種簽名類型正是讓這位收禮者受益。
許可
 folder.folderRecipientParties.contractPermissions string

授予此收件人的簽署權限（例如，FILL_FIELDS_AND_SIGN）。
簽署訂單
 folder.folderRecipientParties.partySequence integer

該收件人在簽名順序中的位置。
工作流程序列
 folder.folderRecipientParties.workflowSignSequence integer

該接收者的工作流程簽名序號。
信封 ID
 folder.folderRecipientParties.envelopeId integer

收件人所屬信封的身分證。
黨公司識別碼
 folder.folderRecipientParties.partyCompanyId integer

收件人所屬公司的識別碼。
共享模式
 folder.folderRecipientParties.sharingMode string

與該收件人分享文件的方法（例如電子郵件）。
簽名網址
 folder.folderRecipientParties.folderAccessURL string

此收件人唯一的簽名網址。 請直接分享簽名連結。
安全性模式
 folder.folderRecipientParties.securityMode string

安全模式適用於此接收者的存取權限。
額外評論
 folder.folderRecipientParties.extraComments string

請收禮邀請函中包含任何額外評論。
允許更名
 folder.folderRecipientParties.allowNameChange boolean

表示收件人是否允許在簽名前更改姓名。
名稱更新
 folder.folderRecipientParties.signerNameUpdated boolean

顯示收件人是否已更新顯示名稱。
認證層級
 folder.folderRecipientParties.signerAuthenticationLevel string

該收件人存取文件所需的認證方式。
存取代碼
 folder.folderRecipientParties.userDefinedAccessCode string

此收件人需自訂存取碼才能開啟文件。
簽章識別碼
 folder.folderRecipientParties.signatureId string

收件人所使用的儲存簽章的 ID。
收件者角色
 folder.folderRecipientParties.partyRole string

信封中分配給收件人的角色。
公司田地價值
 folder.folderRecipientParties.companyFieldValue string

公司欄位的價值已預先填入。
田地價值
 folder.folderRecipientParties.titleFieldValue string

該得主的標題欄位值已預先填入。
簽約原因
 folder.folderRecipientParties.reasonSigning string

簽署原因由本收件人提供。
新增薪資欄位
 folder.folderRecipientParties.payFieldAdded boolean

顯示是否已為該收件人新增付款欄位。
是收款人嗎
 folder.folderRecipientParties.payee boolean

表示該收款人是否為收款人。
重複出現的欄位存在
 folder.folderRecipientParties.recurringFieldExist boolean

顯示此收件人是否存在定期付款欄位。
列印與招牌完成
 folder.folderRecipientParties.printAndSignCompleted boolean

表示收件人是否完成了列印與簽名動作。
允許可選簽署人
 folder.folderRecipientParties.allowOptionalSigner boolean

表示此收件人是否可作為可選簽署人跳過。
可選簽字者
 folder.folderRecipientParties.optionalSigners string

與此收件人相關的可選簽署人名單（如有）。
有薪
 folder.folderRecipientParties.paid boolean

顯示該收件人是否已完成付款。
作者存取網址
 folder.folderAccessURLForAuthor string

信封作者存取該文件的網址。
草稿存取網址
 folder.draftFolderAccessURL string

在信封處於草稿狀態時存取的網址。
董事會會議室標誌
 folder.boardRoomSign boolean

指示此信封是否啟用董事會室簽署功能。
包含標誌
 folder.includeLogo boolean

顯示公司標誌是否包含在電子郵件通知中。
電子郵件按鈕顏色
 folder.email_btnBgColor string

簽名郵件中動作按鈕的背景色。
電子郵件按鈕文字顏色
 folder.email_btnTxtColor string

簽署郵件中動作按鈕的文字顏色。
電子郵件標誌
 folder.emailTemplateLogo string

電子郵件範本中使用的標誌圖片。
電子郵件範本ID
 folder.emailTemplateId integer

用於簽署通知的電子郵件範本的 ID。
電子郵件標頭
 folder.emailHeader string

簽名通知郵件中的自訂標頭文字。
電子郵件頁尾
 folder.emailFooter string

簽名通知郵件中的自訂頁尾文字。
清洗預定
 folder.purgeFlag boolean

顯示此信封是否預定自動清除。
清洗開始日期
 folder.purgeStartDate string

清洗時期開始的日期。
清洗結束日期
 folder.purgeEndDate string

信封被清除的日期。
批量識別
 folder.bulkId integer

這個信封所屬的批次 ID 是該信封的。
執行標誌令
 folder.enforceSignWorkflow boolean

指示收件人是否必須依指定順序簽名。
目前工作流程步驟
 folder.currentWorkflowStep integer

這是目前簽署流程的步驟。
交易來源
 folder.transactionSource string

發起這個信封交易的來源。
可編輯
 folder.editable boolean

表示信封是否仍可編輯。
In-Person 簽名
 folder.inPersonSignable boolean

說明信封是否可親自簽名。
覆寫提醒
 folder.overrideAccountReminders boolean

顯示此信封是否覆蓋了帳戶層級的提醒設定。
覆寫授權
 folder.overrideAccountRecipientDelegation boolean

顯示此信封是否覆蓋了帳戶層級的委派設定。
允許授權
 folder.allowRecipientsToDelegate boolean

表示收件人是否被允許將簽名委派給他人。
ID
 folder.envelopeId integer

信封的唯一ID。 與 Envelope ID （folderId） 的值相同。
名稱
 folder.envelopeName string

信封的名字。 值與信封名稱（folderName）相同。
發起人 ID
 folder.envelopeOriginatorId integer

創建信封者的使用者ID。
公司編號
 folder.envelopeCompanyId integer

信封所屬公司的識別碼。
Date
 folder.envelopeDate integer

信封的製作日期和時間，以 Unix 毫秒計。
同日
 folder.envelopeSharedDate integer

信封與收件人共享的日期與時間，單位為 Unix 毫秒。
現況
 folder.envelopeStatus string

信封目前狀態。 與 Envelope Status（folderStatus）值相同。
合約識別碼
 folder.envelopeContractIds array of integer

與此信封相關的合約ID清單。
隊伍許可
 folder.envelopePartyPermissions array of object

收件人名單及其簽署許可。 結構與受贈者相同。
收件者 ID
 folder.envelopePartyPermissions.partyId integer

收件者的唯一識別碼。
簽名網址
 folder.envelopePartyPermissions.folderAccessURL string

此收件人唯一的簽名網址。
許可
 folder.envelopePartyPermissions.contractPermissions string

這位收件人的簽署權限。
簽署訂單
 folder.envelopePartyPermissions.partySequence integer

該收件人在簽名順序中的位置。
認證層級
 folder.envelopeAuthenticationLevel string

認證等級適用於整個信封。
允許單一簽名者批量
 folder.allowSingleSignerInBulk boolean

表示是否允許單簽名者在批量傳送模式中使用。
根據檔案名稱
 folder.folderNameBasedOnFileNaming boolean

表示信封名稱是否源自檔案名稱。
文件名稱依據檔案
 folder.documentNameBasedOnFileNaming boolean

表示文件名稱是否源自檔案名稱。
憑證名稱依檔案而定
 folder.certificateNameBasedOnFileNaming boolean

顯示憑證名稱是否源自檔案名稱。
啟用檔案命名
 folder.enableFileNamingBeforeExecution boolean

指示是否在寄送信封前會提示檔案命名。
收款人新增
 folder.payeeAddedd boolean

表示是否已加入收款人。
自簽者
 folder.selfSignerEnabled boolean

表示寄件人是否同時也是該信封上的簽名者。
公證人啟用
 folder.notaryEnabled boolean

顯示此信封是否啟用公證。
能見度有限
 folder.limitedVisibilityFlag boolean

顯示是否啟用有限文件可見性。
簽約後的能見度
 folder.postSigningVisibility boolean

表示收件人完成後是否能查看簽署文件。
啟用濕簽
 folder.wetSignatureEnabled boolean

表示此信封是否啟用濕簽（手寫）簽名。
合併啟用
 folder.mergeEnabled boolean

指示此信封是否啟用文件合併。

從網址建立信封

作業識別碼：
CreateEnvelopefromURL

使用公開可存取的 PDF URL 建立並寄送信封。 提供文件網址及收件人資訊以啟動簽署程序。

參數

名稱 機碼 必要 類型 Description
信封名稱
 folderName True string

這個信封的名字。
輸入類型
 inputType string

指定文件來源格式。 設定為 url 以提供檔案 URL，或 base64 以提供 Base64 編碼的檔案內容。
檔案網址
 fileUrls True array of string

一組公開可存取的網址，指向要加入此信封的文件。
檔案名稱
 fileNames True array of string

每個文件的顯示名稱陣列，順序與檔案網址相同。
名字
 firstName True string

收件者的名字。
姓氏
 lastName True string

收件者的姓氏。
Email 地址
 emailId True string

收件者的電子郵件地址。
使用權限
 permission True string
排序
 sequence True integer

使用此欄位將序號指派給收件人列表中的收件人。 請為每個隊伍使用以 1 開頭的獨特序號，例如 1、2、3、4......如果同一個人在簽名流程中出現多次，請每次重複接收者時分配不同的序列。
signerAuthLevels
 signerAuthLevel string

簽署者用於驗證目的所使用的認證層級
是佔位符
 isPlaceholder boolean

用這個欄位來啟動派對，是佔位符。 註：1. firstName、lastName、emailId 參數的值必須是該方的空欄。 2. 要加入佔位符，必須要求一位收件人獲得「PARTY_ASSIGNER」權限。
收件者角色
 partyRole string

使用此欄位來指派佔位符的角色。
允許更名
 allowNameChange string

值可以是真或假，使用此參數允許簽署者在完成簽名前更新名字和姓氏。
工作流程序列
 workflowSequence integer

為此收件人指派一個工作流程序號。 啟用登入序列後，收件人會依序收到簽名邀請。
主機電子郵件識別碼
 hostEmailId string

In-Person 管理員的電子郵件地址。
存取代碼
 userDefinedAccessCode string

當「signerAuthLevel」值被設定為「使用者定義存取碼」以進行驗證時，該參數將包含存取碼。 註：1. 代碼不區分大小寫。 2. 系統不會傳送這個代碼，所以你必須直接與簽署人分享。 3. 存取碼可包含字母表、數字及以下特殊字元：@，&，{,}%，（，），~，|,!,+，^。
Party 是電子郵件群組
 partyIsEmailGroup boolean

在大量創建隊伍時使用這個參數。 註： 若此參數為真，該方的名字、姓氏和電子郵件ID將被忽略。
電子郵件群組識別碼
 emailGroupId integer

把你想用來建立大量群組的群組ID傳給電子郵件。
單一簽名者批量
 allowSingleSignerInBulk boolean

使用此參數允許只有一人登入電子郵件群組。
撥號代碼
 dialingCode string

使用此欄位將撥入代碼分配給收件人的國家撥號前綴。
行動電話號碼
 mobileNumber string

使用此欄位將手機號碼指派給收件人列表中的收件人。
欄位
 Fields object
立即發送
 sendNow boolean

啟用後，Foxit eSign 會立即向每位收件人的電子郵件地址發送獨特的簽名連結。 關閉這個功能，可以把信封存成草稿。
建立嵌入式簽署會話
 createEmbeddedSigningSession True boolean

簽署會話令牌會在不發送電子郵件給收件人的情況下產生。
為所有參與者建立嵌入式簽署會議
 createEmbeddedSigningSessionForAllParties boolean

若設定為 true，信封中每個收件人都會產生一個嵌入的簽名 URL。
程序文字標籤
 processTextTags True boolean

價值可以是真或假。 此欄位用來判斷 Foxit eSign 是否應解析文件中的文字標籤，並將其轉換為 Foxit eSign 欄位。
工藝雜技場
 processAcroFields True boolean

此欄位用來判斷 Foxit eSign 是否應解析 AcroFields 的文件，並將其轉換為 Foxit eSign 欄位。
登入順序
 signInSequence boolean

此欄位用來判斷收件人是否會依序簽署信封文件。 如果是錯誤，則所有收件人會同時收到邀請郵件。 若屬實，則在前一位收件人完成所需任務（如簽署文件或填寫欄位等）後，依序收到邀請郵件。
面對面啟用
 inPersonEnable boolean

此欄位用於啟動面對面簽署流程，該流程可在任何裝置上輕鬆完成，且在必要時避免電子郵件簽名。 如果錯誤，則所有收件人會同時收到邀請郵件。 若屬實，現場管理員會收到邀請電子郵件，啟動簽署者簽署程序。
修正接收方
 fixRecipientParties boolean

如果成立，則在嵌入的發送視窗中，無法更改已加入此請求的信封當事人。
修正文件
 fixDocuments boolean

如果屬實，則在內嵌的傳送中無法更改已加入此請求的信封文件。
傳送成功網址
 sendSuccessUrl string

輸入登陸頁的絕對網址，簽署者在成功將資料夾傳送到嵌入的發送視窗後，會被重新導向到該網址。
發送錯誤網址
 sendErrorUrl string

輸入登陸頁的絕對網址，若在嵌入的發送視窗中傳送資料夾時出現錯誤，簽署者會被重新導向該網址。
建立嵌入式發送會話
 createEmbeddedSendingSession boolean

若設為 true，則會產生嵌入的令牌以開啟 Foxit eSign 的文件準備檢視。
嵌入簽署者電子郵件識別碼
 embeddedSignersEmailIds array of string

一組收件人的電子郵件 ID，需要為這些收件人建立嵌入式簽署會話。 收件人的電子郵件 ID 會被加入當事人清單。
簽名成功網址
 signSuccessUrl string

輸入簽署者的絕對網址，成功登入嵌入簽名檢視後，簽署者會被重新導向。
招牌拒絕網址
 signDeclineUrl string

輸入簽署者的絕對網址，若簽署者拒絕登入，則會被重新導向。
稍後簽署網址
 signLaterUrl string

輸入簽名者的絕對網址，若簽署者選擇稍後在內嵌簽名檢視中簽署，將被重新導轉至該網址。
符號錯誤網址
 signErrorUrl string

輸入簽署者的絕對網址，若在嵌入簽署檢視中出現錯誤，簽署者會被重新導向。
允許立即發送與嵌入式簽署會話
 allowSendNowAndEmbeddedSigningSession boolean

若設定為真，Foxit eSign 會向每位收件人發送獨特的簽署連結。 這只適用於參數 sendNow 和 createEmbeddedSigningSession 為真時。
進階電子郵件驗證
 allowAdvancedEmailValidation boolean

當設定為真實時，驗證雙方的電子郵件地址。
簽署成功 所有相關方 網址
 signSuccessUrlAllParties boolean

若設定為 true，簽署者成功簽署後將被導向至 signSuccessUrl 中提供的網址。 這只適用於 sendNow 為真時。
電子郵件範本ID
 emailTemplateId integer

傳送電子郵件範本 ID 以發送非預設郵件範本的電子郵件範本。
簽署者指令識別碼
 signerInstructionId integer

傳遞指令 ID 以傳送非預設簽署指令的簽署者指令。
確認指示ID
 confirmationInstructionId string

傳送確認指令 ID 以傳送非預設確認指令的確認指令。
主題顏色
 themeColor string

輸入 CSS 值來設定主題顏色。
會話結束
 sessionExpire boolean

設為 true 以啟動嵌入簽署會話的到期。
到期日
 expiry integer

如果 sessionExpire 為真，則必須如此。 輸入嵌入簽署會話到期後毫秒的持續時間。
依賴欄位名稱
 dependentFieldName True string

由父欄位控制可見性的欄位名稱。
母田名稱
 parentFieldName True string

控制依賴欄位可見性的父欄位名稱。 支援的父欄位類型：textfield、textbox、checkbox、radiobutton、下拉選單。
母欄位值
 parentFieldValue True string

觸發依賴欄位變得可見的父欄位值。 對於勾選框和無線按鈕欄位，請使用勾選或未勾選。
選項
 options True string

新增文字基礎父欄位的匹配選項。 接受的值：isblank、allowNull、contains。
後設資料
 metadata object

這應該是關鍵值對。 最多允許 1000 對關鍵值對。
寄件者電子郵件
 senderEmail string

請在你的帳戶中輸入另一位使用者的電子郵件，該資料夾將用於將此文件資料夾寄送給收件人。
隱藏 新增我按鈕
 hideAddMeButton boolean

如果屬實，它會在嵌入的發送會話中隱藏收件人方的「新增我」按鈕。
隱藏新增按鈕
 hideAddNewButton boolean

如果是這樣，它會在嵌入的發送會話中隱藏收件人方的「新增新」按鈕。
隱藏新增群組按鈕
 hideAddGroupButton boolean

如果屬實，它會在嵌入的發送會話中隱藏收件人方的「新增群組」按鈕。
隱藏收件人欄位名稱
 hideFieldNameForRecipients boolean

隱藏收件人欄位名稱，用於資料輸入欄位與進階欄位。 （除了單選按鈕、勾選框、圖片和超連結）。
隱藏邊框勾選框
 hideCheckboxBorder boolean

勾選框的邊界會隱藏在已執行的文件中。
隱藏簽署者選擇選項
 hideSignerSelectOption boolean

如果屬實，它會在嵌入的發送會話中隱藏收件人方的「現有簽署人姓名/電子郵件」輸入框。
隱藏簽署者行動
 hideSignerActions boolean

若屬實，則會隱藏簽署方在嵌入傳送會話中對接收方的「編輯」、「變更」與「移除」操作。
隱藏發送者名稱
 hideSenderName boolean

若屬實，則會在嵌入的發送會話中隱藏收件人名稱。
隱藏資料夾名稱
 hideFolderName boolean

如果是這樣，它會在兩個嵌入式工作階段的導覽中隱藏資料夾名稱。
隱藏文件名稱
 hideDocumentsName boolean

如果是這樣，它會在兩個嵌入的會話中隱藏文件名稱。
隱藏拒絕簽署
 hideDeclineToSign boolean

如果屬實，它會隱藏簽署者「拒絕簽署」的選項。
隱藏更多行動
 hideMoreAction boolean

如果是真的，它會在發送/簽署時隱藏「更多動作」按鈕。 若為「立即傳送」：為真，則不會隱藏任何資訊。
隱藏 傳送按鈕
 hideSendButton boolean

如果是真的，它會在嵌入的發送會話中隱藏「發送」按鈕。
隱藏下一個必要欄位btn
 hideNextRequiredFieldbtn boolean

若設為 true，則隱藏將簽署者移至下一個必填欄位的導航按鈕。
需要同時進行嵌入式會話
 requiredBothEmbeddedSession boolean

如果屬實，它會同時產生嵌入的發送與簽署 URL。
信封密碼
 folderPassword string

簽署者/作者必須使用此密碼才能開啟數位簽署文件。 若參數保持空白，則無需密碼即可開啟數位簽署文件。
啟用逐步啟用
 enableStepByStep boolean

以便在嵌入的發送會話中啟用逐步操作。
隱藏 新增政黨選項
 hideAddPartiesOption boolean

如果是真的，它會在草稿和範本建立模式中隱藏「新增政黨」的選項。
自我簽名
 selfSign boolean

它透過 API 實現嵌入式自我簽名功能。 此參數僅在 createEmbeddedSendingSession 參數為真時適用。
自我簽名成功網址
 selfSignerSuccessUrl string

在你的網站或應用程式中輸入登陸頁的絕對網址，使用者在成功自我簽名並將資料夾傳送到嵌入的發送視窗後，會被重新導向到該網址。

傳回

名稱 路徑 類型 Description
ID
 folder.folderId integer

新建立信封的唯一ID。 在後續操作中用這個字串來參考這個信封。
名稱
 folder.folderName string

新創造的信封名稱。
自訂名稱
 folder.folderCustomName string

信封的自訂名稱。
Password
 folder.folderPassword string

信封的存取密碼（如果設定好了）。
創作者識別碼
 folder.folderAuthorId integer

信封創建者的唯一識別碼。
創作者名字
 folder.folderAuthorFirstName string

信封製作者的名字。
創作者姓氏
 folder.folderAuthorLastName string

信封製作者的姓氏。
創作者電子郵件
 folder.folderAuthorEmail string

信封製作者的電子郵件地址。
創作者角色
 folder.folderAuthorRole string

信封製作者的角色。
公司編號
 folder.folderCompanyId integer

擁有信封的公司的唯一識別碼。
建立日期
 folder.folderCreationDate integer

信封創建日期（Unix 時間戳記，單位為毫秒）。
傳送日期
 folder.folderSentDate integer

信封寄出日期（Unix 時間戳記，毫秒）。
現況
 folder.folderStatus string

信封目前狀態。
自訂欄位 1
 folder.custom_field1 string

信封的第一個自訂元資料欄位。
自訂欄位 2
 folder.custom_field2 string

信封的第二個自訂元資料欄位。
後設資料
 folder.metadata string

與信封相關的自訂元資料。
文件識別碼
 folder.folderDocumentIds array of integer

信封內的文件識別碼清單。
Documents
 folder.documentsList array of object

信封裡的文件清單。
文件識別碼
 folder.documentsList.documentId integer

檔的唯一標識碼。
合約 ID
 folder.documentsList.contractId integer

合約的唯一識別碼。
公司編號
 folder.documentsList.companyId integer

公司的唯一識別碼。
作者
 folder.documentsList.contractCreatedBy integer

創建合約者的使用者ID。
創建日期
 folder.documentsList.contractCreatedOn string

合約成立的日期和時間。
合約類型
 folder.documentsList.contractType string

合約的類型。
合約狀態
 folder.documentsList.contractStatus string

合約目前狀態。
可編輯
 folder.documentsList.editable boolean

表示該項目是否可編輯。
版本識別碼
 folder.documentsList.contractVersionId integer

合約版本的唯一識別碼。
版本名稱
 folder.documentsList.contractVersionName string

合約版本的名稱。
版本描述
 folder.documentsList.contractVersionDesc string

這是合約版本的描述。
版本製作
 folder.documentsList.versionCreatedby integer

創建此版本者的使用者ID。
建立於
 folder.documentsList.versionCreatedOn string

這個版本的製作日期和時間。
版本號碼
 folder.documentsList.contractVersionNumber integer

合約的版本號。
交易來源
 folder.documentsList.contractTransactionSource string

就是啟動合約交易的來源系統。
收件者
 folder.folderRecipientParties array of object

這個信封的收件人名單。
收件者 ID
 folder.folderRecipientParties.partyId integer

收件者的唯一識別碼。
收件者 ID
 folder.folderRecipientParties.partyDetails.partyId integer

收件者的唯一識別碼。
名字
 folder.folderRecipientParties.partyDetails.firstName string

收件人的名字。
姓氏
 folder.folderRecipientParties.partyDetails.lastName string

收件人的姓氏。
Email 地址
 folder.folderRecipientParties.partyDetails.emailId string

收件者的電子郵件地址。
預留位置
 folder.folderRecipientParties.partyDetails.placeholder boolean

表示該隊伍是否為佔位收件人。
地址
 folder.folderRecipientParties.partyDetails.address string

收件人的實體地址。
建立日期
 folder.folderRecipientParties.partyDetails.dateCreated integer

記錄建立日期（Unix 時間戳，單位為毫秒）。
拒絕寄出電子郵件
 folder.folderRecipientParties.partyDetails.optOutEmails boolean

顯示收件人是否選擇不接收電子郵件通知。
唯一收件人 ID
 folder.folderRecipientParties.partyDetails.uniquePartyId string

此接收者的唯一系統識別碼。
認證等級
 folder.folderRecipientParties.partyDetails.authenticationLevel string

此收件人所需的認證方式。
密碼更新日期
 folder.folderRecipientParties.partyDetails.passwordUpdateDate string

密碼最後更新的日期。
密碼更新狀態
 folder.folderRecipientParties.partyDetails.passwordUpdateStatus boolean

顯示密碼是否已更新。
公司編號
 folder.folderRecipientParties.partyDetails.companyId integer

公司的唯一識別碼。
使用者角色
 folder.folderRecipientParties.partyDetails.userRole string

指派給使用者的角色。
部門
 folder.folderRecipientParties.partyDetails.department string

使用者所屬的部門。
Title
 folder.folderRecipientParties.partyDetails.title string

使用者的職稱。
作用中
 folder.folderRecipientParties.partyDetails.active boolean

顯示使用者或紀錄是否為啟用狀態。
地區設定
 folder.folderRecipientParties.partyDetails.requestLocale string

使用者的地點設定。
與部門分享
 folder.folderRecipientParties.partyDetails.share_among_department boolean

表示信封是否跨部門共享。
撥號代碼
 folder.folderRecipientParties.partyDetails.dialingCode string

電話號碼的國際撥號代碼。
行動電話號碼
 folder.folderRecipientParties.partyDetails.mobileNumber string

行動電話號碼。
狀態過濾器
 folder.folderRecipientParties.partyDetails.docStatusFilter string

文件狀態篩選器。
日期濾鏡
 folder.folderRecipientParties.partyDetails.docDateFilter string

文件日期的篩選器。
安全現場存取
 folder.folderRecipientParties.partyDetails.userSecureFieldAccess boolean

顯示使用者是否能存取安全欄位。
展開側邊欄
 folder.folderRecipientParties.partyDetails.expandSidebar boolean

顯示側邊欄是否預設展開。
進階電子郵件驗證
 folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation boolean

顯示是否啟用了進階電子郵件驗證。
管理員 ID
 folder.folderRecipientParties.partyDetails.managerId string

使用者管理者的唯一識別碼。
登入次數
 folder.folderRecipientParties.partyDetails.loginCount integer

使用者登入的次數。
密碼重設電子郵件
 folder.folderRecipientParties.partyDetails.sendMailForPasswordReset boolean

指示是否應該發送密碼重設郵件。
部門識別碼
 folder.folderRecipientParties.partyDetails.departmentId string

部門的唯一識別碼。
主要連隊
 folder.folderRecipientParties.partyDetails.userPrimaryCompany integer

與使用者相關的主要公司。
裝置類型
 folder.folderRecipientParties.partyDetails.deviceType string

所使用的裝置類型。
裝置令牌
 folder.folderRecipientParties.partyDetails.deviceToken string

裝置的推播通知令牌。
分包商說明
 folder.folderRecipientParties.partyDetails.subcontractorDescription string

分包商或外部簽約人的描述。
分包商組織
 folder.folderRecipientParties.partyDetails.subcontractorOrganization string

分包商或外部簽約人的組織名稱。
分包商新增日期
 folder.folderRecipientParties.partyDetails.subcAddedDate integer

分包商加入日期（Unix 時間戳，以毫秒計）。
Source
 folder.folderRecipientParties.partyDetails.source string

外部簽署者所從的來源系統。
撥號代碼
 folder.folderRecipientParties.dialingCode string

電話號碼的國際撥號代碼。
行動電話號碼
 folder.folderRecipientParties.mobileNumber string

行動電話號碼。
簽章類型
 folder.folderRecipientParties.signerSignatureType string

簽署人會使用的簽名類型。
許可
 folder.folderRecipientParties.contractPermissions string

該方獲得合約許可。
簽署訂單
 folder.folderRecipientParties.partySequence integer

這位收件人的簽約訂單序號。
工作流程序列
 folder.folderRecipientParties.workflowSignSequence integer

工作流程簽名序號。
信封 ID
 folder.folderRecipientParties.envelopeId integer

信封的唯一識別碼。
收件人公司識別碼
 folder.folderRecipientParties.partyCompanyId integer

與此收件人關聯的公司唯一識別碼。
共享模式
 folder.folderRecipientParties.sharingMode string

這個信封的分享模式。
收件人存取網址
 folder.folderRecipientParties.folderAccessURL string

收件人可用來存取並簽名信封的網址。
安全性模式
 folder.folderRecipientParties.securityMode string

安全模式套用在這個信封上。
Comments
 folder.folderRecipientParties.extraComments string

信封附有額外評論。
允許更名
 folder.folderRecipientParties.allowNameChange boolean

表示收件人是否被允許更新姓名。
名稱更新
 folder.folderRecipientParties.signerNameUpdated boolean

表示簽署人是否已更新姓名。
簽署者認證等級
 folder.folderRecipientParties.signerAuthenticationLevel string

簽署者所需的認證等級。
存取代碼
 folder.folderRecipientParties.userDefinedAccessCode string

為簽署者定義的自訂存取碼。
簽章識別碼
 folder.folderRecipientParties.signatureId string

簽名的唯一識別碼。
收件者角色
 folder.folderRecipientParties.partyRole string

指派給此收件人在簽署工作流程中的角色。
連隊場地
 folder.folderRecipientParties.companyFieldValue string

簽名中公司名稱欄位的價值。
標題欄位
 folder.folderRecipientParties.titleFieldValue string

簽名中標題欄位的值。
簽約原因
 folder.folderRecipientParties.reasonSigning string

收件人簽署文件的原因。
新增付款欄位
 folder.folderRecipientParties.payFieldAdded boolean

顯示是否新增了付款欄位。
收款人
 folder.folderRecipientParties.payee boolean

表示該收款人是否為收款人。
定期付款
 folder.folderRecipientParties.recurringFieldExist boolean

表示是否存在持續支付欄位。
列印與簽名完成
 folder.folderRecipientParties.printAndSignCompleted boolean

表示印刷與簽名程序是否完成。
有薪
 folder.folderRecipientParties.paid boolean

顯示付款是否已完成。
允許可選簽署人
 folder.folderRecipientParties.allowOptionalSigner boolean

表示該收件人是否為可選簽署者。
可選簽字者
 folder.folderRecipientParties.optionalSigners array of integer

此信封的可選簽署方身份證清單。
作者簽名網址
 folder.folderAccessURLForAuthor string

寄件人可用來存取信封的網址。
草稿存取網址
 folder.draftFolderAccessURL string

用來存取信封草稿版本的網址。
董事會簽署
 folder.boardRoomSign boolean

指示是否啟用董事會簽署模式。
包含標誌
 folder.includeLogo boolean

顯示電子郵件中是否包含公司標誌。
按鈕背景色
 folder.email_btnBgColor string

電子郵件按鈕的背景色。
按鈕文字顏色
 folder.email_btnTxtColor string

電子郵件按鈕的文字顏色。
電子郵件標誌
 folder.emailTemplateLogo string

電子郵件範本中使用的標誌網址。
電子郵件範本ID
 folder.emailTemplateId integer

電子郵件範本的唯一識別碼。
電子郵件標頭
 folder.emailHeader string

通知郵件中使用的標頭文字。
電子郵件頁尾
 folder.emailFooter string

通知郵件中使用的頁尾文字。
清洗預定
 folder.purgeFlag boolean

指示信封是否排定清除。
清洗開始日期
 folder.purgeStartDate string

清洗預定開始的日期。
清洗結束日期
 folder.purgeEndDate string

清除預定完成的日期。
批量發送 ID
 folder.bulkId integer

批量發送操作的唯一識別碼。
執行標誌令
 folder.enforceSignWorkflow boolean

表示收件人是否必須依照指定順序簽名。
目前步驟
 folder.currentWorkflowStep integer

這是目前簽署流程的步驟。
交易來源
 folder.transactionSource string

發起此交易的來源系統。
可編輯
 folder.editable boolean

表示該項目是否可編輯。
In-Person 簽名
 folder.inPersonSignable boolean

說明信封是否可親自簽名。
覆寫提醒
 folder.overrideAccountReminders boolean

顯示帳號層級提醒設定是否被覆寫。
覆寫授權
 folder.overrideAccountRecipientDelegation boolean

顯示帳號層級委派設定是否被覆蓋。
允許授權
 folder.allowRecipientsToDelegate boolean

表示收件人是否被允許委派簽署工作。
ID
 folder.envelopeId integer

信封的唯一識別碼。
名稱
 folder.envelopeName string

信封的名字。
發起人 ID
 folder.envelopeOriginatorId integer

創建信封使用者的唯一識別碼。
公司編號
 folder.envelopeCompanyId integer

擁有信封的公司的唯一識別碼。
Date
 folder.envelopeDate integer

信封創建日期（Unix 時間戳記，單位為毫秒）。
同日
 folder.envelopeSharedDate integer

信封被分享的日期（Unix 時間戳記，以毫秒計）。
現況
 folder.envelopeStatus string

信封目前狀態。
合約識別碼
 folder.envelopeContractIds array of integer

與此信封相關的合約ID清單。
收件人權限
 folder.envelopePartyPermissions array of object

這個信封的收件人權限清單。
收件者 ID
 folder.envelopePartyPermissions.partyId integer

收件者的唯一識別碼。
收件者 ID
 folder.envelopePartyPermissions.partyDetails.partyId integer

收件者的唯一識別碼。
名字
 folder.envelopePartyPermissions.partyDetails.firstName string

收件人的名字。
姓氏
 folder.envelopePartyPermissions.partyDetails.lastName string

收件人的姓氏。
Email 地址
 folder.envelopePartyPermissions.partyDetails.emailId string

收件者的電子郵件地址。
預留位置
 folder.envelopePartyPermissions.partyDetails.placeholder boolean

表示該隊伍是否為佔位收件人。
地址
 folder.envelopePartyPermissions.partyDetails.address string

收件人的實體地址。
建立日期
 folder.envelopePartyPermissions.partyDetails.dateCreated integer

記錄建立日期（Unix 時間戳，單位為毫秒）。
拒絕寄出電子郵件
 folder.envelopePartyPermissions.partyDetails.optOutEmails boolean

顯示收件人是否選擇不接收電子郵件通知。
唯一收件人 ID
 folder.envelopePartyPermissions.partyDetails.uniquePartyId string

此接收者的唯一系統識別碼。
認證等級
 folder.envelopePartyPermissions.partyDetails.authenticationLevel string

此收件人所需的認證方式。
密碼更新日期
 folder.envelopePartyPermissions.partyDetails.passwordUpdateDate string

密碼最後更新的日期。
密碼更新狀態
 folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus boolean

顯示密碼是否已更新。
公司編號
 folder.envelopePartyPermissions.partyDetails.companyId integer

公司的唯一識別碼。
使用者角色
 folder.envelopePartyPermissions.partyDetails.userRole string

指派給使用者的角色。
部門
 folder.envelopePartyPermissions.partyDetails.department string

使用者所屬的部門。
Title
 folder.envelopePartyPermissions.partyDetails.title string

使用者的職稱。
作用中
 folder.envelopePartyPermissions.partyDetails.active boolean

顯示使用者或紀錄是否為啟用狀態。
地區設定
 folder.envelopePartyPermissions.partyDetails.requestLocale string

使用者的地點設定。
與部門分享
 folder.envelopePartyPermissions.partyDetails.share_among_department boolean

表示信封是否跨部門共享。
撥號代碼
 folder.envelopePartyPermissions.partyDetails.dialingCode string

電話號碼的國際撥號代碼。
行動電話號碼
 folder.envelopePartyPermissions.partyDetails.mobileNumber string

行動電話號碼。
狀態過濾器
 folder.envelopePartyPermissions.partyDetails.docStatusFilter string

文件狀態篩選器。
日期濾鏡
 folder.envelopePartyPermissions.partyDetails.docDateFilter string

文件日期的篩選器。
安全現場存取
 folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess boolean

顯示使用者是否能存取安全欄位。
展開側邊欄
 folder.envelopePartyPermissions.partyDetails.expandSidebar boolean

顯示側邊欄是否預設展開。
進階電子郵件驗證
 folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation boolean

顯示是否啟用了進階電子郵件驗證。
管理員 ID
 folder.envelopePartyPermissions.partyDetails.managerId string

使用者管理者的唯一識別碼。
登入次數
 folder.envelopePartyPermissions.partyDetails.loginCount integer

使用者登入的次數。
密碼重設電子郵件
 folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset boolean

指示是否應該發送密碼重設郵件。
部門識別碼
 folder.envelopePartyPermissions.partyDetails.departmentId string

部門的唯一識別碼。
主要連隊
 folder.envelopePartyPermissions.partyDetails.userPrimaryCompany integer

與使用者相關的主要公司。
裝置類型
 folder.envelopePartyPermissions.partyDetails.deviceType string

所使用的裝置類型。
裝置令牌
 folder.envelopePartyPermissions.partyDetails.deviceToken string

裝置的推播通知令牌。
分包商說明
 folder.envelopePartyPermissions.partyDetails.subcontractorDescription string

分包商或外部簽約人的描述。
分包商組織
 folder.envelopePartyPermissions.partyDetails.subcontractorOrganization string

分包商或外部簽約人的組織名稱。
分包商新增日期
 folder.envelopePartyPermissions.partyDetails.subcAddedDate integer

分包商加入日期（Unix 時間戳，以毫秒計）。
Source
 folder.envelopePartyPermissions.partyDetails.source string

外部簽署者所從的來源系統。
撥號代碼
 folder.envelopePartyPermissions.dialingCode string

電話號碼的國際撥號代碼。
行動電話號碼
 folder.envelopePartyPermissions.mobileNumber string

行動電話號碼。
簽章類型
 folder.envelopePartyPermissions.signerSignatureType string

簽署人會使用的簽名類型。
許可
 folder.envelopePartyPermissions.contractPermissions string

該方獲得合約許可。
簽署訂單
 folder.envelopePartyPermissions.partySequence integer

這位收件人的簽約訂單序號。
工作流程序列
 folder.envelopePartyPermissions.workflowSignSequence integer

工作流程簽名序號。
信封 ID
 folder.envelopePartyPermissions.envelopeId integer

信封的唯一識別碼。
收件人公司識別碼
 folder.envelopePartyPermissions.partyCompanyId integer

與此收件人關聯的公司唯一識別碼。
共享模式
 folder.envelopePartyPermissions.sharingMode string

這個信封的分享模式。
收件人存取網址
 folder.envelopePartyPermissions.folderAccessURL string

收件人可用來存取並簽名信封的網址。
安全性模式
 folder.envelopePartyPermissions.securityMode string

安全模式套用在這個信封上。
Comments
 folder.envelopePartyPermissions.extraComments string

信封附有額外評論。
允許更名
 folder.envelopePartyPermissions.allowNameChange boolean

表示收件人是否被允許更新姓名。
名稱更新
 folder.envelopePartyPermissions.signerNameUpdated boolean

表示簽署人是否已更新姓名。
簽署者認證等級
 folder.envelopePartyPermissions.signerAuthenticationLevel string

簽署者所需的認證等級。
存取代碼
 folder.envelopePartyPermissions.userDefinedAccessCode string

為簽署者定義的自訂存取碼。
簽章識別碼
 folder.envelopePartyPermissions.signatureId string

簽名的唯一識別碼。
收件者角色
 folder.envelopePartyPermissions.partyRole string

指派給此收件人在簽署工作流程中的角色。
連隊場地
 folder.envelopePartyPermissions.companyFieldValue string

簽名中公司名稱欄位的價值。
標題欄位
 folder.envelopePartyPermissions.titleFieldValue string

簽名中標題欄位的值。
簽約原因
 folder.envelopePartyPermissions.reasonSigning string

收件人簽署文件的原因。
新增付款欄位
 folder.envelopePartyPermissions.payFieldAdded boolean

顯示是否新增了付款欄位。
收款人
 folder.envelopePartyPermissions.payee boolean

表示該收款人是否為收款人。
定期付款
 folder.envelopePartyPermissions.recurringFieldExist boolean

表示是否存在持續支付欄位。
列印與簽名完成
 folder.envelopePartyPermissions.printAndSignCompleted boolean

表示印刷與簽名程序是否完成。
有薪
 folder.envelopePartyPermissions.paid boolean

顯示付款是否已完成。
認證等級
 folder.envelopeAuthenticationLevel string

信封所需的認證等級。
單一簽名者批量
 folder.allowSingleSignerInBulk boolean

表示是否允許單簽名者在批量傳送模式中使用。
File-Based 命名
 folder.folderNameBasedOnFileNaming boolean

顯示資料夾名稱是否基於檔案名稱。
醫生 File-Based 名稱
 folder.documentNameBasedOnFileNaming boolean

顯示文件名稱是否基於檔案名稱。
證書 File-Based 名稱
 folder.certificateNameBasedOnFileNaming boolean

顯示憑證名稱是否基於檔案名稱。
預執行檔案命名
 folder.enableFileNamingBeforeExecution boolean

指示文件執行前是否啟用檔案命名。
收款人新增
 folder.payeeAddedd boolean

表示是否已新增收款人。
Self-Signing 啟用
 folder.selfSignerEnabled boolean

指示是否啟用自簽模式。
公證人啟用
 folder.notaryEnabled boolean

顯示是否啟用公證人簽名。
能見度有限
 folder.limitedVisibilityFlag boolean

表示此包絡是否啟用有限可見性。
標示後可見度
 folder.postSigningVisibility boolean

顯示是否啟用簽署後可視性。
濕簽名
 folder.wetSignatureEnabled boolean

顯示是否啟用濕簽名。
合併啟用
 folder.mergeEnabled boolean

顯示文件合併是否啟用。
嵌入式簽署會議
 embeddedSigningSessions array of object

嵌入式簽名會的清單，每位收件人一次。 只有當 createEmbeddedSigningSession 為真時才會出現。
簽署者電子郵件
 embeddedSigningSessions.emailIdOfSigner string

本次嵌入式簽署會議收件人的電子郵件地址。
簽署權杖
 embeddedSigningSessions.embeddedToken string

這位收件人嵌入簽名會的獨特代幣。
簽署會話網址
 embeddedSigningSessions.embeddedSessionURL string

收件人可開啟或嵌入的網址，以便簽署該文件。
嵌入式發送令牌
 embeddedToken string

嵌入發送會話的令牌。 只有當 createEmbeddedSendingSession 為真時才會出現。
發送會話網址
 embeddedSessionURL string

信封作者準備並寄出信封時，開啟或嵌入的網址。 只有當 createEmbeddedSendingSession 為真時才會出現。
Result
 result string

運算的結果。
Message
 message string

一則描述操作結果的訊息。

從網址建立範本

作業識別碼：
CreateTemplatefromURL

使用公開可存取的 PDF URL 建立新範本。

參數

名稱 機碼 必要 類型 Description
範本名稱
 templateName True string

範本的名稱。 必須以 .pdf 擴展結尾（例如，onboarding.pdf）。
範本網址
 templateUrl True string

PDF文件的公開網址，供用作範本。
輸入類型
 inputType True string

文件的輸入法。 此動作必須設定為 'url'。
程序文字標籤
 processTextTags True boolean

啟用後，Foxit eSign 會掃描文件中的文字標籤，並自動將其轉換為簽名欄位。
工藝雜技場
 processAcroFields True boolean

啟用後，Foxit eSign 會掃描文件中的 AcroFields，並自動將其轉換為簽名欄位。
分享全部
 shareAll True boolean

請將此範本分享給你帳號中的所有使用者。
政黨數量
 numberOfParties True integer

在範本中加入政黨數量。 此參數的值應小於20。
主題顏色
 themeColor string

輸入 css 值以更改 createEmbeddedTemplateSession 的主題。
作者Email
 authorEmail string

請在帳號中輸入另一位使用者的電子郵件，該帳號將作為此範本的作者。
建立嵌入範本會話
 createEmbeddedTemplateSession boolean

若設定為 true，則會有一個嵌入範本會話，直接開啟 Foxit eSign 範本準備檢視。 範本上可以拖放各種欄位。
重新導向網址
 redirectURL string

如果 createEmbeddedTemplateSession 為真，則可在任何網站或應用程式的登陸頁輸入絕對網址，使用者在嵌入範本檢視中點擊「儲存並關閉」後會被重新導向至該頁面。
隱藏 傳送範本
 hideSendTemplate boolean

如果是真的，它會在嵌入的範本檢視中隱藏「發送」按鈕。
修正接收方
 fixRecipientParties boolean

如果成立，則在嵌入的範本檢視中無法更改已加入的信封當事人。
欄位
 Fields object
使用權限
 permission True string
排序
 sequence True integer

此隊伍唯一的序號，從 1 開始。 在啟用登入序列時定義簽署順序。
收件者角色
 partyRole True string

模板中分配給這個隊伍的角色。
隱藏更多行動
 hideMoreAction boolean

如果是這樣，模板會話中隱藏「更多動作」按鈕。
隱藏與分享
 hideShareWithAll boolean

如果是這樣，它會在範本會話中隱藏「與所有人分享」的選項。
隱藏新增隊伍
 hideAddParty boolean

如果是真的，它會在嵌入的範本會話中隱藏所有新增隊伍的選項。
隱藏我按鈕
 hideMeButton boolean

如果屬實，它會在嵌入的範本會話中隱藏收件人方的「我」按鈕。
隱藏他人按鈕
 hideOthersButton boolean

如果屬實，它會在嵌入的範本會話中隱藏接收方的「其他人」按鈕。
隱藏現有聯絡人選擇選項
 hideExistingContactSelectOption boolean

如果屬實，它會在嵌入的範本會話中隱藏收件人方的「尋找並新增現有聯絡人」輸入框。
隱藏收件人欄位名稱
 hideFieldNameForRecipients boolean

隱藏收件人欄位名稱，用於資料輸入欄位與進階欄位。（除了單選按鈕、勾選框、圖片和超連結）。
隱藏邊框勾選框
 hideCheckboxBorder boolean

勾選框的邊界會隱藏在已執行的文件中。

傳回

名稱 路徑 類型 Description
Result
 result string

表示操作是否成功（例如「成功」）。
Message
 message string

行動結果的描述。
ID
 template.templateId integer

所建立範本的唯一 ID。 用這個範本來建立信封。
名稱
 template.templateName string

範本的名稱。
Description
 template.templateDesc string

範本的描述。
類型
 template.templateType string

範本的類型。
建立日期
 template.templateCreationDate string

模板建立的日期。
最後更新日期
 template.templateLastUpdateDate string

模板最後更新的日期。
可編輯
 template.editable boolean

顯示範本是否可編輯。
政黨數量
 template.numberOfParties integer

範本中定義的接收方數量。
總頁數
 template.totalPages integer

範本文件的總頁數。
公司編號
 template.companyId integer

這個範本所屬公司的 ID。
與眾共享
 template.shareAll boolean

顯示此範本是否與帳號內所有使用者共享。
自訂名稱模式
 template.templateCustomName string

自訂名稱模式套用在這個範本中建立的信封。
隊伍許可
 template.templatePartyPermissions array of object

此範本中定義的接收者角色及其權限清單。
合作對象識別碼
 template.templatePartyPermissions.template_party_id integer

這個範本隊伍條目的唯一 ID。
ID
 template.templatePartyPermissions.templateId integer

這個隊伍所屬模板的 ID。
許可
 template.templatePartyPermissions.templatePermissions string

該方的簽署權限（例如，FILL_FIELDS_AND_SIGN）。
簽署訂單
 template.templatePartyPermissions.partySequence integer

這是這場派對的簽署順序位置。
派對角色
 template.templatePartyPermissions.templatePartyRole string

範本中分配給這個隊伍的角色名稱。 用這個方法從範本建立信封。
合作對象識別碼
 template.templatePartyPermissions.partyId integer

如果是預先分配，則需提供分配至此角色的隊伍ID。
使用者識別碼
 template.templateCreatedBy.partyId integer

使用者的唯一 ID。
名字
 template.templateCreatedBy.firstName string

使用者的名字。
姓氏
 template.templateCreatedBy.lastName string

使用者的姓氏。
Email
 template.templateCreatedBy.emailId string

使用者的電子郵件地址。
公司編號
 template.templateCreatedBy.companyId integer

使用者所屬公司的 ID。
使用者角色
 template.templateCreatedBy.userRole string

使用者在組織中的角色。
作用中
 template.templateCreatedBy.active boolean

顯示使用者的帳號是否仍在運作中。
使用者識別碼
 template.templateLastUpdatedBy.partyId integer

使用者的唯一 ID。
名字
 template.templateLastUpdatedBy.firstName string

使用者的名字。
姓氏
 template.templateLastUpdatedBy.lastName string

使用者的姓氏。
Email
 template.templateLastUpdatedBy.emailId string

使用者的電子郵件地址。
公司編號
 template.templateLastUpdatedBy.companyId integer

使用者所屬公司的 ID。
使用者角色
 template.templateLastUpdatedBy.userRole string

使用者在組織中的角色。
作用中
 template.templateLastUpdatedBy.active boolean

顯示使用者的帳號是否仍在運作中。
範本欄位
 allfields array of object

範本中定義的所有簽名與表單欄位清單。
欄位識別碼
 allfields.fieldTagId integer

欄位的唯一識別碼。
範本識別碼
 allfields.templateId integer

該欄位所屬範本的 ID。
公司編號
 allfields.companyId integer

該欄位所屬的公司帳戶。
欄位類型
 allfields.fieldType string

欄位的類型（例如 signfield、initialfield、textfield、datefield、checkboxfield、securedfield、attachmentfield）。
頁碼
 allfields.documentPageNumber integer

文件中放置此欄位的頁碼。
責任方
 allfields.partyResponsible integer

負責填寫此欄位的黨序號。
派對順序
 allfields.partyResponsibleSequence integer

負責方的順序位置。
野戰文件編號
 allfields.docFieldId string

此欄位的文件層級識別碼。
是相依的
 allfields.dependent boolean

表示該欄位的可見性是否依賴於另一個欄位的值。
制表序列
 allfields.tabOrder integer

用來在欄位間導航的制表順序。
為必填項目
 allfields.required boolean

指示是否必須填入此欄位後，文件才能簽署。
自訂欄位名稱
 allfields.customFieldName string

此欄位為自訂名稱。
分享全部
 allfields.shareAll boolean

顯示此欄位是否與所有使用者共享。
允許編輯
 allfields.allowEdit boolean

顯示此欄位是否可由收件人編輯。
文字欄位名稱
 allfields.textfieldName string

文字欄位的標籤（當 fieldType 為「textfield」時適用）。
價值
 allfields.value string

欄位的預先填入或輸入值。
字型大小
 allfields.fontSize integer

此欄位中使用的字體大小。
字體顏色
 allfields.fontColor string

此欄位文字使用的字體顏色（例如 #000000）。
唯讀
 allfields.readOnly boolean

顯示該欄位是否為唯讀，且收件人無法編輯。
多線鐵路
 allfields.multiLine boolean

表示該文字欄位是否接受多行輸入（當 fieldType 為「textfield」時適用）。
字數限制
 allfields.characterLimit integer

欄位中允許的最大字元數（當 fieldType 為「textfield」時適用）。
日期欄位名稱
 allfields.datefieldName string

日期欄位的標籤（當 fieldType 為 'datefield' 時適用）。
日期格式
 allfields.dateFormat string

此欄位所使用的日期格式（例如 MM/DD/YYYY）（當 fieldType 為「datefield」時適用）。
勾選框名稱
 allfields.cbname string

勾選框欄位的標籤（當 fieldType 為「checkboxfield」時適用）。
核取方塊小組
 allfields.cbgroup string

此勾選框的群組名稱（適用於fieldType為「checkboxfield」）。
已核對
 allfields.checked boolean

表示勾選框是否預設被勾選（適用於 fieldType 為「checkboxfield」）。
已確保的場地名稱
 allfields.securedfieldName string

受保護欄位的標籤（當 fieldType 為 'securedfield' 時適用）。
展示角色
 allfields.charToDisplay integer

在安全欄位值結束時，應顯示的未遮罩字元數量（當fieldType為「securedfield」時適用）。
簽章識別碼
 allfields.signatureId string

簽章的 ID 適用於此符號欄位（當 fieldType 為「signfield」時適用）。
初始圖像
 allfields.initialImage string

該欄位的縮寫影像資料套用於此欄位（當fieldType為「initialfield」時適用）。
附件欄位名稱
 allfields.attachmentfieldName string

attachment 欄位名稱（當 fieldType 為 'attachmentfield' 時適用）。
附件說明
 allfields.attachmentfieldDescription string

描述要附加什麼（適用於 fieldType 為「attachmentfield」）。

獲取信封詳情

作業識別碼：
GetEnvelopeDetails

可取得信封的完整資料，包括狀態、收件人及文件。

參數

名稱 機碼 必要 類型 Description
信封 ID
 folderId True integer

信封的唯一識別碼。
存取憑證
 access_token string

OAuth 2.0 存取權杖用於認證。

傳回

名稱 路徑 類型 Description
Result
 result string

表示操作是否成功（例如「成功」）。
ID
 folder.folderId integer

信封的唯一ID。
名稱
 folder.folderName string

信封的名字。
作者編號
 folder.folderAuthorId integer

創建信封的使用者唯一 ID。
作者名字
 folder.folderAuthorFirstName string

信封製作者的名字。
作者姓氏
 folder.folderAuthorLastName string

信封製作者的姓氏。
作者Email
 folder.folderAuthorEmail string

信封製作者的電子郵件地址。
作者角色
 folder.folderAuthorRole string

信封製作者的角色。
公司編號
 folder.folderCompanyId integer

信封所屬公司的獨特識別碼。
建立日期
 folder.folderCreationDate integer

信封的製作日期和時間，以 Unix 毫秒計。
傳送日期
 folder.folderSentDate integer

信封寄給收件人的日期與時間，單位為 Unix 毫秒。 如果還沒寄出，則是無效。
現況
 folder.folderStatus string

信封目前狀態（例如：已分享、已執行、已完成、已取消）。
文件識別碼
 folder.folderDocumentIds array of integer

這個信封裡附有的文件識別碼清單。
Documents
 folder.documentsList array of object

信封內附有每份文件的詳細資訊。
文件識別碼
 folder.documentsList.documentId integer

檔的唯一標識碼。
合約 ID
 folder.documentsList.contractId integer

與本文件相關的合約唯一識別碼。
公司編號
 folder.documentsList.companyId integer

這份文件所屬公司的唯一識別碼。
作者
 folder.documentsList.contractCreatedBy integer

創建合約者的使用者ID。
創建日期
 folder.documentsList.contractCreatedOn integer

合約創建日期，以 Unix 毫秒計。
合約類型
 folder.documentsList.contractType string

合約的類型或類別。
文件狀態
 folder.documentsList.contractStatus string

文件目前簽署狀態（例如：WAITING_FOR_SIGNATURE、已執行）。
可編輯
 folder.documentsList.editable boolean

指示文件是否可編輯。
版本識別碼
 folder.documentsList.contractVersionId integer

目前文件版本的唯一 ID。
版本名稱
 folder.documentsList.contractVersionName string

目前文件版本的名稱。
版本描述
 folder.documentsList.contractVersionDesc string

目前文件版本的說明。
版本製作
 folder.documentsList.versionCreatedby integer

創建此文件的使用者 ID 版本。
建立於
 folder.documentsList.versionCreatedOn integer

此文件版本的創建日期，以 Unix 毫秒計。
版本號碼
 folder.documentsList.contractVersionNumber integer

文件的版本號碼。
收件者
 folder.folderRecipientParties array of object

此信封的收件人名單，包括他們的簽署狀態及存取連結。
收件者 ID
 folder.folderRecipientParties.partyId integer

收件者的唯一識別碼。
收件者 ID
 folder.folderRecipientParties.partyDetails.partyId integer

收件者的唯一識別碼。
名字
 folder.folderRecipientParties.partyDetails.firstName string

收件人的名字。
姓氏
 folder.folderRecipientParties.partyDetails.lastName string

收件人的姓氏。
Email
 folder.folderRecipientParties.partyDetails.emailId string

收件者的電子郵件地址。
地址
 folder.folderRecipientParties.partyDetails.address string

收件人的地址。
帳號建立日期
 folder.folderRecipientParties.partyDetails.dateCreated integer

收件人帳號建立的日期，以 Unix 毫秒計。
許可
 folder.folderRecipientParties.contractPermissions string

授予此收件人的簽署權限（例如，FILL_FIELDS_AND_SIGN）。
簽署訂單
 folder.folderRecipientParties.partySequence integer

該收件人在簽名順序中的位置。
工作流程序列
 folder.folderRecipientParties.workflowSignSequence integer

該接收者的工作流程簽名序號。
信封 ID
 folder.folderRecipientParties.envelopeId integer

收件人所屬信封的身分證。
共享模式
 folder.folderRecipientParties.sharingMode string

與該收件人分享文件的方法（例如電子郵件）。
簽名網址
 folder.folderRecipientParties.folderAccessURL string

此收件人唯一的簽名網址。 若信封已完成或取消，則為無效。
安全性模式
 folder.folderRecipientParties.securityMode string

安全模式適用於此接收者的存取權限。
額外評論
 folder.folderRecipientParties.extraComments string

請收禮邀請函中包含任何額外評論。
作者存取網址
 folder.folderAccessURLForAuthor string

信封作者存取該文件的網址。 若不適用，則為 null。
批量識別
 folder.bulkId integer

這個信封所屬的批次 ID 是該信封的。
執行標誌令
 folder.enforceSignWorkflow boolean

指示收件人是否必須依指定順序簽名。
目前工作流程步驟
 folder.currentWorkflowStep integer

這是目前簽署流程的步驟。
交易來源
 folder.transactionSource string

發起這個信封交易的來源。
可編輯
 folder.editable boolean

表示信封是否仍可編輯。
In-Person 簽名
 folder.inPersonSignable boolean

說明信封是否可親自簽名。
覆寫提醒
 folder.overrideAccountReminders boolean

顯示此信封是否覆蓋了帳戶層級的提醒設定。
ID
 folder.envelopeId integer

信封的唯一ID。 與 Envelope ID （folderId） 的值相同。
名稱
 folder.envelopeName string

信封的名字。 值與信封名稱（folderName）相同。
發起人 ID
 folder.envelopeOriginatorId integer

創建信封者的使用者ID。
公司編號
 folder.envelopeCompanyId integer

信封所屬公司的識別碼。
Date
 folder.envelopeDate integer

信封的製作日期和時間，以 Unix 毫秒計。
同日
 folder.envelopeSharedDate integer

信封與收件人共享的日期與時間，單位為 Unix 毫秒。 如果還沒分享，則是無效。
現況
 folder.envelopeStatus string

信封目前狀態。 與 Envelope Status（folderStatus）值相同。
合約識別碼
 folder.envelopeContractIds array of integer

與此信封相關的合約ID清單。
隊伍許可
 folder.envelopePartyPermissions array of object

收件人名單及其簽署許可。 結構與受贈者相同。
收件者 ID
 folder.envelopePartyPermissions.partyId integer

收件者的唯一識別碼。
名字
 folder.envelopePartyPermissions.partyDetails.firstName string

收件人的名字。
姓氏
 folder.envelopePartyPermissions.partyDetails.lastName string

收件人的姓氏。
Email
 folder.envelopePartyPermissions.partyDetails.emailId string

收件者的電子郵件地址。
許可
 folder.envelopePartyPermissions.contractPermissions string

這位收件人的簽署權限。
簽署訂單
 folder.envelopePartyPermissions.partySequence integer

該收件人在簽名順序中的位置。
簽名網址
 folder.envelopePartyPermissions.folderAccessURL string

此收件人唯一的簽名網址。
所有領域
 allFields array of object

信封文件中所有簽名和表格欄位的清單。
欄位識別碼
 allFields.fieldTagId integer

欄位的唯一識別碼。
文件識別碼
 allFields.contractId integer

這個欄位所屬文件的 ID。
版本識別碼
 allFields.versionId integer

此欄位所屬文件的版本 ID。
欄位類型
 allFields.fieldType string

欄位的類型（例如 signfield、textfield、datefield、checkboxfield、dropdownfield、initialfield）。
頁碼
 allFields.documentPageNumber integer

該欄位所在的頁碼。
野戰文件編號
 allFields.docFieldId string

此欄位的文件層級識別碼。
責任方
 allFields.partyResponsible integer

負責填寫此欄位的政黨識別碼。
是相依的
 allFields.dependent boolean

表示該欄位的可見性是否依賴於另一個欄位的值。
為必填項目
 allFields.required boolean

指示是否必須填入此欄位才能提交文件。
欄位值
 allFields.value string

欄位的當前值（若已填滿）。
場值
 allFieldsNameValue array of object

所有欄位名稱及其當前值的簡化清單。 利用此工具從簽名信封讀取填滿的欄位資料。
欄位識別碼
 allFieldsNameValue.fieldId integer

欄位的唯一識別碼。
文件識別碼
 allFieldsNameValue.documentId integer

這個欄位所屬文件的 ID。
版本識別碼
 allFieldsNameValue.documentVersionId integer

此欄位所屬文件的版本 ID。
欄位類型
 allFieldsNameValue.fieldType string

欄位的類型（例如 textfield、signfield、datefield、checkboxfield、dropdownfield）。
欄位名稱
 allFieldsNameValue.name string

欄位的標籤或名稱，依範本中定義。
欄位值
 allFieldsNameValue.value string

輸入或選擇的值為此欄位。
信封歷史
 Folder History array of object

所有對此信封採取行動的審計紀錄，按時間順序排列。
名字
 Folder History.firstName string

執行動作的人的名字。
姓氏
 Folder History.lastName string

執行該行動者的姓氏。
Email
 Folder History.email string

執行該行動者的電子郵件地址。
信封 ID
 Folder History.envelopeId integer

執行該動作的信封識別碼。
Date
 Folder History.dateChanged integer

動作發生的日期與時間，以 Unix 毫秒為單位。
合作對象識別碼
 Folder History.changeDoneByParty integer

執行該動作者的黨派識別碼。
動作
 Folder History.action string

該動作在信封上執行（例如：建立、邀請發送、邀請接受、簽署、執行）。

獲取電子郵件群組詳情

作業識別碼：
GetEmailGroupDetails

取得現有電子郵件群組的詳細資訊。

參數

名稱 機碼 必要 類型 Description
電子郵件群組名稱
 emailGroupNames True array of string

一組用來識別群組的電子郵件群組名稱。

傳回

名稱 路徑 類型 Description
電子郵件群組
 allEmailGroups array of object

與請求群組名稱相符的電子郵件群組清單。
群組識別碼
 allEmailGroups.groupId integer

電子郵件群組的唯一識別碼。
群組名稱
 allEmailGroups.groupName string

電子郵件群組名稱。
群組描述
 allEmailGroups.groupDesc string

電子郵件群組的描述。
建立日期
 allEmailGroups.dateCreated integer

電子郵件群組成立的日期，以 Unix 毫秒計。
公司編號
 allEmailGroups.companyId integer

這個電子郵件群組所屬的公司帳號。
Parties
 allEmailGroups.parties array of object

這個電子郵件群組的收件人名單。
名字
 allEmailGroups.parties.firstName string

收件者的名字。
姓氏
 allEmailGroups.parties.lastName string

收件者的姓氏。
Email
 allEmailGroups.parties.emailId string

收件者的電子郵件地址。

發送簽名提醒

作業識別碼：
SendSignatureReminder

向待接收信封的收件人發送提醒通知，提示他們完成簽名。

參數

名稱 機碼 必要 類型 Description
信封 ID
 folderId True integer

信封的識別碼。

傳回

名稱 路徑 類型 Description
Result
 result string

指出要求是否成功。
信封 ID
 reminder sent integer

提醒所寄信封的識別碼。

觸發程序

當信封完全執行時

當所有收件人都已簽名且信封完全執行完成時，會觸發。
當信封寄出時

當信封寄給收件人時會觸發。 此事件僅在 Webhook Level 設為「帳戶」時觸發。
當信封被刪除時

當信封被刪除時會觸發。
當信封被查看時

當收件人打開並查看信封時觸發。
當信封被簽署時

當收件人簽署信封時觸發。
當包絡被取消時

當收件人或寄件人取消信封時觸發。

當信封完全執行時

作業識別碼：
TriggerEnvelopeExecuted

當所有收件人都已簽名且信封完全執行完成時，會觸發。

參數

名稱 機碼 必要 類型 Description
頻道名稱
 channelName True string

一個名稱用來識別你帳號中的這個 webhook 訂閱。
Webhook 層級
 webhookLevel True string

帳戶：所有信封（網頁和 API）的火力。 API App：只會對透過 API 建立的信封執行。
網鉤祕密
 webhookSecret string

Optional. Foxit eSign 會利用 HMAC-SHA-256 這個秘密來驗證每個 webhook 有效載荷。

傳回

當 webhook 事件觸發時，從 Foxit eSign 收到的事件資料。

WebhookEventPayload
WebhookEventPayload

當信封寄出時

作業識別碼：
TriggerEnvelopeSent

當信封寄給收件人時會觸發。 此事件僅在 Webhook Level 設為「帳戶」時觸發。

參數

名稱 機碼 必要 類型 Description
頻道名稱
 channelName True string

一個名稱用來識別你帳號中的這個 webhook 訂閱。
Webhook 層級
 webhookLevel True string

帳號：透過網頁或 API 寄送的信封會被觸發。 API App：只會對透過 API 建立的信封執行。 folder_sent事件只會在帳號等級觸發。
網鉤祕密
 webhookSecret string

Optional. Foxit eSign 會利用 HMAC-SHA-256 這個秘密來驗證每個 webhook 有效載荷。

傳回

當 webhook 事件觸發時，從 Foxit eSign 收到的事件資料。

WebhookEventPayload
WebhookEventPayload

當信封被刪除時

作業識別碼：
TriggerEnvelopeDeleted

當信封被刪除時會觸發。

參數

名稱 機碼 必要 類型 Description
頻道名稱
 channelName True string

一個名稱用來識別你帳號中的這個 webhook 訂閱。
Webhook 層級
 webhookLevel True string

帳戶：所有信封（網頁和 API）的火力。 API App：只會對透過 API 建立的信封執行。
網鉤祕密
 webhookSecret string

Optional. Foxit eSign 會利用 HMAC-SHA-256 這個秘密來驗證每個 webhook 有效載荷。

傳回

當 webhook 事件觸發時，從 Foxit eSign 收到的事件資料。

WebhookEventPayload
WebhookEventPayload

當信封被查看時

作業識別碼：
TriggerEnvelopeViewed

當收件人打開並查看信封時觸發。

參數

名稱 機碼 必要 類型 Description
頻道名稱
 channelName True string

一個名稱用來識別你帳號中的這個 webhook 訂閱。
Webhook 層級
 webhookLevel True string

帳戶：所有信封（網頁和 API）的火力。 API App：只會對透過 API 建立的信封執行。
網鉤祕密
 webhookSecret string

Optional. Foxit eSign 會利用 HMAC-SHA-256 這個秘密來驗證每個 webhook 有效載荷。

傳回

當 webhook 事件觸發時，從 Foxit eSign 收到的事件資料。

WebhookEventPayload
WebhookEventPayload

當信封被簽署時

作業識別碼：
TriggerEnvelopeSigned

當收件人簽署信封時觸發。

參數

名稱 機碼 必要 類型 Description
頻道名稱
 channelName True string

一個名稱用來識別你帳號中的這個 webhook 訂閱。
Webhook 層級
 webhookLevel True string

帳戶：所有信封（網頁和 API）的火力。 API App：只會對透過 API 建立的信封執行。
網鉤祕密
 webhookSecret string

Optional. Foxit eSign 會利用 HMAC-SHA-256 這個秘密來驗證每個 webhook 有效載荷。

傳回

當 webhook 事件觸發時，從 Foxit eSign 收到的事件資料。

WebhookEventPayload
WebhookEventPayload

當包絡被取消時

作業識別碼：
TriggerEnvelopeCancelled

當收件人或寄件人取消信封時觸發。

參數

名稱 機碼 必要 類型 Description
頻道名稱
 channelName True string

一個名稱用來識別你帳號中的這個 webhook 訂閱。
Webhook 層級
 webhookLevel True string

帳戶：所有信封（網頁和 API）的火力。 API App：只會對透過 API 建立的信封執行。
網鉤祕密
 webhookSecret string

Optional. Foxit eSign 會利用 HMAC-SHA-256 這個秘密來驗證每個 webhook 有效載荷。

傳回

當 webhook 事件觸發時，從 Foxit eSign 收到的事件資料。

WebhookEventPayload
WebhookEventPayload

定義

WebhookEventPayload

當 webhook 事件觸發時，從 Foxit eSign 收到的事件資料。

名稱 路徑 類型 Description
活動名稱
 event_name string

觸發事件的名稱（例如 folder_sent、folder_signed、folder_executed）。
事件日期
 event_date integer

事件發生的日期與時間（Unix 時間戳記以毫秒為單位）。
ID
 data.folder.folderId integer

信封的唯一ID。
名稱
 data.folder.folderName string

信封的名字。
自訂名稱
 data.folder.folderCustomName string

信封被賦予的自訂名稱。
Password
 data.folder.folderPassword string

信封的存取密碼（如果設定好了）。
創作者識別碼
 data.folder.folderAuthorId integer

信封建立者的使用者 ID。
創作者名字
 data.folder.folderAuthorFirstName string

信封製作者的名字。
創作者姓氏
 data.folder.folderAuthorLastName string

信封製作者的姓氏。
創作者電子郵件
 data.folder.folderAuthorEmail string

信封製作者的電子郵件地址。
創作者角色
 data.folder.folderAuthorRole string

信封製作者的角色。
公司編號
 data.folder.folderCompanyId integer

擁有信封的公司識別碼。
建立日期
 data.folder.folderCreationDate integer

信封創建日期（Unix 時間戳記，單位為毫秒）。
傳送日期
 data.folder.folderSentDate integer

信封寄出日期（Unix 時間戳記，毫秒）。
現況
 data.folder.folderStatus string

信封目前狀態。
自訂欄位 1
 data.folder.custom_field1 string

第一個自訂的元資料欄位。
自訂欄位 2
 data.folder.custom_field2 string

第二個自訂元資料欄位。
後設資料
 data.folder.metadata string

與信封相關的自訂元資料。
文件識別碼
 data.folder.folderDocumentIds array of integer

信封裡的文件ID清單。
Documents
 data.folder.documentsList array of object

信封裡的文件清單。
文件識別碼
 data.folder.documentsList.documentId integer

檔的唯一標識碼。
合約 ID
 data.folder.documentsList.contractId integer

這是這份文件的合約編號。
公司編號
 data.folder.documentsList.companyId integer

這份文件的公司編號。
作者
 data.folder.documentsList.contractCreatedBy integer

創建合約者的使用者ID。
創建日期
 data.folder.documentsList.contractCreatedOn integer

合約創建日期（Unix 時間戳，單位為毫秒）。
合約類型
 data.folder.documentsList.contractType string

合約的類型。
合約狀態
 data.folder.documentsList.contractStatus string

合約目前狀態。
可編輯
 data.folder.documentsList.editable boolean

顯示文件是否可編輯。
版本識別碼
 data.folder.documentsList.contractVersionId integer

合約的版本編號。
版本名稱
 data.folder.documentsList.contractVersionName string

合約版本的名稱。
版本描述
 data.folder.documentsList.contractVersionDesc string

這是合約版本的描述。
版本製作
 data.folder.documentsList.versionCreatedby integer

創建此版本者的使用者ID。
建立於
 data.folder.documentsList.versionCreatedOn integer

此版本的創建日期（Unix 時間戳記，單位為毫秒）。
版本號碼
 data.folder.documentsList.contractVersionNumber integer

合約的版本號。
交易來源
 data.folder.documentsList.contractTransactionSource string

啟動合約的原始碼系統。
收件者
 data.folder.folderRecipientParties array of object

這個信封的收件人名單。
收件者 ID
 data.folder.folderRecipientParties.partyId integer

收件者的唯一識別碼。
收件者 ID
 data.folder.folderRecipientParties.partyDetails.partyId integer

收件人的唯一身份證。
名字
 data.folder.folderRecipientParties.partyDetails.firstName string

收件人的名字。
姓氏
 data.folder.folderRecipientParties.partyDetails.lastName string

收件人的姓氏。
Email
 data.folder.folderRecipientParties.partyDetails.emailId string

收件者的電子郵件地址。
預留位置
 data.folder.folderRecipientParties.partyDetails.placeholder boolean

這是否是一個佔位收件人。
地址
 data.folder.folderRecipientParties.partyDetails.address string

收件人的地址。
建立日期
 data.folder.folderRecipientParties.partyDetails.dateCreated integer

接收記錄建立日期（Unix 時間戳，單位為毫秒）。
拒絕寄出電子郵件
 data.folder.folderRecipientParties.partyDetails.optOutEmails boolean

收件人是否選擇不接收電子郵件。
唯一識別碼
 data.folder.folderRecipientParties.partyDetails.uniquePartyId string

此接收者的唯一系統識別碼。
認證等級
 data.folder.folderRecipientParties.partyDetails.authenticationLevel string

此收件人的身份驗證方式。
密碼更新日期
 data.folder.folderRecipientParties.partyDetails.passwordUpdateDate string

密碼最後更新的日期。
密碼狀態
 data.folder.folderRecipientParties.partyDetails.passwordUpdateStatus boolean

密碼是否已更新。
撥號代碼
 data.folder.folderRecipientParties.dialingCode string

國際撥號代碼。
Mobile
 data.folder.folderRecipientParties.mobileNumber string

收件人的手機號碼。
簽章類型
 data.folder.folderRecipientParties.signerSignatureType string

簽署人會使用的簽名類型。
許可
 data.folder.folderRecipientParties.contractPermissions string

授予此收件人的權限。
簽署訂單
 data.folder.folderRecipientParties.partySequence integer

這位收件人的簽名順序。
工作流程序列
 data.folder.folderRecipientParties.workflowSignSequence integer

工作流程簽名序號。
信封 ID
 data.folder.folderRecipientParties.envelopeId integer

與此收件人相關的信封ID。
收件人公司識別碼
 data.folder.folderRecipientParties.partyCompanyId integer

這位收件人的公司編號。
共享模式
 data.folder.folderRecipientParties.sharingMode string

此為此收件人提供分享模式。
收件人簽名網址
 data.folder.folderRecipientParties.folderAccessURL string

收件人可存取並簽名信封的網址。
安全性模式
 data.folder.folderRecipientParties.securityMode string

這是這個收件人的安全模式。
Comments
 data.folder.folderRecipientParties.extraComments string

給收件人的補充意見。
允許更名
 data.folder.folderRecipientParties.allowNameChange boolean

收件人是否能更新姓名。
名稱更新
 data.folder.folderRecipientParties.signerNameUpdated boolean

簽署人是否已更新姓名。
簽署者認證等級
 data.folder.folderRecipientParties.signerAuthenticationLevel string

簽署者所需的認證等級。
存取代碼
 data.folder.folderRecipientParties.userDefinedAccessCode string

簽名者的自訂存取碼。
簽章識別碼
 data.folder.folderRecipientParties.signatureId string

所套用簽名的識別碼。
Role
 data.folder.folderRecipientParties.partyRole string

這位收件人在簽署流程中的角色。
連隊場地
 data.folder.folderRecipientParties.companyFieldValue string

公司名稱欄位的值。
標題欄位
 data.folder.folderRecipientParties.titleFieldValue string

標題欄位的值。
簽約原因
 data.folder.folderRecipientParties.reasonSigning string

簽約的理由。
新增付款欄位
 data.folder.folderRecipientParties.payFieldAdded boolean

是否新增了付款欄位。
收款人
 data.folder.folderRecipientParties.payee boolean

該收款人是否為收款人。
定期付款
 data.folder.folderRecipientParties.recurringFieldExist boolean

是否存在定期付款欄位。
列印與簽名完成
 data.folder.folderRecipientParties.printAndSignCompleted boolean

印刷與簽名是否完整。
可選簽署人
 data.folder.folderRecipientParties.allowOptionalSigner boolean

該收件人是否為可選簽署者。
可選簽字者
 data.folder.folderRecipientParties.optionalSigners array of integer

可選簽字方身份證。
有薪
 data.folder.folderRecipientParties.paid boolean

付款是否已完成。
作者存取網址
 data.folder.folderAccessURLForAuthor string

信封作者存取信封的網址。
草稿存取網址
 data.folder.draftFolderAccessURL string

存取草稿狀態信封的網址。
董事會簽署
 data.folder.boardRoomSign boolean

是否啟用了董事會簽署模式。
包含標誌
 data.folder.includeLogo boolean

電子郵件中是否包含公司標誌。
按鈕背景色
 data.folder.email_btnBgColor string

電子郵件動作按鈕的背景色。
按鈕文字顏色
 data.folder.email_btnTxtColor string

電子郵件動作按鈕的文字顏色。
電子郵件標誌
 data.folder.emailTemplateLogo string

電子郵件範本中使用的標誌網址。
電子郵件範本ID
 data.folder.emailTemplateId integer

所用電子郵件範本的 ID。
電子郵件標頭
 data.folder.emailHeader string

通知郵件中的標頭文字。
電子郵件頁尾
 data.folder.emailFooter string

通知郵件中的頁尾文字。
清洗預定
 data.folder.purgeFlag boolean

信封是否排定要清理。
清洗開始日期
 data.folder.purgeStartDate string

清除計畫的開始日期。
清洗結束日期
 data.folder.purgeEndDate string

清除計畫的結束日期。
批量識別
 data.folder.bulkId integer

如果適用，則是批量發送操作的 ID。
執行標誌令
 data.folder.enforceSignWorkflow boolean

收件人是否必須依照既定順序簽名。
目前工作流程步驟
 data.folder.currentWorkflowStep integer

這是目前簽署流程的步驟。
交易來源
 data.folder.transactionSource string

發起此交易的來源系統。
可編輯
 data.folder.editable boolean

信封是否可編輯。
In-Person 簽名
 data.folder.inPersonSignable boolean

信封是否支援親自簽署。
覆寫提醒
 data.folder.overrideAccountReminders boolean

帳號層級的提醒設定是否被覆蓋。
覆寫授權
 data.folder.overrideAccountRecipientDelegation boolean

帳戶層級委派設定是否被覆蓋。
允許授權
 data.folder.allowRecipientsToDelegate boolean

收件人是否可以授權簽署。
ID
 data.folder.envelopeId integer

唯一的信封 ID（folderID 的別名）。
名稱
 data.folder.envelopeName string

信封名稱（folderName 的別名）。
發起人 ID
 data.folder.envelopeOriginatorId integer

是那個信封的使用者ID。
公司編號
 data.folder.envelopeCompanyId integer

擁有信封的公司識別碼。
Date
 data.folder.envelopeDate integer

信封創建日期（Unix 時間戳記，單位為毫秒）。
同日
 data.folder.envelopeSharedDate integer

信封被分享的日期（Unix 時間戳記，以毫秒計）。
現況
 data.folder.envelopeStatus string

信封目前狀態。
合約識別碼
 data.folder.envelopeContractIds array of integer

與這個信封相關的合約識別碼。
隊伍許可
 data.folder.envelopePartyPermissions array of object

收件人權限清單（與收件人相同結構）。
收件者 ID
 data.folder.envelopePartyPermissions.partyId integer

收件者的唯一識別碼。
收件者 ID
 data.folder.envelopePartyPermissions.partyDetails.partyId integer
名字
 data.folder.envelopePartyPermissions.partyDetails.firstName string
姓氏
 data.folder.envelopePartyPermissions.partyDetails.lastName string
Email
 data.folder.envelopePartyPermissions.partyDetails.emailId string
預留位置
 data.folder.envelopePartyPermissions.partyDetails.placeholder boolean
地址
 data.folder.envelopePartyPermissions.partyDetails.address string
建立日期
 data.folder.envelopePartyPermissions.partyDetails.dateCreated integer
拒絕寄出電子郵件
 data.folder.envelopePartyPermissions.partyDetails.optOutEmails boolean
唯一識別碼
 data.folder.envelopePartyPermissions.partyDetails.uniquePartyId string
認證等級
 data.folder.envelopePartyPermissions.partyDetails.authenticationLevel string
密碼更新日期
 data.folder.envelopePartyPermissions.partyDetails.passwordUpdateDate string
密碼狀態
 data.folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus boolean
撥號代碼
 data.folder.envelopePartyPermissions.dialingCode string
Mobile
 data.folder.envelopePartyPermissions.mobileNumber string
簽章類型
 data.folder.envelopePartyPermissions.signerSignatureType string
許可
 data.folder.envelopePartyPermissions.contractPermissions string
簽署訂單
 data.folder.envelopePartyPermissions.partySequence integer
工作流程序列
 data.folder.envelopePartyPermissions.workflowSignSequence integer
信封 ID
 data.folder.envelopePartyPermissions.envelopeId integer
收件人公司識別碼
 data.folder.envelopePartyPermissions.partyCompanyId integer
共享模式
 data.folder.envelopePartyPermissions.sharingMode string
收件人簽名網址
 data.folder.envelopePartyPermissions.folderAccessURL string
安全性模式
 data.folder.envelopePartyPermissions.securityMode string
Comments
 data.folder.envelopePartyPermissions.extraComments string
允許更名
 data.folder.envelopePartyPermissions.allowNameChange boolean
名稱更新
 data.folder.envelopePartyPermissions.signerNameUpdated boolean
簽署者認證等級
 data.folder.envelopePartyPermissions.signerAuthenticationLevel string
存取代碼
 data.folder.envelopePartyPermissions.userDefinedAccessCode string
簽章識別碼
 data.folder.envelopePartyPermissions.signatureId string
Role
 data.folder.envelopePartyPermissions.partyRole string
連隊場地
 data.folder.envelopePartyPermissions.companyFieldValue string
標題欄位
 data.folder.envelopePartyPermissions.titleFieldValue string
簽約原因
 data.folder.envelopePartyPermissions.reasonSigning string
新增付款欄位
 data.folder.envelopePartyPermissions.payFieldAdded boolean
收款人
 data.folder.envelopePartyPermissions.payee boolean
定期付款
 data.folder.envelopePartyPermissions.recurringFieldExist boolean
列印與簽名完成
 data.folder.envelopePartyPermissions.printAndSignCompleted boolean
可選簽署人
 data.folder.envelopePartyPermissions.allowOptionalSigner boolean
可選簽字者
 data.folder.envelopePartyPermissions.optionalSigners array of integer
有薪
 data.folder.envelopePartyPermissions.paid boolean
認證等級
 data.folder.envelopeAuthenticationLevel string

信封所需的認證等級。
單一簽名者批量
 data.folder.allowSingleSignerInBulk boolean

是否允許單簽名者以批量模式出現。
File-Based 資料夾名稱
 data.folder.folderNameBasedOnFileNaming boolean
File-Based 文件名稱
 data.folder.documentNameBasedOnFileNaming boolean
File-Based 證書名稱
 data.folder.certificateNameBasedOnFileNaming boolean
預執行檔案命名
 data.folder.enableFileNamingBeforeExecution boolean
收款人新增
 data.folder.payeeAddedd boolean
Self-Signing 啟用
 data.folder.selfSignerEnabled boolean
公證人啟用
 data.folder.notaryEnabled boolean
能見度有限
 data.folder.limitedVisibilityFlag boolean
標示後可見度
 data.folder.postSigningVisibility boolean
濕簽名
 data.folder.wetSignatureEnabled boolean
合併啟用
 data.folder.mergeEnabled boolean

二進位

這是基本數據類型 『binary』。