Adobe Acrobat Sign 沙盒環境

Adobe 是世界上最值得信賴的數位文件簽署服務。透過 Adobe Acrobat Sign，您可以將手動流程轉換為全數位體驗。將 Adobe Acrobat Sign 功能整合到您最愛的應用程式中，以建立、傳送和監控合約狀態。

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

服務	Class	Regions
副駕駛工作室	標準	除下列區域外的所有 Power Automate 區域： - 美國政府（GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部（DoD）
邏輯應用程式	標準	所有 Logic Apps 區域，但下列區域除外： - Azure Government 區域 - Azure 中國區域 - 美國國防部（DoD）
Power Apps	標準	除下列區域外的所有 Power Apps 區域： - 美國政府（GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部（DoD）
Power Automate（自動化服務）	標準	除下列區域外的所有 Power Automate 區域： - 美國政府（GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部（DoD）

連絡人
名稱	Adobe Acrobat Sign 支援
URL	https://helpx.adobe.com/contact/enterprise-support.dc.html#sign
Email	support@echosign.zendesk.com

連接器中繼資料
Publisher	Adobe公司
網站	https://acrobat.adobe.com/us/en/sign.html
隱私策略	https://www.adobe.com/privacy/policy.html
類別	網站

Adobe Acrobat Sign 沙盒環境

Adobe Acrobat Sign 沙箱是修改後的企業層帳戶，位於與生產環境不同的環境中。沙箱的目的是讓管理員測試設定組態、API 呼叫、程式庫範本、自訂工作流程，以及即將發行的新功能。

發行商：Adobe， Inc.

先決條件

需要 Adobe Acrobat Sign 帳戶。

如何取得認證

N/A

開始使用連接器

N/A

已知問題與限制

N/A

常見錯誤和補救措施

N/A

FAQ

連接器使用者指南 https://helpx.adobe.com/sign/using/adobesign-sandbox.html

節流限制

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

動作

上傳文件並取得文件 ID	此作業會上傳 Adobe Acrobat Sign 帳戶中的文件，並傳回其文件 ID。此文件會暫時儲存在 Adobe Acrobat Sign 中，而文件 ID 可用於建立合約等進一步作業。
上傳文件並取得文件 ID （舊版） [已淘汰]	此作業會上傳 Adobe Acrobat Sign 帳戶中的文件，並傳回其文件 ID。此文件會暫時儲存在 Adobe Acrobat Sign 中，而文件 ID 可用於建立合約等進一步作業。
以 CSV 格式獲取協議的表單字段數據	擷取輸入合約互動式表單欄位的資料。
以 JSON 格式取得協議的表單欄位資料	擷取輸入合約互動式表單欄位的資料。
取得使用者所屬之所有群組的清單	此作業會擷取使用者所屬之所有群組的清單。
取得合約的狀態	此作業會擷取合約的所有目前資訊，例如狀態。
取得合約的狀態 [已取代]	此動作已被取代。請改用 [取得合約的狀態 ]。 ~~此作業會擷取合約的所有目前資訊，例如狀態。~~
取得合約的表單欄位資料（舊） [已棄用]	擷取輸入合約互動式表單欄位的資料。
取得合約稽核記錄的 PDF	此作業會擷取合約稽核追蹤的 PDF 檔案串流。請注意，檔案串流應該以副檔名結尾 .pdf 檔案名稱儲存。
取得工作流程的詳細資訊	此作業會擷取工作流程的詳細資訊。
取得已簽署合約的 PDF	此作業會擷取合併或簽署合約的 PDF 檔案串流。請注意，檔案串流應該以副檔名結尾 .pdf 檔案名稱儲存。
取得已簽署合約的 PDF [已淘汰]	此動作已被取代。請改用 [取得已簽署合約的 PDF ]。 ~~此作業會擷取合併或簽署合約的 PDF 檔案串流。請注意，檔案串流應該以副檔名結尾 .pdf 檔案名稱儲存。~~
取得所有合約的清單	此作業會擷取使用者所有合約的清單。
取得所有合約的清單（舊） [已淘汰]	此作業會擷取使用者所有合約的清單。
取得所有工作流程的清單	此作業會擷取使用者所有工作流程的清單。
取得所有程式庫範本的清單	此作業會擷取儲存在使用者 Adobe Acrobat Sign 資料庫中作為範本的所有文件清單。
取得所有程式庫範本的清單（舊） [已棄用]	此作業會擷取儲存在使用者 Adobe Acrobat Sign 資料庫中作為範本的所有文件清單。
取得所有網路表單的清單	此作業會擷取使用者所有 Web 表單的清單。
取消合約	取消路徑中 agreementId 所識別的合約。
從上傳的文件建立合約並傳送以供簽署	此作業會從 Adobe Acrobat Sign 中上傳的文件建立合約，並傳送以供簽署。
從上傳的文件建立合約並傳送以供簽署（舊） [已淘汰]	此作業會從 Adobe Acrobat Sign 中上傳的文件建立合約，並傳送以供簽署。
從上傳的文件建立文件庫範本	此作業會從上傳的文件在 Adobe Acrobat Sign 資料庫中建立範本。使用此範本來傳送合約。
從上傳的文件建立文件庫範本（舊） [已棄用]	此作業會從上傳的文件在 Adobe Acrobat Sign 資料庫中建立範本。使用此範本來傳送合約。
從合約取得所有文件 ID 的清單 [已棄用]	此動作已被取代。請改用 [從合約取得所有文件 ID 的清單]。 ~~此作業會擷取合約之所有文件及支援文件的 ID。~~
從合約取得所有文件識別碼的清單	此作業會擷取合約之所有文件及支援文件的 ID。
從合約取得文件	此作業會擷取合約特定檔的檔案串流。
從合約取得文件 [已棄用]	此動作已被取代。請改用 [ 從合約取得文件 ]。 ~~此作業會擷取合約特定檔的檔案串流。~~
從工作流程建立合約並傳送以供簽署	此作業會從 Adobe Acrobat Sign 中的工作流程建立合約，並傳送以供簽署。
從文件 URL 建立合約並傳送以供簽署	此作業會從 Adobe Acrobat Sign 中上傳的文件建立合約，並傳送以供簽署。
從文件 URL 建立合約並傳送以供簽署（舊版） [已淘汰]	此作業會從 Adobe Acrobat Sign 中上傳的文件建立合約，並傳送以供簽署。
從文件 URL 建立文件庫範本	此作業會從文件 URL 在 Adobe Acrobat Sign 資料庫中建立範本。使用此範本傳送合約
從文件 URL 建立文件庫範本（舊） [已棄用]	此作業會從文件 URL 在 Adobe Acrobat Sign 資料庫中建立範本。使用此範本傳送合約
從文件庫範本建立合約並傳送以供簽署	此作業會從儲存在使用者 Adobe Acrobat Sign 資料庫中的範本建立合約，並傳送以供簽署。
從文件庫範本建立合約並傳送以供簽署（舊版） [已淘汰]	此作業會從儲存在使用者 Adobe Acrobat Sign 資料庫中的範本建立合約，並傳送以供簽署。
從檔案內容建立合約並傳送以供簽署	此作業會從 Adobe Acrobat Sign 中的檔案建立合約，並傳送以供簽署。
擷取簽署 URL	此作業會擷取合約目前簽署者的電子簽署頁面 URL。
根據搜尋條件取得所有合約的清單	此作業會依工作流程 ID 等條件搜尋合約。

上傳文件並取得文件 ID

作業識別碼：: CreateTransientDocument_V2

此作業會上傳 Adobe Acrobat Sign 帳戶中的文件，並傳回其文件 ID。此文件會暫時儲存在 Adobe Acrobat Sign 中，而文件 ID 可用於建立合約等進一步作業。

參數

名稱	機碼	必要	類型	Description
檔案名稱	File-Name	True	string	要上傳的文件名稱，副檔名
檔案內容	File	True	contentOnly	要上傳的文件的檔案串流
以	x-api-user		string	API呼叫者的電子郵件格式為：電子郵件：adobesignuser@domain.com

傳回

包含已上傳文件 ID 的 JSON

身體: TransientDocumentResponse

上傳文件並取得文件 ID （舊版） [已淘汰]

作業識別碼：: CreateTransientDocument

此作業會上傳 Adobe Acrobat Sign 帳戶中的文件，並傳回其文件 ID。此文件會暫時儲存在 Adobe Acrobat Sign 中，而文件 ID 可用於建立合約等進一步作業。

參數

名稱	機碼	必要	類型	Description
檔案名稱	File-Name	True	string	要上傳的文件名稱，副檔名
檔案內容	File	True	contentOnly	要上傳的文件的檔案串流

傳回

包含已上傳文件 ID 的 JSON

身體: TransientDocumentResponse

以 CSV 格式獲取協議的表單字段數據

作業識別碼：: GetAgreementFormFieldData_V2

擷取輸入合約互動式表單欄位的資料。

參數

名稱	機碼	必要	類型	Description
合約標識碼	agreementId	True	string	需要其資訊之合約的合約識別碼
以	x-api-user		string	API呼叫者的電子郵件格式為：電子郵件：adobesignuser@domain.com

傳回

表單資料的內容

表單資料內容: binary

以 JSON 格式取得協議的表單欄位資料

作業識別碼：: GetAgreementFormFieldData_V3

擷取輸入合約互動式表單欄位的資料。

參數

名稱	機碼	必要	類型	Description
合約標識碼	agreementId	True	string	需要其資訊之合約的合約識別碼
以	x-api-user		string	API呼叫者的電子郵件格式為：電子郵件：adobesignuser@domain.com

傳回

表單資料的內容

表單資料內容: object

取得使用者所屬之所有群組的清單

作業識別碼：: GetAllUserGroups

此作業會擷取使用者所屬之所有群組的清單。

參數

名稱	機碼	必要	類型	Description
以	x-api-user		string	API呼叫者的電子郵件格式為：電子郵件：adobesignuser@domain.com
使用者識別碼	userId	True	string	要獲得授權用戶的結果，用戶可以將用戶 ID 替換為不帶引號的“me”。

傳回

包含指定使用者群組清單的 JSON

身體: UserGroupsInfoV6

取得合約的狀態

作業識別碼：: GetAgreementInfo_V2

此作業會擷取合約的所有目前資訊，例如狀態。

參數

名稱	機碼	必要	類型	Description
合約標識碼	agreementId	True	string	需要其資訊之合約的合約識別碼
以	x-api-user		string	API呼叫者的電子郵件格式為：電子郵件：adobesignuser@domain.com

傳回

完整的協議詳細信息

身體: AgreementInfoV6

取得合約的狀態 [已取代]

作業識別碼：: GetAgreementInfo

此動作已被取代。請改用 [取得合約的狀態 ]。

~~此作業會擷取合約的所有目前資訊，例如狀態。~~

參數

名稱	機碼	必要	類型	Description
合約標識碼	agreementId	True	string	需要其資訊之合約的合約識別碼

傳回

有關協議的完整詳細信息

身體: AgreementInfo

取得合約的表單欄位資料（舊） [已棄用]

作業識別碼：: GetAgreementFormFieldData

擷取輸入合約互動式表單欄位的資料。

參數

名稱	機碼	必要	類型	Description
合約標識碼	agreementId	True	string	需要其資訊之合約的合約識別碼

傳回

response: file

取得合約稽核記錄的 PDF

作業識別碼：: GetAgreementAuditTrail

此作業會擷取合約稽核追蹤的 PDF 檔案串流。請注意，檔案串流應該以副檔名結尾 .pdf 檔案名稱儲存。

參數

名稱	機碼	必要	類型	Description
以	x-api-user		string	API呼叫者的電子郵件格式為：電子郵件：adobesignuser@domain.com
合約標識碼	agreementId	True	string	需要其資訊之合約的合約識別碼

傳回

合約稽核追蹤的檔案串流

response: AgreementAuditTrailResponse

取得工作流程的詳細資訊

作業識別碼：: GetWorkflowInfo

此作業會擷取工作流程的詳細資訊。

參數

名稱	機碼	必要	類型	Description
工作流程識別碼	workflowId	True	string	需要其資訊之工作流程的工作流程ID
以	x-api-user		string	API呼叫者的電子郵件格式為：電子郵件：adobesignuser@domain.com
群組名稱/ID	groupId		string	群組的 ID。要使用此 - 需要選擇“以名稱”字段

傳回

包含工作流程詳細資訊的 JSON

身體: WorkflowDescriptionV6

取得已簽署合約的 PDF

作業識別碼：: GetCombinedDocument_V2

此作業會擷取合併或簽署合約的 PDF 檔案串流。請注意，檔案串流應該以副檔名結尾 .pdf 檔案名稱儲存。

參數

名稱	機碼	必要	類型	Description
合約標識碼	agreementId	True	string	建立合約之動作所提供的合約識別碼
附上證明文件？	attachSupportingDocuments		boolean	如果屬實，請將證明文件附加到已簽署的合約 PDF 中
附上審計報告？	attachAuditReport		boolean	如果為true，請將稽核報告附加至已簽署的合約 PDF
以	x-api-user		string	API呼叫者的電子郵件格式為：電子郵件：adobesignuser@domain.com

傳回

文件的檔案串流

response: CombinedDocumentResponse

取得已簽署合約的 PDF [已淘汰]

作業識別碼：: GetCombinedDocument

此動作已被取代。請改用 [取得已簽署合約的 PDF ]。

~~此作業會擷取合併或簽署合約的 PDF 檔案串流。請注意，檔案串流應該以副檔名結尾 .pdf 檔案名稱儲存。~~

參數

名稱	機碼	必要	類型	Description
合約標識碼	agreementId	True	string	建立合約之動作所提供的合約識別碼
附上證明文件？	attachSupportingDocuments		boolean	如果屬實，請將證明文件附加到已簽署的合約 PDF 中
附上審計報告？	auditReport		boolean	如果為true，請將稽核報告附加至已簽署的合約 PDF

傳回

文件的檔案串流

response: CombinedDocumentResponse

取得所有合約的清單

作業識別碼：: GetAllAgreements_V2

此作業會擷取使用者所有合約的清單。

參數

名稱	機碼	類型	Description
Cursor	cursor	string	用於瀏覽頁面。如果未提供，則傳回第一頁。
頁面大小	pageSize	integer	回應頁面中的項目數。預設為：100;最大：10000
以	x-api-user	string	API呼叫者的電子郵件格式為：電子郵件：adobesignuser@domain.com
群組名稱/ID	groupId	string	群組的 ID。要使用此 - 需要選擇“以名稱”字段

傳回

包含使用者合約陣列物件的 JSON

身體: userAgreementListV6

取得所有合約的清單（舊） [已淘汰]

作業識別碼：: GetAllAgreements

此作業會擷取使用者所有合約的清單。

傳回

包含使用者合約陣列物件的 JSON

身體: UserAgreements

取得所有工作流程的清單

作業識別碼：: GetAllWorkflows

此作業會擷取使用者所有工作流程的清單。

參數

名稱	機碼	類型	Description
包含草稿工作流程	includeDraftWorkflows	boolean	包含草稿工作流程
包括非作用中工作流程	includeInactiveWorkflows	boolean	包含非作用中的工作流程
以	x-api-user	string	API呼叫者的電子郵件格式為：電子郵件：adobesignuser@domain.com
群組名稱/ID	groupId	string	群組的 ID。要使用此 - 需要選擇“以名稱”字段

傳回

包含使用者工作流程陣列物件的 JSON

身體: userWorkflowListV6

取得所有程式庫範本的清單

作業識別碼：: GetLibraryDocuments_V2

此作業會擷取儲存在使用者 Adobe Acrobat Sign 資料庫中作為範本的所有文件清單。

參數

名稱	機碼	類型	Description
Cursor	cursor	string	用於瀏覽頁面。如果未提供，則傳回第一頁。
頁面大小	pageSize	integer	回應頁面中的項目數。預設為：100;最大：10000
以	x-api-user	string	API呼叫者的電子郵件格式為：電子郵件：adobesignuser@domain.com
群組名稱/ID	groupId	string	群組的 ID。要使用此 - 需要選擇“以名稱”字段

傳回

包含程式庫範本陣列物件的 JSON

身體: LibraryDocuments

取得所有程式庫範本的清單（舊） [已棄用]

作業識別碼：: GetLibraryDocuments

此作業會擷取儲存在使用者 Adobe Acrobat Sign 資料庫中作為範本的所有文件清單。

傳回

包含程式庫範本陣列物件的 JSON

身體: DocumentLibraryItems

取得所有網路表單的清單

作業識別碼：: GetAllWebForms

此作業會擷取使用者所有 Web 表單的清單。

參數

名稱	機碼	類型	Description
Cursor	cursor	string	用於瀏覽頁面。如果未提供，則傳回第一頁。
頁面大小	pageSize	integer	回應頁面中的項目數。預設為：100;最大：10000
以	x-api-user	string	API呼叫者的電子郵件格式為：電子郵件：adobesignuser@domain.com
群組名稱/ID	groupId	string	群組的 ID。要使用此 - 需要選擇“以名稱”字段

傳回

包含使用者網頁表單陣列物件的JSON

身體: userWidgetListV6

取消合約

作業識別碼：: CancelAgreement

取消路徑中 agreementId 所識別的合約。

參數

名稱	機碼	必要	類型	Description
合約標識碼	agreementId	True	string	要取消之合約的合約標識碼。
以	x-api-user		string	API呼叫者的電子郵件格式為：電子郵件：adobesignuser@domain.com
Agrement 狀態	state		string	協議應到達的狀態。
評論	comment		string	向收件者描述取消原因的選用註解。
其他	notifyOthers		boolean	您是否希望收件人收到通知。

從上傳的文件建立合約並傳送以供簽署

作業識別碼：: CreateAgreementById_V2

此作業會從 Adobe Acrobat Sign 中上傳的文件建立合約，並傳送以供簽署。

參數

名稱	機碼	必要	類型	Description
以	x-api-user		string	API呼叫者的電子郵件格式為：電子郵件：adobesignuser@domain.com
合約名稱	name	True	string	合約的名稱
ID	transientDocumentId	True	string	上傳暫時性文件所收到的文件識別碼
簽章類型	signatureType	True	string	您要要求的簽名類型 - 電子簽名或書面簽名
參與者電子郵件	email	True	string	參與者的電子郵件
Authentication	authenticationMethod		string	預設驗證：電子郵件（無）
密碼	password		string	參與者所需的密碼
國碼 (地區碼)	countryCode		string	收件者的電話國家/地區代碼需要查看和簽署文件
電話號碼	phone		string	檢視和簽署合約所需的收件者電話號碼
訂單	order	True	integer	索引從1開頭，表示簽署群組需要簽署的位置。
Role	role	True	string	參與者集的目前角色（簽署者、核准者等）。
群組名稱/ID	groupId		string	群組的 ID。要使用此 - 需要選擇“以名稱”字段
Message	message		string	傳送給要求其動作的收件者的選用訊息
Email	email		string	協議副本的電子郵件
到期時間	expirationTime		string	協議到期的時間。範例：2020-12-31T23：59：00Z
提醒頻率	reminderFrequency		string	您想多久發送一次提醒？
文件密碼	openPassword		string	應該用來加密已簽署合約的密碼 PDF
名稱	fieldName		string	功能變數名稱
價值觀	defaultValue		string	欄位的預設值
重新導向延遲	redirectDelay		string	使用者進入成功頁面之前的延遲（以秒為單位）。
重新導向網址	redirectUrl		string	完成簽署程序後要重新導向的URL，例如 https://adobe.com
初始電子郵件	initEmails		string	控制合約起始事件的通知郵件。

傳回

包含新建立合約 ID 的 JSON

身體: AgreementCreationResponseV6

從上傳的文件建立合約並傳送以供簽署（舊） [已淘汰]

作業識別碼：: CreateAgreementById

此作業會從 Adobe Acrobat Sign 中上傳的文件建立合約，並傳送以供簽署。

參數

名稱	機碼	必要	類型	Description
合約名稱	name	True	string	合約的名稱
文件 ID	transientDocumentId	True	string	上傳文件所收到的文件ID
簽章類型	signatureType	True	string	您想要要求的簽名類型 - 電子簽名或書面簽名
收件者電子郵件	email	True	string	收件人的電子郵件
收件者簽署順序	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色	recipientSetRole	True	string	指定收件者的角色
Message	message		string	傳送給要求其動作的收件者的選用訊息
截止日期前的天數	daysUntilSigningDeadline		integer	文件到期前剩餘的天數
提醒頻率	reminderFrequency		string	您想多久發送一次提醒？
文件密碼	openPassword		string	應該用來加密已簽署合約的密碼 PDF
文件 ID （2）	transientDocumentId		string	上傳文件所收到的文件ID
文件 ID （3）	transientDocumentId		string	上傳文件所收到的文件ID
文件 ID （4）	transientDocumentId		string	上傳文件所收到的文件ID
文件 ID （5）	transientDocumentId		string	上傳文件所收到的文件ID
文件 ID （6）	transientDocumentId		string	上傳文件所收到的文件ID
文件 ID （7）	transientDocumentId		string	上傳文件所收到的文件ID
文件 ID （8）	transientDocumentId		string	上傳文件所收到的文件ID
文件編號（9）	transientDocumentId		string	上傳文件所收到的文件ID
文件 ID （10）	transientDocumentId		string	上傳文件所收到的文件ID
收件人電子郵件（2）	email	True	string	收件人的電子郵件
收件人簽署順序（2）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（2）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（3）	email	True	string	收件人的電子郵件
收件人簽署順序（3）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（3）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（4）	email	True	string	收件人的電子郵件
收件人簽署順序（4）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（4）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（5）	email	True	string	收件人的電子郵件
收件人簽署順序（5）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（5）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（6）	email	True	string	收件人的電子郵件
收件人簽署順序（6）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（6）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（7）	email	True	string	收件人的電子郵件
收件人簽署順序（7）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（7）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（8）	email	True	string	收件人的電子郵件
收件人簽署順序（8）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（8）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（9）	email	True	string	收件人的電子郵件
收件人簽署順序（9）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（9）	recipientSetRole	True	string	指定收件者的角色
收件者電子郵件（10）	email	True	string	收件人的電子郵件
收件人簽署令（10）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（10）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（11）	email	True	string	收件人的電子郵件
收件人簽署順序（11）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（11）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（12）	email	True	string	收件人的電子郵件
收件人簽署順序（12）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（12）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（13）	email	True	string	收件人的電子郵件
收件人簽署令（13）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（13）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（14）	email	True	string	收件人的電子郵件
收件人簽署令（14）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（14）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（15）	email	True	string	收件人的電子郵件
收件人簽署令（15）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（15）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（16）	email	True	string	收件人的電子郵件
收件人簽署令（16）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（16）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（17）	email	True	string	收件人的電子郵件
收件人簽署令（17）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（17）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（18）	email	True	string	收件人的電子郵件
收件人簽署令（18）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（18）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（19）	email	True	string	收件人的電子郵件
收件人簽署令（19）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（19）	recipientSetRole	True	string	指定收件者的角色
收件者電子郵件（20）	email	True	string	收件人的電子郵件
收件人簽署訂單（20）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（20）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（21）	email	True	string	收件人的電子郵件
收件人簽署令（21）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（21）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（22）	email	True	string	收件人的電子郵件
收件人簽署令（22）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（22）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（23）	email	True	string	收件人的電子郵件
收件人簽署令（23）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（23）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（24）	email	True	string	收件人的電子郵件
收件人簽署令（24）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（24）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（25）	email	True	string	收件人的電子郵件
收件人簽署令（25）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（25）	recipientSetRole	True	string	指定收件者的角色
表單欄位名稱（1）	fieldName		string	功能變數名稱
表單欄位值（1）	defaultValue		string	欄位的預設值
表單欄位名稱（2）	fieldName		string	功能變數名稱
表單欄位值（2）	defaultValue		string	欄位的預設值
表單欄位名稱（3）	fieldName		string	功能變數名稱
表單欄位值（3）	defaultValue		string	欄位的預設值
表單欄位名稱（4）	fieldName		string	功能變數名稱
表單欄位值（4）	defaultValue		string	欄位的預設值
表單欄位名稱（5）	fieldName		string	功能變數名稱
表單欄位值（5）	defaultValue		string	欄位的預設值
表單欄位名稱（6）	fieldName		string	功能變數名稱
表單欄位值（6）	defaultValue		string	欄位的預設值
表單欄位名稱（7）	fieldName		string	功能變數名稱
表單欄位值（7）	defaultValue		string	欄位的預設值
表單欄位名稱（8）	fieldName		string	功能變數名稱
表單欄位值（8）	defaultValue		string	欄位的預設值
表單欄位名稱（9）	fieldName		string	功能變數名稱
表單欄位值（9）	defaultValue		string	欄位的預設值
表單欄位名稱（10）	fieldName		string	功能變數名稱
表單欄位值（10）	defaultValue		string	欄位的預設值
表單欄位名稱（11）	fieldName		string	功能變數名稱
表單欄位值（11）	defaultValue		string	欄位的預設值
表單欄位名稱（12）	fieldName		string	功能變數名稱
表單欄位值（12）	defaultValue		string	欄位的預設值
表單欄位名稱（13）	fieldName		string	功能變數名稱
表單欄位值（13）	defaultValue		string	欄位的預設值
表單欄位名稱（14）	fieldName		string	功能變數名稱
表單欄位值（14）	defaultValue		string	欄位的預設值
表單欄位名稱（15）	fieldName		string	功能變數名稱
表單欄位值（15）	defaultValue		string	欄位的預設值
表單欄位名稱（16）	fieldName		string	功能變數名稱
表單欄位值（16）	defaultValue		string	欄位的預設值
表單欄位名稱（17）	fieldName		string	功能變數名稱
表單欄位值（17）	defaultValue		string	欄位的預設值
表單欄位名稱（18）	fieldName		string	功能變數名稱
表單欄位值（18）	defaultValue		string	欄位的預設值
表單欄位名稱（19）	fieldName		string	功能變數名稱
表單欄位值（19）	defaultValue		string	欄位的預設值
表單欄位名稱（20）	fieldName		string	功能變數名稱
表單欄位值（20）	defaultValue		string	欄位的預設值
表單欄位名稱（21）	fieldName		string	功能變數名稱
表單欄位值（21）	defaultValue		string	欄位的預設值
表單欄位名稱（22）	fieldName		string	功能變數名稱
表單欄位值（22）	defaultValue		string	欄位的預設值
表單欄位名稱（23）	fieldName		string	功能變數名稱
表單欄位值（23）	defaultValue		string	欄位的預設值
表單欄位名稱（24）	fieldName		string	功能變數名稱
表單欄位值（24）	defaultValue		string	欄位的預設值
表單欄位名稱（25）	fieldName		string	功能變數名稱
表單欄位值（25）	defaultValue		string	欄位的預設值
表單欄位名稱（26）	fieldName		string	功能變數名稱
表單欄位值（26）	defaultValue		string	欄位的預設值
表單欄位名稱（27）	fieldName		string	功能變數名稱
表單欄位值（27）	defaultValue		string	欄位的預設值
表單欄位名稱（28）	fieldName		string	功能變數名稱
表單欄位值（28）	defaultValue		string	欄位的預設值
表單欄位名稱（29）	fieldName		string	功能變數名稱
表單欄位值（29）	defaultValue		string	欄位的預設值
表單欄位名稱（30）	fieldName		string	功能變數名稱
表單欄位值（30）	defaultValue		string	欄位的預設值
表單欄位名稱（31）	fieldName		string	功能變數名稱
表單欄位值（31）	defaultValue		string	欄位的預設值
表單欄位名稱（32）	fieldName		string	功能變數名稱
表單欄位值（32）	defaultValue		string	欄位的預設值
表單欄位名稱（33）	fieldName		string	功能變數名稱
表單欄位值（33）	defaultValue		string	欄位的預設值
表單欄位名稱（34）	fieldName		string	功能變數名稱
表單欄位值（34）	defaultValue		string	欄位的預設值
表單欄位名稱（35）	fieldName		string	功能變數名稱
表單欄位值（35）	defaultValue		string	欄位的預設值
表單欄位名稱（36）	fieldName		string	功能變數名稱
表單欄位值（36）	defaultValue		string	欄位的預設值
表單欄位名稱（37）	fieldName		string	功能變數名稱
表單欄位值（37）	defaultValue		string	欄位的預設值
表單欄位名稱（38）	fieldName		string	功能變數名稱
表單欄位值（38）	defaultValue		string	欄位的預設值
表單欄位名稱（39）	fieldName		string	功能變數名稱
表單欄位值（39）	defaultValue		string	欄位的預設值
表單欄位名稱（40）	fieldName		string	功能變數名稱
表單欄位值（40）	defaultValue		string	欄位的預設值
表單欄位名稱（41）	fieldName		string	功能變數名稱
表單欄位值（41）	defaultValue		string	欄位的預設值
表單欄位名稱（42）	fieldName		string	功能變數名稱
表單欄位值（42）	defaultValue		string	欄位的預設值
表單欄位名稱（43）	fieldName		string	功能變數名稱
表單欄位值（43）	defaultValue		string	欄位的預設值
表單欄位名稱（44）	fieldName		string	功能變數名稱
表單欄位值（44）	defaultValue		string	欄位的預設值
表單欄位名稱（45）	fieldName		string	功能變數名稱
表單欄位值（45）	defaultValue		string	欄位的預設值
表單欄位名稱（46）	fieldName		string	功能變數名稱
表單欄位值（46）	defaultValue		string	欄位的預設值
表單欄位名稱（47）	fieldName		string	功能變數名稱
表單欄位值（47）	defaultValue		string	欄位的預設值
表單欄位名稱（48）	fieldName		string	功能變數名稱
表單欄位值（48）	defaultValue		string	欄位的預設值
表單欄位名稱（49）	fieldName		string	功能變數名稱
表單欄位值（49）	defaultValue		string	欄位的預設值
表單欄位名稱（50）	fieldName		string	功能變數名稱
表單欄位值（50）	defaultValue		string	欄位的預設值

傳回

包含新建立合約 ID 的 JSON

身體: AgreementCreationResponse

從上傳的文件建立文件庫範本

作業識別碼：: CreateLibraryDocumentById_V2

此作業會從上傳的文件在 Adobe Acrobat Sign 資料庫中建立範本。使用此範本來傳送合約。

參數

名稱	機碼	必要	類型	Description
以	x-api-user		string	API呼叫者的電子郵件格式為：電子郵件：adobesignuser@domain.com
範本名稱	name	True	string	用來識別範本的合約名稱
範本類型	templateTypes	True	array of string	一或多個文件庫範本類型的清單
共享模式	sharingMode	True	string	指定誰應該有權存取此文件庫文件
ID	transientDocumentId	True	string	上傳暫時性文件所收到的文件識別碼
範本狀態	state	True	string	文件庫文件的狀態。
群組名稱/ID	groupId		string	群組的 ID。要使用此 - 需要選擇“以名稱”字段

傳回

描述程式庫範本的 JSON 物件

身體: LibraryDocumentCreationResponseV6

從上傳的文件建立文件庫範本（舊） [已棄用]

作業識別碼：: CreateLibraryDocumentById

此作業會從上傳的文件在 Adobe Acrobat Sign 資料庫中建立範本。使用此範本來傳送合約。

參數

名稱	機碼	必要	類型	Description
範本名稱	name	True	string	用來識別範本的合約名稱
範本類型	libraryTemplateTypes	True	string	一或多個文件庫範本類型的清單
分享給	librarySharingMode	True	string	指定誰應該有權存取此文件庫文件
文件 ID	transientDocumentId	True	string	上傳文件所收到的文件ID
文件 ID （2）	transientDocumentId		string	上傳文件所收到的文件ID
文件 ID （3）	transientDocumentId		string	上傳文件所收到的文件ID
文件 ID （4）	transientDocumentId		string	上傳文件所收到的文件ID
文件 ID （5）	transientDocumentId		string	上傳文件所收到的文件ID
文件 ID （6）	transientDocumentId		string	上傳文件所收到的文件ID
文件 ID （7）	transientDocumentId		string	上傳文件所收到的文件ID
文件 ID （8）	transientDocumentId		string	上傳文件所收到的文件ID
文件編號（9）	transientDocumentId		string	上傳文件所收到的文件ID
文件 ID （10）	transientDocumentId		string	上傳文件所收到的文件ID

傳回

描述程式庫範本的 JSON 物件

身體: LibraryDocumentCreationResponse

從合約取得所有文件 ID 的清單 [已棄用]

作業識別碼：: GetAllDocumentsofAnAgreement

此動作已被取代。請改用 [從合約取得所有文件 ID 的清單]。

~~此作業會擷取合約之所有文件及支援文件的 ID。~~

參數

名稱	機碼	必要	類型	Description
合約標識碼	agreementId	True	string	需要其文件之合約的合約 ID
支援文件 - 內容類型	supportingDocumentContentFormat		string	協議證明文件的內容類型

傳回

同時包含文件及支援文件陣列物件的 JSON

身體: AgreementDocuments

從合約取得所有文件識別碼的清單

作業識別碼：: GetAllDocumentsofAnAgreement_V2

此作業會擷取合約之所有文件及支援文件的 ID。

參數

名稱	機碼	必要	類型	Description
合約標識碼	agreementId	True	string	需要其文件之合約的合約 ID
支援文件 - 內容類型	supportingDocumentContentFormat		string	協議證明文件的內容類型
以	x-api-user		string	API呼叫者的電子郵件格式為：電子郵件：adobesignuser@domain.com

傳回

同時包含文件及支援文件陣列物件的 JSON

身體: AgreementDocumentsV6

從合約取得文件

作業識別碼：: GetDocument_V2

此作業會擷取合約特定檔的檔案串流。

參數

名稱	機碼	必要	類型	Description
合約標識碼	agreementId	True	string	需要其文件之合約的合約 ID
文件 ID	documentId	True	string	合約特定文件的文件ID
以	x-api-user		string	API呼叫者的電子郵件格式為：電子郵件：adobesignuser@domain.com

傳回

文件的檔案串流

response: DocumentResponse

從合約取得文件 [已棄用]

作業識別碼：: GetDocument

此動作已被取代。請改用 [ 從合約取得文件 ]。

~~此作業會擷取合約特定檔的檔案串流。~~

參數

名稱	機碼	必要	類型	Description
合約標識碼	agreementId	True	string	需要其文件之合約的合約 ID
文件 ID	documentId	True	string	合約特定文件的文件ID

傳回

文件的檔案串流

response: DocumentResponse

從工作流程建立合約並傳送以供簽署

作業識別碼：: CreateAgreementFromWorkflow

此作業會從 Adobe Acrobat Sign 中的工作流程建立合約，並傳送以供簽署。

參數

名稱	機碼	必要	類型	Description
以	x-api-user	True	string	API呼叫者的電子郵件格式為：電子郵件：adobesignuser@domain.com
群組名稱/ID	groupId	True	string	群組的 ID。要使用此 - 需要選擇“以名稱”字段
工作流程名稱/ID	workflowIdParam	True	string	從清單中選取自訂工作流程，或輸入自訂工作流程ID。
agreementWorkflowSchema	agreementWorkflowSchema	True	dynamic	所選事件的詳細資料。

傳回

包含新建立合約 ID 的 JSON

身體: AgreementCreationResponseV6

從文件 URL 建立合約並傳送以供簽署

作業識別碼：: CreateAgreementByUrl_V2

此作業會從 Adobe Acrobat Sign 中上傳的文件建立合約，並傳送以供簽署。

參數

名稱	機碼	必要	類型	Description
以	x-api-user		string	API呼叫者的電子郵件格式為：電子郵件：adobesignuser@domain.com
合約名稱	name	True	string	合約的名稱
URL	url	True	string	用於擷取原始檔案內容的可公開存取 URL
名稱	name	True	string	所傳送文件的原始系統檔名
類型	mimeType	True	string	參考檔案的 MIME 類型，例如 application/pdf
簽章類型	signatureType	True	string	指定所要求的簽名類型 - 電子簽名或書面簽名
參與者電子郵件	email	True	string	參與者的電子郵件
Authentication	authenticationMethod		string	預設驗證：電子郵件（無）
密碼	password		string	參與者所需的密碼
國碼 (地區碼)	countryCode		string	收件者的電話國家/地區代碼需要查看和簽署文件
電話號碼	phone		string	檢視和簽署合約所需的收件者電話號碼
訂單	order	True	integer	索引從1開頭，表示簽署群組需要簽署的位置。
Role	role	True	string	參與者集的目前角色（簽署者、核准者等）。
群組名稱/ID	groupId		string	群組的 ID。要使用此 - 需要選擇“以名稱”字段
Message	message		string	傳送給要求其動作的收件者的選用訊息
Email	email		string	協議副本的電子郵件
到期時間	expirationTime		string	協議到期的時間。範例：2020-12-31T23：59：00Z
提醒頻率	reminderFrequency		string	您想多久發送一次提醒？
文件密碼	openPassword		string	應該用來加密已簽署合約的密碼 PDF
名稱	fieldName		string	功能變數名稱
價值觀	defaultValue		string	欄位的預設值
重新導向延遲	redirectDelay		string	使用者進入成功頁面之前的延遲（以秒為單位）。
重新導向網址	redirectUrl		string	完成簽署程序後要重新導向的URL，例如 https://adobe.com
初始電子郵件	initEmails		string	控制合約起始事件的通知郵件。

傳回

包含新建立合約 ID 的 JSON

身體: AgreementCreationResponseV6

從文件 URL 建立合約並傳送以供簽署（舊版） [已淘汰]

作業識別碼：: CreateAgreementByUrl

此作業會從 Adobe Acrobat Sign 中上傳的文件建立合約，並傳送以供簽署。

參數

名稱	機碼	必要	類型	Description
合約名稱	name	True	string	合約的名稱
URL	url	True	string	用於擷取文件的可公開存取 URL
名稱	name	True	string	參考文件的名稱，副檔名
簽章類型	signatureType	True	string	您想要要求的簽名類型 - 電子簽名或書面簽名
收件者電子郵件	email	True	string	收件人的電子郵件
收件者簽署順序	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色	recipientSetRole	True	string	指定收件者的角色
Message	message		string	傳送給要求其動作的收件者的選用訊息
截止日期前的天數	daysUntilSigningDeadline		integer	文件到期前剩餘的天數
提醒頻率	reminderFrequency		string	您想多久發送一次提醒？
文件密碼	openPassword		string	應該用來加密已簽署合約的密碼 PDF
網址（2）	url		string	用於擷取文件的可公開存取 URL
名稱（2）	name		string	參考文件的名稱，副檔名
網址（3）	url		string	用於擷取文件的可公開存取 URL
名稱（3）	name		string	參考文件的名稱，副檔名
網址（4）	url		string	用於擷取文件的可公開存取 URL
名稱（4）	name		string	參考文件的名稱，副檔名
網址（5）	url		string	用於擷取文件的可公開存取 URL
名稱（5）	name		string	參考文件的名稱，副檔名
網址（6）	url		string	用於擷取文件的可公開存取 URL
名稱（6）	name		string	參考文件的名稱，副檔名
網址（7）	url		string	用於擷取文件的可公開存取 URL
名稱（7）	name		string	參考文件的名稱，副檔名
網址（8）	url		string	用於擷取文件的可公開存取 URL
名稱（8）	name		string	參考文件的名稱，副檔名
網址（9）	url		string	用於擷取文件的可公開存取 URL
名稱（9）	name		string	參考文件的名稱，副檔名
網址（10）	url		string	用於擷取文件的可公開存取 URL
名稱（10）	name		string	參考文件的名稱，副檔名
收件人電子郵件（2）	email	True	string	收件人的電子郵件
收件人簽署順序（2）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（2）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（3）	email	True	string	收件人的電子郵件
收件人簽署順序（3）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（3）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（4）	email	True	string	收件人的電子郵件
收件人簽署順序（4）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（4）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（5）	email	True	string	收件人的電子郵件
收件人簽署順序（5）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（5）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（6）	email	True	string	收件人的電子郵件
收件人簽署順序（6）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（6）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（7）	email	True	string	收件人的電子郵件
收件人簽署順序（7）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（7）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（8）	email	True	string	收件人的電子郵件
收件人簽署順序（8）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（8）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（9）	email	True	string	收件人的電子郵件
收件人簽署順序（9）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（9）	recipientSetRole	True	string	指定收件者的角色
收件者電子郵件（10）	email	True	string	收件人的電子郵件
收件人簽署令（10）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（10）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（11）	email	True	string	收件人的電子郵件
收件人簽署順序（11）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（11）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（12）	email	True	string	收件人的電子郵件
收件人簽署順序（12）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（12）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（13）	email	True	string	收件人的電子郵件
收件人簽署令（13）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（13）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（14）	email	True	string	收件人的電子郵件
收件人簽署令（14）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（14）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（15）	email	True	string	收件人的電子郵件
收件人簽署令（15）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（15）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（16）	email	True	string	收件人的電子郵件
收件人簽署令（16）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（16）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（17）	email	True	string	收件人的電子郵件
收件人簽署令（17）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（17）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（18）	email	True	string	收件人的電子郵件
收件人簽署令（18）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（18）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（19）	email	True	string	收件人的電子郵件
收件人簽署令（19）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（19）	recipientSetRole	True	string	指定收件者的角色
收件者電子郵件（20）	email	True	string	收件人的電子郵件
收件人簽署訂單（20）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（20）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（21）	email	True	string	收件人的電子郵件
收件人簽署令（21）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（21）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（22）	email	True	string	收件人的電子郵件
收件人簽署令（22）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（22）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（23）	email	True	string	收件人的電子郵件
收件人簽署令（23）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（23）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（24）	email	True	string	收件人的電子郵件
收件人簽署令（24）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（24）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（25）	email	True	string	收件人的電子郵件
收件人簽署令（25）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（25）	recipientSetRole	True	string	指定收件者的角色
表單欄位名稱（1）	fieldName		string	功能變數名稱
表單欄位值（1）	defaultValue		string	欄位的預設值
表單欄位名稱（2）	fieldName		string	功能變數名稱
表單欄位值（2）	defaultValue		string	欄位的預設值
表單欄位名稱（3）	fieldName		string	功能變數名稱
表單欄位值（3）	defaultValue		string	欄位的預設值
表單欄位名稱（4）	fieldName		string	功能變數名稱
表單欄位值（4）	defaultValue		string	欄位的預設值
表單欄位名稱（5）	fieldName		string	功能變數名稱
表單欄位值（5）	defaultValue		string	欄位的預設值
表單欄位名稱（6）	fieldName		string	功能變數名稱
表單欄位值（6）	defaultValue		string	欄位的預設值
表單欄位名稱（7）	fieldName		string	功能變數名稱
表單欄位值（7）	defaultValue		string	欄位的預設值
表單欄位名稱（8）	fieldName		string	功能變數名稱
表單欄位值（8）	defaultValue		string	欄位的預設值
表單欄位名稱（9）	fieldName		string	功能變數名稱
表單欄位值（9）	defaultValue		string	欄位的預設值
表單欄位名稱（10）	fieldName		string	功能變數名稱
表單欄位值（10）	defaultValue		string	欄位的預設值
表單欄位名稱（11）	fieldName		string	功能變數名稱
表單欄位值（11）	defaultValue		string	欄位的預設值
表單欄位名稱（12）	fieldName		string	功能變數名稱
表單欄位值（12）	defaultValue		string	欄位的預設值
表單欄位名稱（13）	fieldName		string	功能變數名稱
表單欄位值（13）	defaultValue		string	欄位的預設值
表單欄位名稱（14）	fieldName		string	功能變數名稱
表單欄位值（14）	defaultValue		string	欄位的預設值
表單欄位名稱（15）	fieldName		string	功能變數名稱
表單欄位值（15）	defaultValue		string	欄位的預設值
表單欄位名稱（16）	fieldName		string	功能變數名稱
表單欄位值（16）	defaultValue		string	欄位的預設值
表單欄位名稱（17）	fieldName		string	功能變數名稱
表單欄位值（17）	defaultValue		string	欄位的預設值
表單欄位名稱（18）	fieldName		string	功能變數名稱
表單欄位值（18）	defaultValue		string	欄位的預設值
表單欄位名稱（19）	fieldName		string	功能變數名稱
表單欄位值（19）	defaultValue		string	欄位的預設值
表單欄位名稱（20）	fieldName		string	功能變數名稱
表單欄位值（20）	defaultValue		string	欄位的預設值
表單欄位名稱（21）	fieldName		string	功能變數名稱
表單欄位值（21）	defaultValue		string	欄位的預設值
表單欄位名稱（22）	fieldName		string	功能變數名稱
表單欄位值（22）	defaultValue		string	欄位的預設值
表單欄位名稱（23）	fieldName		string	功能變數名稱
表單欄位值（23）	defaultValue		string	欄位的預設值
表單欄位名稱（24）	fieldName		string	功能變數名稱
表單欄位值（24）	defaultValue		string	欄位的預設值
表單欄位名稱（25）	fieldName		string	功能變數名稱
表單欄位值（25）	defaultValue		string	欄位的預設值
表單欄位名稱（26）	fieldName		string	功能變數名稱
表單欄位值（26）	defaultValue		string	欄位的預設值
表單欄位名稱（27）	fieldName		string	功能變數名稱
表單欄位值（27）	defaultValue		string	欄位的預設值
表單欄位名稱（28）	fieldName		string	功能變數名稱
表單欄位值（28）	defaultValue		string	欄位的預設值
表單欄位名稱（29）	fieldName		string	功能變數名稱
表單欄位值（29）	defaultValue		string	欄位的預設值
表單欄位名稱（30）	fieldName		string	功能變數名稱
表單欄位值（30）	defaultValue		string	欄位的預設值
表單欄位名稱（31）	fieldName		string	功能變數名稱
表單欄位值（31）	defaultValue		string	欄位的預設值
表單欄位名稱（32）	fieldName		string	功能變數名稱
表單欄位值（32）	defaultValue		string	欄位的預設值
表單欄位名稱（33）	fieldName		string	功能變數名稱
表單欄位值（33）	defaultValue		string	欄位的預設值
表單欄位名稱（34）	fieldName		string	功能變數名稱
表單欄位值（34）	defaultValue		string	欄位的預設值
表單欄位名稱（35）	fieldName		string	功能變數名稱
表單欄位值（35）	defaultValue		string	欄位的預設值
表單欄位名稱（36）	fieldName		string	功能變數名稱
表單欄位值（36）	defaultValue		string	欄位的預設值
表單欄位名稱（37）	fieldName		string	功能變數名稱
表單欄位值（37）	defaultValue		string	欄位的預設值
表單欄位名稱（38）	fieldName		string	功能變數名稱
表單欄位值（38）	defaultValue		string	欄位的預設值
表單欄位名稱（39）	fieldName		string	功能變數名稱
表單欄位值（39）	defaultValue		string	欄位的預設值
表單欄位名稱（40）	fieldName		string	功能變數名稱
表單欄位值（40）	defaultValue		string	欄位的預設值
表單欄位名稱（41）	fieldName		string	功能變數名稱
表單欄位值（41）	defaultValue		string	欄位的預設值
表單欄位名稱（42）	fieldName		string	功能變數名稱
表單欄位值（42）	defaultValue		string	欄位的預設值
表單欄位名稱（43）	fieldName		string	功能變數名稱
表單欄位值（43）	defaultValue		string	欄位的預設值
表單欄位名稱（44）	fieldName		string	功能變數名稱
表單欄位值（44）	defaultValue		string	欄位的預設值
表單欄位名稱（45）	fieldName		string	功能變數名稱
表單欄位值（45）	defaultValue		string	欄位的預設值
表單欄位名稱（46）	fieldName		string	功能變數名稱
表單欄位值（46）	defaultValue		string	欄位的預設值
表單欄位名稱（47）	fieldName		string	功能變數名稱
表單欄位值（47）	defaultValue		string	欄位的預設值
表單欄位名稱（48）	fieldName		string	功能變數名稱
表單欄位值（48）	defaultValue		string	欄位的預設值
表單欄位名稱（49）	fieldName		string	功能變數名稱
表單欄位值（49）	defaultValue		string	欄位的預設值
表單欄位名稱（50）	fieldName		string	功能變數名稱
表單欄位值（50）	defaultValue		string	欄位的預設值

傳回

包含新建立合約 ID 的 JSON

身體: AgreementCreationResponse

從文件 URL 建立文件庫範本

作業識別碼：: CreateLibraryDocumentByUrl_V2

此作業會從文件 URL 在 Adobe Acrobat Sign 資料庫中建立範本。使用此範本傳送合約

參數

名稱	機碼	必要	類型	Description
以	x-api-user		string	API呼叫者的電子郵件格式為：電子郵件：adobesignuser@domain.com
範本名稱	name	True	string	用來識別範本的合約名稱
範本類型	templateTypes	True	array of string	一或多個文件庫範本類型的清單
共享模式	sharingMode	True	string	指定誰應該有權存取此文件庫文件
URL	url	True	string	用於擷取原始檔案內容的可公開存取 URL
名稱	name	True	string	所傳送文件的原始系統檔名
類型	mimeType	True	string	參考檔案的 MIME 類型，例如 application/pdf
範本狀態	state	True	string	文件庫文件的狀態。
群組名稱/ID	groupId		string	群組的 ID。要使用此 - 需要選擇“以名稱”字段

傳回

描述程式庫範本的 JSON 物件

身體: LibraryDocumentCreationResponseV6

從文件 URL 建立文件庫範本（舊） [已棄用]

作業識別碼：: CreateLibraryDocumentByUrl

此作業會從文件 URL 在 Adobe Acrobat Sign 資料庫中建立範本。使用此範本傳送合約

參數

名稱	機碼	必要	類型	Description
範本名稱	name	True	string	用來識別範本的合約名稱
範本類型	libraryTemplateTypes	True	string	一或多個文件庫範本類型的清單
分享給	librarySharingMode	True	string	指定誰應該有權存取此文件庫文件
URL	url	True	string	用於擷取文件的可公開存取 URL
名稱	name	True	string	參考文件的名稱，副檔名
網址（2）	url		string	用於擷取文件的可公開存取 URL
名稱（2）	name		string	參考文件的名稱，副檔名
網址（3）	url		string	用於擷取文件的可公開存取 URL
名稱（3）	name		string	參考文件的名稱，副檔名
網址（4）	url		string	用於擷取文件的可公開存取 URL
名稱（4）	name		string	參考文件的名稱，副檔名
網址（5）	url		string	用於擷取文件的可公開存取 URL
名稱（5）	name		string	參考文件的名稱，副檔名
網址（6）	url		string	用於擷取文件的可公開存取 URL
名稱（6）	name		string	參考文件的名稱，副檔名
網址（7）	url		string	用於擷取文件的可公開存取 URL
名稱（7）	name		string	參考文件的名稱，副檔名
網址（8）	url		string	用於擷取文件的可公開存取 URL
名稱（8）	name		string	參考文件的名稱，副檔名
網址（9）	url		string	用於擷取文件的可公開存取 URL
名稱（9）	name		string	參考文件的名稱，副檔名
網址（10）	url		string	用於擷取文件的可公開存取 URL
名稱（10）	name		string	參考文件的名稱，副檔名

傳回

描述程式庫範本的 JSON 物件

身體: LibraryDocumentCreationResponse

從文件庫範本建立合約並傳送以供簽署

作業識別碼：: CreateAgreementByTemplate_V2

此作業會從儲存在使用者 Adobe Acrobat Sign 資料庫中的範本建立合約，並傳送以供簽署。

參數

名稱	機碼	必要	類型	Description
以	x-api-user		string	API呼叫者的電子郵件格式為：電子郵件：adobesignuser@domain.com
合約名稱	name	True	string	合約的名稱
Template	libraryDocumentId	True	string	從儲存在資料庫中的範本中選擇文件
簽章類型	signatureType	True	string	您要要求的簽名類型 - 電子簽名或書面簽名
參與者電子郵件	email	True	string	參與者的電子郵件
Authentication	authenticationMethod		string	預設驗證：電子郵件（無）
密碼	password		string	參與者所需的密碼
國碼 (地區碼)	countryCode		string	收件者的電話國家/地區代碼需要查看和簽署文件
電話號碼	phone		string	檢視和簽署合約所需的收件者電話號碼
訂單	order	True	integer	索引從1開頭，表示簽署群組需要簽署的位置。
Role	role	True	string	參與者集的目前角色（簽署者、核准者等）。
群組名稱/ID	groupId		string	群組的 ID。要使用此 - 需要選擇“以名稱”字段
Message	message		string	傳送給要求其動作的收件者的選用訊息
Email	email		string	協議副本的電子郵件
到期時間	expirationTime		string	協議到期的時間。範例：2020-12-31T23：59：00Z
提醒頻率	reminderFrequency		string	您想多久發送一次提醒？
文件密碼	openPassword		string	應該用來加密已簽署合約的密碼 PDF
名稱	fieldName		string	功能變數名稱
價值觀	defaultValue		string	欄位的預設值
重新導向延遲	redirectDelay		string	使用者進入成功頁面之前的延遲（以秒為單位）。
重新導向網址	redirectUrl		string	完成簽署程序後要重新導向的URL，例如 https://adobe.com
初始電子郵件	initEmails		string	控制合約起始事件的通知郵件。

傳回

包含新建立合約 ID 的 JSON

身體: AgreementCreationResponseV6

從文件庫範本建立合約並傳送以供簽署（舊版） [已淘汰]

作業識別碼：: CreateAgreementByTemplate

此作業會從儲存在使用者 Adobe Acrobat Sign 資料庫中的範本建立合約，並傳送以供簽署。

參數

名稱	機碼	必要	類型	Description
合約名稱	name	True	string	合約的名稱
文件庫範本	libraryDocumentId	True	string	從儲存在資料庫中的範本中選擇文件
簽章類型	signatureType	True	string	您想要要求的簽名類型 - 電子簽名或書面簽名
收件者電子郵件	email	True	string	收件人的電子郵件
收件者簽署順序	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色	recipientSetRole	True	string	指定收件者的角色
Message	message		string	傳送給要求其動作的收件者的選用訊息
截止日期前的天數	daysUntilSigningDeadline		integer	文件到期前剩餘的天數
提醒頻率	reminderFrequency		string	您想多久發送一次提醒？
文件密碼	openPassword		string	應該用來加密已簽署合約的密碼 PDF
文件庫範本（2）	libraryDocumentId		string	從儲存在資料庫中的範本中選擇文件
文件庫範本（3）	libraryDocumentId		string	從儲存在資料庫中的範本中選擇文件
文件庫範本（4）	libraryDocumentId		string	從儲存在資料庫中的範本中選擇文件
文件庫範本（5）	libraryDocumentId		string	從儲存在資料庫中的範本中選擇文件
文件庫範本（6）	libraryDocumentId		string	從儲存在資料庫中的範本中選擇文件
文件庫範本（7）	libraryDocumentId		string	從儲存在資料庫中的範本中選擇文件
文件庫範本（8）	libraryDocumentId		string	從儲存在資料庫中的範本中選擇文件
文件庫範本（9）	libraryDocumentId		string	從儲存在資料庫中的範本中選擇文件
文件庫範本（10）	libraryDocumentId		string	從儲存在資料庫中的範本中選擇文件
收件人電子郵件（2）	email	True	string	收件人的電子郵件
收件人簽署順序（2）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（2）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（3）	email	True	string	收件人的電子郵件
收件人簽署順序（3）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（3）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（4）	email	True	string	收件人的電子郵件
收件人簽署順序（4）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（4）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（5）	email	True	string	收件人的電子郵件
收件人簽署順序（5）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（5）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（6）	email	True	string	收件人的電子郵件
收件人簽署順序（6）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（6）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（7）	email	True	string	收件人的電子郵件
收件人簽署順序（7）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（7）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（8）	email	True	string	收件人的電子郵件
收件人簽署順序（8）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（8）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（9）	email	True	string	收件人的電子郵件
收件人簽署順序（9）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（9）	recipientSetRole	True	string	指定收件者的角色
收件者電子郵件（10）	email	True	string	收件人的電子郵件
收件人簽署令（10）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（10）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（11）	email	True	string	收件人的電子郵件
收件人簽署順序（11）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（11）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（12）	email	True	string	收件人的電子郵件
收件人簽署順序（12）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（12）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（13）	email	True	string	收件人的電子郵件
收件人簽署令（13）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（13）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（14）	email	True	string	收件人的電子郵件
收件人簽署令（14）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（14）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（15）	email	True	string	收件人的電子郵件
收件人簽署令（15）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（15）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（16）	email	True	string	收件人的電子郵件
收件人簽署令（16）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（16）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（17）	email	True	string	收件人的電子郵件
收件人簽署令（17）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（17）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（18）	email	True	string	收件人的電子郵件
收件人簽署令（18）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（18）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（19）	email	True	string	收件人的電子郵件
收件人簽署令（19）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（19）	recipientSetRole	True	string	指定收件者的角色
收件者電子郵件（20）	email	True	string	收件人的電子郵件
收件人簽署訂單（20）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（20）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（21）	email	True	string	收件人的電子郵件
收件人簽署令（21）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（21）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（22）	email	True	string	收件人的電子郵件
收件人簽署令（22）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（22）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（23）	email	True	string	收件人的電子郵件
收件人簽署令（23）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（23）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（24）	email	True	string	收件人的電子郵件
收件人簽署令（24）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（24）	recipientSetRole	True	string	指定收件者的角色
收件人電子郵件（25）	email	True	string	收件人的電子郵件
收件人簽署令（25）	signingOrder	True	integer	索引以 1 開頭，表示該收件人簽名的順序
收件者角色（25）	recipientSetRole	True	string	指定收件者的角色
表單欄位名稱（1）	fieldName		string	功能變數名稱
表單欄位值（1）	defaultValue		string	欄位的預設值
表單欄位名稱（2）	fieldName		string	功能變數名稱
表單欄位值（2）	defaultValue		string	欄位的預設值
表單欄位名稱（3）	fieldName		string	功能變數名稱
表單欄位值（3）	defaultValue		string	欄位的預設值
表單欄位名稱（4）	fieldName		string	功能變數名稱
表單欄位值（4）	defaultValue		string	欄位的預設值
表單欄位名稱（5）	fieldName		string	功能變數名稱
表單欄位值（5）	defaultValue		string	欄位的預設值
表單欄位名稱（6）	fieldName		string	功能變數名稱
表單欄位值（6）	defaultValue		string	欄位的預設值
表單欄位名稱（7）	fieldName		string	功能變數名稱
表單欄位值（7）	defaultValue		string	欄位的預設值
表單欄位名稱（8）	fieldName		string	功能變數名稱
表單欄位值（8）	defaultValue		string	欄位的預設值
表單欄位名稱（9）	fieldName		string	功能變數名稱
表單欄位值（9）	defaultValue		string	欄位的預設值
表單欄位名稱（10）	fieldName		string	功能變數名稱
表單欄位值（10）	defaultValue		string	欄位的預設值
表單欄位名稱（11）	fieldName		string	功能變數名稱
表單欄位值（11）	defaultValue		string	欄位的預設值
表單欄位名稱（12）	fieldName		string	功能變數名稱
表單欄位值（12）	defaultValue		string	欄位的預設值
表單欄位名稱（13）	fieldName		string	功能變數名稱
表單欄位值（13）	defaultValue		string	欄位的預設值
表單欄位名稱（14）	fieldName		string	功能變數名稱
表單欄位值（14）	defaultValue		string	欄位的預設值
表單欄位名稱（15）	fieldName		string	功能變數名稱
表單欄位值（15）	defaultValue		string	欄位的預設值
表單欄位名稱（16）	fieldName		string	功能變數名稱
表單欄位值（16）	defaultValue		string	欄位的預設值
表單欄位名稱（17）	fieldName		string	功能變數名稱
表單欄位值（17）	defaultValue		string	欄位的預設值
表單欄位名稱（18）	fieldName		string	功能變數名稱
表單欄位值（18）	defaultValue		string	欄位的預設值
表單欄位名稱（19）	fieldName		string	功能變數名稱
表單欄位值（19）	defaultValue		string	欄位的預設值
表單欄位名稱（20）	fieldName		string	功能變數名稱
表單欄位值（20）	defaultValue		string	欄位的預設值
表單欄位名稱（21）	fieldName		string	功能變數名稱
表單欄位值（21）	defaultValue		string	欄位的預設值
表單欄位名稱（22）	fieldName		string	功能變數名稱
表單欄位值（22）	defaultValue		string	欄位的預設值
表單欄位名稱（23）	fieldName		string	功能變數名稱
表單欄位值（23）	defaultValue		string	欄位的預設值
表單欄位名稱（24）	fieldName		string	功能變數名稱
表單欄位值（24）	defaultValue		string	欄位的預設值
表單欄位名稱（25）	fieldName		string	功能變數名稱
表單欄位值（25）	defaultValue		string	欄位的預設值
表單欄位名稱（26）	fieldName		string	功能變數名稱
表單欄位值（26）	defaultValue		string	欄位的預設值
表單欄位名稱（27）	fieldName		string	功能變數名稱
表單欄位值（27）	defaultValue		string	欄位的預設值
表單欄位名稱（28）	fieldName		string	功能變數名稱
表單欄位值（28）	defaultValue		string	欄位的預設值
表單欄位名稱（29）	fieldName		string	功能變數名稱
表單欄位值（29）	defaultValue		string	欄位的預設值
表單欄位名稱（30）	fieldName		string	功能變數名稱
表單欄位值（30）	defaultValue		string	欄位的預設值
表單欄位名稱（31）	fieldName		string	功能變數名稱
表單欄位值（31）	defaultValue		string	欄位的預設值
表單欄位名稱（32）	fieldName		string	功能變數名稱
表單欄位值（32）	defaultValue		string	欄位的預設值
表單欄位名稱（33）	fieldName		string	功能變數名稱
表單欄位值（33）	defaultValue		string	欄位的預設值
表單欄位名稱（34）	fieldName		string	功能變數名稱
表單欄位值（34）	defaultValue		string	欄位的預設值
表單欄位名稱（35）	fieldName		string	功能變數名稱
表單欄位值（35）	defaultValue		string	欄位的預設值
表單欄位名稱（36）	fieldName		string	功能變數名稱
表單欄位值（36）	defaultValue		string	欄位的預設值
表單欄位名稱（37）	fieldName		string	功能變數名稱
表單欄位值（37）	defaultValue		string	欄位的預設值
表單欄位名稱（38）	fieldName		string	功能變數名稱
表單欄位值（38）	defaultValue		string	欄位的預設值
表單欄位名稱（39）	fieldName		string	功能變數名稱
表單欄位值（39）	defaultValue		string	欄位的預設值
表單欄位名稱（40）	fieldName		string	功能變數名稱
表單欄位值（40）	defaultValue		string	欄位的預設值
表單欄位名稱（41）	fieldName		string	功能變數名稱
表單欄位值（41）	defaultValue		string	欄位的預設值
表單欄位名稱（42）	fieldName		string	功能變數名稱
表單欄位值（42）	defaultValue		string	欄位的預設值
表單欄位名稱（43）	fieldName		string	功能變數名稱
表單欄位值（43）	defaultValue		string	欄位的預設值
表單欄位名稱（44）	fieldName		string	功能變數名稱
表單欄位值（44）	defaultValue		string	欄位的預設值
表單欄位名稱（45）	fieldName		string	功能變數名稱
表單欄位值（45）	defaultValue		string	欄位的預設值
表單欄位名稱（46）	fieldName		string	功能變數名稱
表單欄位值（46）	defaultValue		string	欄位的預設值
表單欄位名稱（47）	fieldName		string	功能變數名稱
表單欄位值（47）	defaultValue		string	欄位的預設值
表單欄位名稱（48）	fieldName		string	功能變數名稱
表單欄位值（48）	defaultValue		string	欄位的預設值
表單欄位名稱（49）	fieldName		string	功能變數名稱
表單欄位值（49）	defaultValue		string	欄位的預設值
表單欄位名稱（50）	fieldName		string	功能變數名稱
表單欄位值（50）	defaultValue		string	欄位的預設值

傳回

包含新建立合約 ID 的 JSON

身體: AgreementCreationResponse

從檔案內容建立合約並傳送以供簽署

作業識別碼：: CreateAgreementByFileStream

此作業會從 Adobe Acrobat Sign 中的檔案建立合約，並傳送以供簽署。

參數

名稱	機碼	必要	類型	Description
以	x-api-user		string	API呼叫者的電子郵件格式為：電子郵件：adobesignuser@domain.com
合約名稱	name	True	string	合約的名稱
名稱	fileName	True	string	要上傳的文件名稱，副檔名
Content	formData	True	byte	要上傳的文件的檔案串流
簽章類型	signatureType	True	string	您要要求的簽名類型 - 電子簽名或書面簽名
參與者電子郵件	email	True	string	參與者的電子郵件
Authentication	authenticationMethod		string	預設驗證：電子郵件（無）
密碼	password		string	參與者所需的密碼
國碼 (地區碼)	countryCode		string	收件者的電話國家/地區代碼需要查看和簽署文件
電話號碼	phone		string	檢視和簽署合約所需的收件者電話號碼
訂單	order	True	integer	索引從1開頭，表示簽署群組需要簽署的位置。
Role	role	True	string	參與者集的目前角色（簽署者、核准者等）。
群組名稱/ID	groupId		string	群組的 ID。要使用此 - 需要選擇“以名稱”字段
Message	message		string	傳送給要求其動作的收件者的選用訊息
Email	email		string	協議副本的電子郵件
到期時間	expirationTime		string	協議到期的時間。範例：2020-12-31T23：59：00Z
提醒頻率	reminderFrequency		string	您想多久發送一次提醒？
文件密碼	openPassword		string	應該用來加密已簽署合約的密碼 PDF
名稱	fieldName		string	功能變數名稱
價值觀	defaultValue		string	欄位的預設值
重新導向延遲	redirectDelay		string	使用者進入成功頁面之前的延遲（以秒為單位）。
重新導向網址	redirectUrl		string	完成簽署程序後要重新導向的URL，例如 https://adobe.com
初始電子郵件	initEmails		string	控制合約起始事件的通知郵件。

傳回

包含新建立合約 ID 的 JSON

身體: AgreementCreationResponseV6

擷取簽署 URL

作業識別碼：: GetSigningUrls

此作業會擷取合約目前簽署者的電子簽署頁面 URL。

參數

名稱	機碼	必要	類型	Description
合約標識碼	agreementId	True	string	建立合約之動作所提供的合約識別碼
以	x-api-user		string	API呼叫者的電子郵件格式為：電子郵件：adobesignuser@domain.com

傳回

身體: SigningUrlResponse

根據搜尋條件取得所有合約的清單

作業識別碼：: SearchAgreements

此作業會依工作流程 ID 等條件搜尋合約。

參數

名稱	機碼	類型	Description
以	x-api-user	string	API呼叫者的電子郵件格式為：電子郵件：adobesignuser@domain.com
群組名稱/ID	groupId	string	群組的 ID。要使用此 - 需要選擇“以名稱”字段
工作流程名稱/ID	workflowId	string	從清單中選取自訂工作流程，或輸入自訂工作流程ID。
建立時間	gt	string	允許的最小日期時間。範例：2020-12-31T23：59：00Z
建立時間之前	lt	string	允許的日期時間上限。範例：2023-12-31T23：59：00Z
頁面大小	pageSize	integer	回應頁面中的項目數。預設為：50;最多：500
開始索引	startIndex	integer	要傳回的搜尋結果從 0 開始的第一列（位移）。

傳回

包含使用者合約陣列物件的 JSON

身體: userAgreementListV6

觸發程序

將合約傳送給參與者時	將合約傳送給參與者時觸發新流程。
建立新合約時	建立新合約時觸發新流程。
當事件發生時	在事件發生時觸發新流程。涵蓋所有協議、Mega Sign 和 Web 表單事件。
當合約工作流程成功完成時	當合約工作流程成功完成時觸發新流程
當合約的狀態變更時	當合約的狀態變更時觸發新流程。涵蓋最常見的協議事件，例如創建、完成等。
發生網頁表單合約事件時	當 Web 表單合約事件發生時觸發新流程。涵蓋最常見的協議事件，例如創建、完成等。
發生群組事件時	發生群組事件時觸發新流程。涵蓋所有協議、Mega Sign 和 Web 表單事件。

將合約傳送給參與者時

作業識別碼：: CreateWebhookForAgreementSignatureRequestedEvent

將合約傳送給參與者時觸發新流程。

參數

名稱	機碼	必要	類型	Description
名稱	name	True	string	觸發程式的名稱
Scope	scope	True	string	觸發程式的範圍
合約名稱/ID	resourceId		string	只有在「範圍」為「特定合約」時才指定。從清單中選取合約，或輸入合約 ID。
Subscription	webhookSubscriptionEvents	True	array of string	應觸發流程的事件
包含協議資訊？	includeDetailedInfo		boolean	是否應該在通知中傳送詳細的合約資訊？
包含合約參與者資訊？	includeParticipantsInfo		boolean	是否應該在通知中傳送合約參與者資訊？
包含合約文件資訊？	includeDocumentsInfo		boolean	是否應該在通知中傳送合約文件資訊？

傳回

身體: WebhookPayload

建立新合約時

作業識別碼：: CreateWebhookForAgreementCreatedEvent

建立新合約時觸發新流程。

參數

名稱	機碼	必要	類型	Description
名稱	name	True	string	觸發程式的名稱
Scope	scope	True	string	觸發程式的範圍
Subscription	webhookSubscriptionEvents	True	array of string	應觸發流程的事件
包含協議資訊？	includeDetailedInfo		boolean	是否應該在通知中傳送詳細的合約資訊？
包含合約參與者資訊？	includeParticipantsInfo		boolean	是否應該在通知中傳送合約參與者資訊？

傳回

身體: WebhookPayloadWithoutNextParticipantSet

當事件發生時

作業識別碼：: CreateWebhookGeneric

在事件發生時觸發新流程。涵蓋所有協議、Mega Sign 和 Web 表單事件。

參數

名稱	機碼	必要	類型	Description
名稱	name	True	string	觸發程式的名稱
Scope	scope	True	string	觸發程式的範圍
資源類型	resourceType		string	只有在「範圍」為「特定資源」時才指定。選取應觸發流程的資源類型。
資源識別碼	resourceId		string	只有在「範圍」為「特定資源」時才指定。輸入應觸發流程的合約或大型標誌或網頁表單或群組 ID。
Webhook訂閱事件	webhookSubscriptionEvents	True	array of string	應觸發流程的事件
包含協議資訊？	includeDetailedInfo		boolean	是否應該在通知中傳送詳細的合約資訊？
包含合約參與者資訊？	includeParticipantsInfo		boolean	是否應該在通知中傳送合約參與者資訊？
包含合約文件資訊？	includeDocumentsInfo		boolean	是否應該在通知中傳送合約文件資訊？
包含合約簽署的文件資訊？	includeSignedDocuments		boolean	是否應該在通知中發送協議完成時簽署文件的最終副本？
包括 MegaSign 資訊？	includeDetailedInfo		boolean	是否應該在通知中發送詳細的大型標誌信息？
包含網頁表單資訊？	includeDetailedInfo		boolean	是否應該在通知中傳送詳細的網路表單資訊？
包含網頁表單參與者資訊？	includeParticipantsInfo		boolean	是否應該在通知中傳送網頁表單參與者資訊？
包含 Web 表單文件資訊？	includeDocumentsInfo		boolean	是否應該在通知中傳送網頁表單文件資訊？

傳回

身體: WebhookPayloadGeneric

當合約工作流程成功完成時

作業識別碼：: CreateWebhookForAgreementSignedEvent

當合約工作流程成功完成時觸發新流程

參數

名稱	機碼	必要	類型	Description
名稱	name	True	string	觸發程式的名稱
Scope	scope	True	string	觸發程式的範圍
合約名稱/ID	resourceId		string	只有在「範圍」為「特定合約」時才指定。從清單中選取合約，或輸入合約 ID。
Subscription	webhookSubscriptionEvents	True	array of string	應觸發流程的事件
包含協議資訊？	includeDetailedInfo		boolean	是否應該在通知中傳送詳細的合約資訊？
包含合約參與者資訊？	includeParticipantsInfo		boolean	是否應該在通知中傳送合約參與者資訊？
包含合約文件資訊？	includeDocumentsInfo		boolean	是否應該在通知中傳送合約文件資訊？
包含合約簽署的文件資訊？	includeSignedDocuments		boolean	是否應該在通知中發送協議完成時簽署文件的最終副本？

傳回

身體: WebhookPayloadWithSignedDocument

當合約的狀態變更時

作業識別碼：: CreateWebhookForAgreementStatusUpdated

當合約的狀態變更時觸發新流程。涵蓋最常見的協議事件，例如創建、完成等。

參數

名稱	機碼	必要	類型	Description
名稱	name	True	string	觸發程式的名稱
Scope	scope	True	string	觸發程式的範圍
合約名稱/ID	resourceId		string	只有在「範圍」為「特定合約」時才指定。從清單中選取合約，或輸入合約 ID。
Webhook訂閱事件	webhookSubscriptionEvents	True	array of string	應觸發流程的事件
包含協議資訊？	includeDetailedInfo		boolean	是否應該在通知中傳送詳細的合約資訊？
包含合約參與者資訊？	includeParticipantsInfo		boolean	是否應該在通知中傳送合約參與者資訊？
包含合約文件資訊？	includeDocumentsInfo		boolean	是否應該在通知中傳送合約文件資訊？
包含合約簽署的文件資訊？	includeSignedDocuments		boolean	是否應該在協議完成通知中發送已簽署文件的最終副本？

傳回

身體: WebhookPayloadWithSignedDocumentForStatusChange

發生網頁表單合約事件時

作業識別碼：: CreateWebhookForWebFormAgreementEvent

當 Web 表單合約事件發生時觸發新流程。涵蓋最常見的協議事件，例如創建、完成等。

參數

名稱	機碼	必要	類型	Description
名稱	name	True	string	觸發程式的名稱
網頁表單頁面大小	pageSize		integer	選取要在下拉式清單中顯示的網頁表單數目
網頁表單名稱/ID	resourceId	True	string	從清單中選取網頁表單，或輸入網頁表單ID。
Webhook訂閱事件	webhookSubscriptionEvents	True	array of string	應觸發流程的事件
包含協議資訊？	includeDetailedInfo		boolean	是否應該在通知中傳送詳細的合約資訊？
包含合約參與者資訊？	includeParticipantsInfo		boolean	是否應該在通知中傳送合約參與者資訊？
包含合約文件資訊？	includeDocumentsInfo		boolean	是否應該在通知中傳送合約文件資訊？
包含合約簽署的文件資訊？	includeSignedDocuments		boolean	是否應該在協議完成通知中發送已簽署文件的最終副本？

傳回

身體: WebFormWebhookAgreementEventPayload

發生群組事件時

作業識別碼：: CreateWebhookForGroupEvent

發生群組事件時觸發新流程。涵蓋所有協議、Mega Sign 和 Web 表單事件。

參數

名稱	機碼	必要	類型	Description
名稱	name	True	string	觸發程式的名稱
群組名稱/ID	resourceId		string	群組的ID
Webhook訂閱事件	webhookSubscriptionEvents	True	array of string	應觸發流程的事件
包含協議資訊？	includeDetailedInfo		boolean	是否應該在通知中傳送詳細的合約資訊？
包含合約參與者資訊？	includeParticipantsInfo		boolean	是否應該在通知中傳送合約參與者資訊？
包含合約文件資訊？	includeDocumentsInfo		boolean	是否應該在通知中傳送合約文件資訊？
包含合約簽署的文件資訊？	includeSignedDocuments		boolean	是否應該在通知中發送協議完成時簽署文件的最終副本？
包括 MegaSign 資訊？	includeDetailedInfo		boolean	是否應該在通知中發送詳細的大型標誌信息？
包含網頁表單資訊？	includeDetailedInfo		boolean	是否應該在通知中傳送詳細的網路表單資訊？
包含網頁表單參與者資訊？	includeParticipantsInfo		boolean	是否應該在通知中傳送網頁表單參與者資訊？
包含 Web 表單文件資訊？	includeDocumentsInfo		boolean	是否應該在通知中傳送網頁表單文件資訊？

傳回

身體: GroupWebhookEventPayload

定義

AgreementCreation回應

包含新建立合約 ID 的 JSON

名稱	路徑	類型	Description
合約標識碼	agreementId	string	合約的專屬 ID，可用來查詢狀態和下載已簽署的文件

合約建立回應V6

包含新建立合約 ID 的 JSON

名稱	路徑	類型	Description
合約標識碼	id	string	合約的專屬 ID，可用來查詢狀態和下載已簽署的文件

協議文件

同時包含文件及支援文件陣列物件的 JSON

名稱	路徑	類型	Description
Documents	documents	array of Document	代表文件的物件清單
證明文件	supportingDocuments	array of SupportingDocument	證明文件清單。只有在協議中有任何證明文件時，才會返回此文件

協議文件V6

同時包含文件及支援文件陣列物件的 JSON

名稱	路徑	類型	Description
Documents	documents	array of DocumentV6	代表文件的物件清單
證明文件	supportingDocuments	array of SupportingDocumentV6	證明文件清單。只有在協議中有任何證明文件時，才會返回此文件

協議資訊

有關協議的完整詳細信息

名稱	路徑	類型	Description
合約標識碼	agreementId	string	可用來唯一識別合約的唯一 ID
活動	events	array of DocumentHistoryEvent	本文件稽核追蹤中事件的排序清單
到期日期	expiration	date	無法再簽署合約的日期
最新版本 ID	latestVersionId	string	唯一識別合約目前版本的唯一 ID
Message	message	string	與寄件者所提供的合約相關聯的訊息
合約名稱	name	string	寄件者指定的合約名稱
下一個參與者集	nextParticipantSetInfos	array of NextParticipantSetInfo	有關誰需要針對此協議下一步採取行動的資訊
參與者集	participantSetInfos	array of ParticipantSetInfo	有關本文檔所有參與者集的信息
簽章類型	signatureType	string	指定所要求的簽名類型 - 電子簽名或書面簽名
文件保護	securityOptions	string	文件的安全資訊，指定是否需要密碼才能檢視和簽署文件
地位	status	string	協議的現狀

協議InfoV6

完整的協議詳細信息

名稱	路徑	類型	Description
合約標識碼	id	string	可用來唯一識別合約的唯一 ID
建立日期	createdDate	date	合約的建立日期
第一次提醒延遲	firstReminderDelay	integer	整數，指定傳送第一個提醒之前的延遲時間（以小時為單位）。
提醒頻率	reminderFrequency	string	您想多久發送一次提醒？
到期日期	expiration	date	無法再簽署合約的日期
Locale	locale	string	與此合約相關聯的地區設定 - 例如，en_US或fr_FR
Message	message	string	與寄件者所提供的合約相關聯的訊息
合約名稱	name	string	寄件者指定的合約名稱
文件可見性？	documentVisibilityEnabled	boolean	是否啟用了文檔可見性？
參與者集	participantSetsInfo	array of ParticipantSetInfoV6	有關本文檔所有參與者集的信息
簽章類型	signatureType	string	指定所要求的簽名類型 - 電子簽名或書面簽名
安全性選項	securityOptions	string	文件的安全資訊，指定是否需要密碼才能檢視和簽署文件
地位	status	string	協議的現狀
寄件者電子郵件	senderEmail	string	寄件者的電子郵件
工作流程識別碼	workflowId	string	定義合約路由路徑的自訂工作流程 ID。
抄送	ccs	array of CcInfo	將在合約交易中複製的一或多個副本清單。
群組識別碼	groupId	string	合約所屬群組的唯一識別碼。

CombinedDocument回應

文件的檔案串流

檔案內容: binary

AgreementAuditTrailResponse 回應

合約稽核追蹤的檔案串流

合約稽核追蹤內容: binary

顯示使用者資訊

名稱	路徑	類型	Description
公司	company	string	顯示使用者的公司名稱（如果有的話）
Email	email	string	顯示使用者的電子郵件
全名	fullName	string	顯示使用者的完整名稱（如果有的話）。

顯示使用者設定資訊

名稱	路徑	類型	Description
顯示使用者集資訊	displayUserSetMemberInfos	array of DisplayUserInfo	顯示有關使用者集的資訊
顯示使用者集名稱	displayUserSetName	string

文件

有關文件的信息

名稱	路徑	類型	Description
文件 ID	documentId	string	文件的唯一ID
默劇類型	mimeType	string	文件的 MIME 類型
名稱	name	string	文件的名稱
頁數	numPages	integer	文件中的頁數

文件V6

有關文件的信息

名稱	路徑	類型	Description
文件 ID	id	string	文件的唯一ID
默劇類型	mimeType	string	文件的 MIME 類型
名稱	name	string	文件的名稱
頁數	numPages	integer	文件中的頁數

DocumentHistory事件

名稱	路徑	類型	Description
事件發起人	actingUserEmail	string	發起事件之使用者的電子郵件地址
事件日期	date	date	稽核事件的日期
事件描述	description	string	稽核事件的描述
參與者電子郵件	participantEmail	string	發起事件之使用者的電子郵件地址
事件類型	type	string	合約事件類型

文件庫項目

名稱	路徑	類型	Description
程式庫範本識別碼	libraryDocumentId	string	傳送要簽署的文件時所使用的物件庫文件的唯一 ID
圖庫範本類型	libraryTemplateTypes	array of string	一或多個文件庫範本類型的清單
修改日期	modifiedDate	date	上次修改程式庫範本的日期
程式庫範本名稱	name	string	文件庫範本的名稱
範本分享模式	scope	string	程式庫範本的可見範圍

文件庫項目

包含程式庫範本陣列物件的 JSON

名稱	路徑	類型	Description
「程式庫範本」清單	libraryDocumentList	array of DocumentLibraryItem	文件庫範本項目清單

文件回應

文件的檔案串流

檔案內容: binary

LibraryDocumentCreation回應

描述程式庫範本的 JSON 物件

名稱	路徑	類型	Description
程式庫範本識別碼	libraryDocumentId	string	可用來參照程式庫範本的唯一ID

下一頁參與者資訊

名稱	路徑	類型	Description
Email	email	string	下一位參與者的電子郵件地址
名稱	name	string	下一個參與者的名稱（如果有的話）
等待時間	waitingSince	date	文件自等待參與者採取行動的日期

下一頁參與者設定資訊

名稱	路徑	類型	Description
下一個參與者集成員資訊	nextParticipantSetMemberInfos	array of NextParticipantInfo	有關下一個參與者集成員的信息

參與者資訊

名稱	路徑	類型	Description
公司	company	string	參與者的公司（如果有）
Email	email	string	參與者的電子郵件地址
名稱	name	string	參與者的姓名（如果有的話）
參與者 ID	participantId	string	參與者的唯一 ID
安全性選項	securityOptions	array of string	適用於參與者的安全性選項
Title	title	string	參與者的頭銜（如果有的話）

參與者設定資訊

名稱	路徑	類型	Description
參與者集ID	participantSetId	string	參與者集的唯一ID
參與者集成員資訊	participantSetMemberInfos	array of ParticipantInfo	收件者集成員的相關資訊
私訊	privateMessage	string	給集合參與者的私訊
Role	roles	array of string	參與者集的當前角色。參與者集可以有一或多個角色
安全性選項	securityOptions	array of string	適用於參與者的安全性選項
簽署訂單	signingOrder	integer	索引以 1 開頭，表示該收件人簽名的順序
參與者集狀態	status	string	參與者設定了文件的狀態

參與者集資訊V6

名稱	路徑	類型	Description
參與者集成員資訊	memberInfos	array of MemberInfosV6	收件者集成員的相關資訊
訂單	order	integer	指示簽署群組需要簽署的位置的索引。
Role	role	string	參與者集的目前角色（簽署者、核准者等）。
參與者集名稱	name	string	參與者集的名稱
參與者設定私人訊息	privateMessage	string	給集合參與者的私訊
參與者設定可見頁面	visiblePages	array of string	參與者集可見的頁面

會員資訊V6

名稱	路徑	類型	Description
參與者電子郵件	email	string	參與者的電子郵件
Authentication	securityOption.authenticationMethod	string	預設驗證：電子郵件（無）
密碼	securityOption.password	string	參與者所需的密碼
國碼 (地區碼)	securityOption.phoneInfo.countryCode	string	收件者的電話國家/地區代碼需要查看和簽署文件
電話號碼	securityOption.phoneInfo.phone	string	檢視和簽署合約所需的收件者電話號碼

簽署網址

名稱	路徑	類型	Description
簽署 URL 的電子郵件	email	string	與此簽署 URL 相關聯的簽署者電子郵件地址
簽署網址	esignUrl	string	與此簽署 URL 相關聯的簽署者的 URL 位址

SigningUrl回應

名稱	路徑	類型	Description
簽署者集的 URL 陣列	signingUrlSetInfos	array of SigningUrlSetInfo	此合約中涉及的簽署者集的 URL 陣列

簽署 UrlSetInfo

名稱	路徑	類型	Description
- 簽署 URL 陣列	signingUrls	array of SigningUrl	目前簽署者集的 URL 陣列
- 簽署 URL 集名稱	signingUrlSetName	string	目前簽署者集的名稱

支援文件

有關證明文件的資訊

名稱	路徑	類型	Description
證明文件名稱	displayLabel	string	證明文件的顯示名稱
支援文件欄位名稱	fieldName	string	支援文件欄位的名稱
支援文件 MIME 類型	mimeType	string	支援文件的 MIME 類型
支援文件頁面	numPages	integer	證明文件的頁數
證明文件 ID	supportingDocumentId	string	代表證明文件的唯一 ID

支援DocumentV6

有關證明文件的資訊

名稱	路徑	類型	Description
證明文件名稱	displayLabel	string	證明文件的顯示名稱
支援文件欄位名稱	fieldName	string	支援文件欄位的名稱
支援文件 MIME 類型	mimeType	string	支援文件的 MIME 類型
支援文件頁面	numPages	integer	證明文件的頁數
證明文件 ID	id	string	代表證明文件的唯一 ID

TransientDocument回應

包含已上傳文件 ID 的 JSON

名稱	路徑	類型	Description
文件 ID	transientDocumentId	string	已上傳文件的文件ID

使用者合約

名稱	路徑	類型	Description
合約標識碼	agreementId	string	可用來唯一識別合約的唯一 ID
顯示使用者集資訊	displayUserSetInfos	array of DisplayUserSetInfo	與合約最相關的目前使用者集。如果合約來自目前使用者，則通常是下一個簽署者，如果合約是從其他使用者收到，則通常是寄件者
顯示日期	displayDate	date	合約的顯示日期
簽名	esign	boolean	如果這是電子簽署文件，則為 True
最新版本 ID	latestVersionId	string	唯一識別合約目前版本的版本識別碼
名稱	name	string	協議名稱
地位	status	string	協議的現狀

使用者合約

包含使用者合約陣列物件的 JSON

名稱	路徑	類型	Description
協議清單	userAgreementList	array of UserAgreement	合約專案陣列

使用者協議V6

名稱	路徑	類型	Description
顯示使用者集資訊	displayParticipantSetInfos	array of DisplayUserSetInfo	與合約最相關的目前使用者集。如果合約來自目前使用者，則通常是下一個簽署者，如果合約是從其他使用者收到，則通常是寄件者
顯示日期	displayDate	string	合約的顯示日期
簽名	esign	boolean	如果這是電子簽署文件，則為 True
隱藏	hidden	boolean	如果使用者隱藏合約，則為 True
群組識別碼	groupId	string	群組的唯一識別碼
最新版本 ID	latestVersionId	string	唯一識別合約目前版本的版本識別碼
名稱	name	string	協議名稱
父 ID	parentId	string	megaSign 子項的父 ID 或 Web 表單合約執行個體的原始 ID
合約標識碼	id	string	合約的唯一識別碼
地位	status	string	協議的現狀
類型	type	string	協議的種類

userAgreementListV6 的

包含使用者合約陣列物件的 JSON

名稱	路徑	類型	Description
頁面	page	page	用於瀏覽回應的分頁資訊
協議清單	userAgreementList	array of UserAgreementV6	合約專案陣列

頁面

用於瀏覽回應的分頁資訊

名稱	路徑	類型	Description
next游標	nextCursor	string	用於導航到下一頁。如果未退回，則沒有其他頁面。

Webhook 承載

名稱	路徑	類型	Description
Event	event	string	資源上發生的事件。
事件日期	eventDate	date	活動日期。格式會是 yyyy-MM-dd'T'HH：mm：ssZ。例如，2016-02-25T18：46：19Z 代表 UTC 時間
事件資源類型	eventResourceType	string	發生事件的資源。
合約父類型	eventResourceParentType	string	建立合約之資源的相關資訊。可能的值：Web 表單或 Mega Sign
合約父 ID	eventResourceParentId	string	建立此合約之資源的唯一識別碼
活動參與者角色	participantRole	string	活動參與者的角色。
活動參與者ID	participantUserId	string	活動參與者的 ID。
活動參與者電子郵件	participantUserEmail	string	活動參與者的電子郵件。
事件代理使用者 ID	actingUserId	string	建立事件之使用者的識別碼。
活動代理使用者電子郵件	actingUserEmail	string	建立事件之使用者的電子郵件。
事件執行使用者 IP 位址	actingUserIpAddress	string	建立事件之使用者的 IP 位址
事件起始使用者 ID	initiatingUserId	string	代表代理使用者起始事件的使用者識別碼。
事件起始使用者電子郵件	initiatingUserEmail	string	代表代理使用者起始事件的使用者電子郵件。
通知適用用戶	webhookNotificationApplicableUsers	array of ApplicableUsers	此通知適用的使用者清單
Agreement	agreement	WebhookAgreementInfo	協議完整信息

適用用戶

此通知適用之使用者的相關資訊

名稱	路徑	類型	Description
通知適用的使用者 ID	id	string	此通知適用之使用者的唯一識別碼
通知適用的用戶電子郵件	email	string	此通知適用的使用者的電子郵件
通知適用的使用者角色	role	string	在工作流程中產生此通知的使用者角色
承載是否適用使用者	payloadApplicable	boolean	本通知中提供的資料是否適用於該使用者

WebhookPayloadWithoutNextParticipantSet

名稱	路徑	類型	Description
Event	event	string	資源上發生的事件。
事件日期	eventDate	date	活動日期。格式會是 yyyy-MM-dd'T'HH：mm：ssZ。例如，2016-02-25T18：46：19Z 代表 UTC 時間
事件資源類型	eventResourceType	string	發生事件的資源。
合約父類型	eventResourceParentType	string	建立合約之資源的相關資訊。可能的值：Web 表單或 Mega Sign
合約父 ID	eventResourceParentId	string	建立此合約之資源的唯一識別碼
活動參與者ID	participantUserId	string	活動參與者的 ID。
活動參與者電子郵件	participantUserEmail	string	活動參與者的電子郵件。
事件代理使用者 ID	actingUserId	string	建立事件之使用者的識別碼。
活動代理使用者電子郵件	actingUserEmail	string	建立事件之使用者的電子郵件。
事件執行使用者 IP 位址	actingUserIpAddress	string	建立事件之使用者的 IP 位址
事件起始使用者 ID	initiatingUserId	string	代表代理使用者起始事件的使用者識別碼
事件起始使用者電子郵件	initiatingUserEmail	string	代表代理使用者起始事件的使用者電子郵件。
通知適用用戶	webhookNotificationApplicableUsers	array of ApplicableUsers	此通知適用的使用者清單
Agreement	agreement	WebhookAgreementInfoWithoutNextParticipantSet	協議完整信息

WebhookPayloadWithSignedDocumentForStatusChange

名稱	路徑	類型	Description
Event	event	string	資源上發生的事件。
事件日期	eventDate	date	活動日期。格式會是 yyyy-MM-dd'T'HH：mm：ssZ。例如，2016-02-25T18：46：19Z 代表 UTC 時間
子活動	subEvent	string	資源上發生的子事件。
合約父類型	eventResourceParentType	string	建立合約之資源的相關資訊。可能的值：Web 表單或 Mega Sign
合約父 ID	eventResourceParentId	string	建立此合約之資源的唯一識別碼
活動參與者ID	participantUserId	string	活動參與者的 ID。
活動參與者電子郵件	participantUserEmail	string	活動參與者的電子郵件。
事件代理使用者 ID	actingUserId	string	建立事件之使用者的識別碼。
活動代理使用者電子郵件	actingUserEmail	string	建立事件之使用者的電子郵件。
事件執行使用者 IP 位址	actingUserIpAddress	string	建立事件之使用者的 IP 位址
動作類型	actionType	string	發生事件的動作。
事件起始使用者 ID	initiatingUserId	string	代表代理使用者起始事件的使用者識別碼
事件起始使用者電子郵件	initiatingUserEmail	string	代表代理使用者起始事件的使用者電子郵件。
事件資源類型	eventResourceType	string	發生事件的資源。
活動參與者角色	participantRole	string	活動參與者的角色。
通知適用用戶	webhookNotificationApplicableUsers	array of ApplicableUsers	此通知適用的使用者清單
Agreement	agreement	WebhookAgreementInfoWithSignedDocument	協議完整信息

WebhookPayloadWithSignedDocument

名稱	路徑	類型	Description
Event	event	string	資源上發生的事件。
事件日期	eventDate	date	活動日期。格式會是 yyyy-MM-dd'T'HH：mm：ssZ。例如，2016-02-25T18：46：19Z 代表 UTC 時間
合約父類型	eventResourceParentType	string	建立合約之資源的相關資訊。可能的值：Web 表單或 Mega Sign
合約父 ID	eventResourceParentId	string	建立此合約之資源的唯一識別碼
事件資源類型	eventResourceType	string	發生事件的資源。
活動參與者角色	participantRole	string	活動參與者的角色。
活動參與者ID	participantUserId	string	活動參與者的 ID。
活動參與者電子郵件	participantUserEmail	string	活動參與者的電子郵件。
事件代理使用者 ID	actingUserId	string	建立事件之使用者的識別碼。
活動代理使用者電子郵件	actingUserEmail	string	建立事件之使用者的電子郵件。
事件執行使用者 IP 位址	actingUserIpAddress	string	建立事件之使用者的 IP 位址
事件起始使用者 ID	initiatingUserId	string	代表代理使用者起始事件的使用者識別碼
事件起始使用者電子郵件	initiatingUserEmail	string	代表代理使用者起始事件的使用者電子郵件。
通知適用用戶	webhookNotificationApplicableUsers	array of ApplicableUsers	此通知適用的使用者清單
Agreement	agreement	WebhookAgreementInfoWithSignedDocument	協議完整信息

Webhook PayloadGeneric

名稱	路徑	類型	Description
Event	event	string	資源上發生的事件。
事件日期	eventDate	date	活動日期。格式會是 yyyy-MM-dd'T'HH：mm：ssZ。例如，2016-02-25T18：46：19Z 代表 UTC 時間
子活動	subEvent	string	資源上發生的子事件。
合約父類型	eventResourceParentType	string	建立合約之資源的相關資訊。可能的值：Web 表單或 Mega Sign
合約父 ID	eventResourceParentId	string	建立此合約之資源的唯一識別碼
事件資源類型	eventResourceType	string	發生事件的資源。
活動參與者角色	participantRole	string	活動參與者的角色。
活動參與者ID	participantUserId	string	活動參與者的 ID。
活動參與者電子郵件	participantUserEmail	string	活動參與者的電子郵件。
事件代理使用者 ID	actingUserId	string	建立事件之使用者的識別碼。
活動代理使用者電子郵件	actingUserEmail	string	建立事件之使用者的電子郵件。
事件起始使用者 ID	initiatingUserId	string	代表代理使用者起始事件的使用者識別碼
事件起始使用者電子郵件	initiatingUserEmail	string	代表代理使用者起始事件的使用者電子郵件。
動作類型	actionType	string	發生事件的動作。
事件執行使用者 IP 位址	actingUserIpAddress	string	建立事件之使用者的 IP 位址
通知適用用戶	webhookNotificationApplicableUsers	array of ApplicableUsers	此通知適用的使用者清單
Agreement	agreement	WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo	協議完整信息
超級標誌	megaSign	WebhookMegaSignInfo	巨型標誌的完整信息
網頁表單	widget	WebhookWidgetInfo	網路表單的完整資訊

WebFormWebhookAgreementEvent承載

名稱	路徑	類型	Description
Event	event	string	網路表單上發生的合約事件。
事件日期	eventDate	date	活動日期。格式會是 yyyy-MM-dd'T'HH：mm：ssZ。例如，2016-02-25T18：46：19Z 代表 UTC 時間
子活動	subEvent	string	網頁表單上發生的子事件。
合約父類型 - Web 表單	eventResourceParentType	string	指出合約是從網路表單建立的值。
網頁表單ID	eventResourceParentId	string	建立此合約之網路表單的唯一識別碼
事件資源類型 - 合約	eventResourceType	string	發生事件的資源。
活動參與者角色	participantRole	string	活動參與者的角色。
活動參與者ID	participantUserId	string	活動參與者的 ID。
活動參與者電子郵件	participantUserEmail	string	活動參與者的電子郵件。
事件代理使用者 ID	actingUserId	string	建立事件之使用者的識別碼。
活動代理使用者電子郵件	actingUserEmail	string	建立事件之使用者的電子郵件。
事件起始使用者 ID	initiatingUserId	string	代表代理使用者起始事件的使用者識別碼
事件起始使用者電子郵件	initiatingUserEmail	string	代表代理使用者起始事件的使用者電子郵件。
動作類型	actionType	string	發生事件的動作。
事件執行使用者 IP 位址	actingUserIpAddress	string	建立事件之使用者的 IP 位址
通知適用用戶	webhookNotificationApplicableUsers	array of ApplicableUsers	此通知適用的使用者清單
Agreement	agreement	WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo	協議完整信息

GroupWebhookEvent承載

名稱	路徑	類型	Description
Event	event	string	群組發生的事件。
事件日期	eventDate	date	活動日期。格式會是 yyyy-MM-dd'T'HH：mm：ssZ。例如，2016-02-25T18：46：19Z 代表 UTC 時間
子活動	subEvent	string	群組發生的子事件。
合約父類型 - Web 表單	eventResourceParentType	string	建立合約之群組的相關資訊。
網頁表單ID	eventResourceParentId	string	建立此合約之群組的唯一識別碼
事件資源類型 - 合約	eventResourceType	string	發生事件的群組。
活動參與者角色	participantRole	string	活動參與者的角色。
活動參與者ID	participantUserId	string	活動參與者的 ID。
活動參與者電子郵件	participantUserEmail	string	活動參與者的電子郵件。
事件代理使用者 ID	actingUserId	string	建立事件之使用者的識別碼。
活動代理使用者電子郵件	actingUserEmail	string	建立事件之使用者的電子郵件。
事件起始使用者 ID	initiatingUserId	string	代表代理使用者起始事件的使用者識別碼
事件起始使用者電子郵件	initiatingUserEmail	string	代表代理使用者起始事件的使用者電子郵件。
動作類型	actionType	string	發生事件的動作。
事件執行使用者 IP 位址	actingUserIpAddress	string	建立事件之使用者的 IP 位址
通知適用用戶	webhookNotificationApplicableUsers	array of ApplicableUsers	此通知適用的使用者清單
Agreement	agreement	WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo	協議完整信息
超級標誌	megaSign	WebhookMegaSignInfo	巨型標誌的完整信息
網頁表單	widget	WebhookWidgetInfo	網路表單的完整資訊

Webhook協議資訊

協議完整信息

名稱	路徑	類型	Description
ID	id	string	合約的唯一ID
名稱	name	string	合約的名稱
簽章類型	signatureType	string	指定所要求的簽名類型 - 電子簽名或書面簽名
地位	status	string	協議的現狀
抄送	ccs	array of CcInfo	將在合約交易中複製的一或多個副本清單。
建立日期	createdDate	date	合約的建立日期
到期時間	expirationTime	string	協議到期且需要在協議之前簽署的時間
外部 ID	externalId.id	string	來自系統的任意值，可以在傳送時指定，然後稍後傳回或查詢
外部群組	externalId.group	string	來自系統的任意值，可以在傳送時指定，然後稍後傳回或查詢
第一次提醒延遲	firstReminderDelay	integer	整數，指定傳送第一個提醒之前的延遲時間（以小時為單位）。
Locale	locale	string	與本合約相關聯的地區設定
Message	message	string	給參與者的可選訊息，說明要傳送的內容或為什麼需要簽名
提醒頻率	reminderFrequency	string	選擇性參數，可設定您要傳送提醒給參與者的頻率。如果未指定，則會使用為帳戶設定的預設頻率
寄件者電子郵件	senderEmail	string	合約寄件者的電子郵件
已啟用保管庫？	vaultingInfo.enabled	boolean	對於針對文件保存而設定的帳戶，以及每個合約啟用的選項，這會決定是否要保存文件
文件可見性？	documentVisibilityEnabled	boolean	是否啟用文件可見度
工作流程識別碼	workflowId	string	定義合約路由路徑的自訂工作流程 ID。
後簽名重定向 URL	postSignOption.redirectUrl	string	成功完成簽署程序後，使用者將被傳送到的可公開存取的 URL
參與者集	participantSetsInfo.participantSets	array of WebhookParticipantSets	參與者設定資訊
下一個參與者集	participantSetsInfo.nextParticipantSets	array of WebhookParticipantSets	下一位參與者設定資訊
Documents	documentsInfo.documents	array of WebhookDocument	代表文件的物件清單
證明文件	documentsInfo.supportingDocuments	array of WebhookSupportingDocument	證明文件清單

WebhookAgreementInfoWithoutNextParticipantSet

協議完整信息

名稱	路徑	類型	Description
ID	id	string	合約的唯一ID
名稱	name	string	合約的名稱
簽章類型	signatureType	string	指定所要求的簽名類型 - 電子簽名或書面簽名
地位	status	string	協議的現狀
抄送	ccs	array of CcInfo	將在合約交易中複製的一或多個副本清單。
建立日期	createdDate	date	合約的建立日期
文件可見性？	documentVisibilityEnabled	boolean	是否啟用文件可見度
到期時間	expirationTime	string	協議到期且需要在協議之前簽署的時間
外部 ID	externalId.id	string	來自系統的任意值，可以在傳送時指定，然後稍後傳回或查詢
外部群組	externalId.group	string	來自系統的任意值，可以在傳送時指定，然後稍後傳回或查詢
第一次提醒延遲	firstReminderDelay	integer	整數，指定傳送第一個提醒之前的延遲時間（以小時為單位）。
Locale	locale	string	與本合約相關聯的地區設定
Message	message	string	給參與者的可選訊息，說明要傳送的內容或為什麼需要簽名
提醒頻率	reminderFrequency	string	選擇性參數，可設定您要傳送提醒給參與者的頻率。如果未指定，則會使用為帳戶設定的預設頻率
寄件者電子郵件	senderEmail	string	合約寄件者的電子郵件
已啟用保管庫？	vaultingInfo.enabled	boolean	對於針對文件保存而設定的帳戶，以及每個合約啟用的選項，這會決定是否要保存文件
後簽名重定向 URL	postSignOption.redirectUrl	string	成功完成簽署程序後，使用者將被傳送到的可公開存取的 URL
工作流程識別碼	workflowId	string	定義合約路由路徑的自訂工作流程 ID。
參與者集	participantSetsInfo.participantSets	array of WebhookParticipantSets	參與者設定資訊

WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo

協議完整信息

名稱	路徑	類型	Description
ID	id	string	合約的唯一ID
名稱	name	string	合約的名稱
簽章類型	signatureType	string	指定所要求的簽名類型 - 電子簽名或書面簽名
地位	status	string	協議的現狀
抄送	ccs	array of CcInfo	將在合約交易中複製的一或多個副本清單。
建立日期	createdDate	date	合約的建立日期
到期時間	expirationTime	string	協議到期且需要在協議之前簽署的時間
外部 ID	externalId.id	string	來自系統的任意值，可以在傳送時指定，然後稍後傳回或查詢
外部群組	externalId.group	string	來自系統的任意值，可以在傳送時指定，然後稍後傳回或查詢
第一次提醒延遲	firstReminderDelay	integer	整數，指定傳送第一個提醒之前的延遲時間（以小時為單位）。
Locale	locale	string	與本合約相關聯的地區設定
Message	message	string	給參與者的可選訊息，說明要傳送的內容或為什麼需要簽名
提醒頻率	reminderFrequency	string	選擇性參數，可設定您要傳送提醒給參與者的頻率。如果未指定，則會使用為帳戶設定的預設頻率
後簽名重定向 URL	postSignOption.redirectUrl	string	成功完成簽署程序後，使用者將被傳送到的可公開存取的 URL
工作流程識別碼	workflowId	string	定義合約路由路徑的自訂工作流程 ID。
寄件者電子郵件	senderEmail	string	合約寄件者的電子郵件
文件可見性？	documentVisibilityEnabled	boolean	是否啟用文件可見度
已啟用保管庫？	vaultingInfo.enabled	boolean	對於針對文件保存而設定的帳戶，以及每個合約啟用的選項，這會決定是否要保存文件
參與者集	participantSetsInfo.participantSets	array of WebhookParticipantSets	參與者設定資訊
下一個參與者集	participantSetsInfo.nextParticipantSets	array of WebhookParticipantSets	下一位參與者設定資訊
Documents	documentsInfo.documents	array of WebhookDocument	代表文件的物件清單
證明文件	documentsInfo.supportingDocuments	array of WebhookSupportingDocument	證明文件清單只有在合約中有任何證明文件時才會傳回
簽署文件資訊	signedDocumentInfo.document	string	已簽署文件的 base64 編碼字串

WebhookAgreementInfoWithSignedDocument

協議完整信息

名稱	路徑	類型	Description
ID	id	string	合約的唯一ID
名稱	name	string	合約的名稱
簽章類型	signatureType	string	指定所要求的簽名類型 - 電子簽名或書面簽名
地位	status	string	協議的現狀
抄送	ccs	array of CcInfo	將在合約交易中複製的一或多個副本清單
建立日期	createdDate	date	合約的建立日期
文件可見性？	documentVisibilityEnabled	boolean	是否啟用文件可見度
到期時間	expirationTime	string	協議到期且需要在協議之前簽署的時間
外部 ID	externalId.id	string	來自系統的任意值，可以在傳送時指定，然後稍後傳回或查詢
外部群組	externalId.group	string	來自系統的任意值，可以在傳送時指定，然後稍後傳回或查詢
第一次提醒延遲	firstReminderDelay	integer	整數，指定傳送第一個提醒之前的延遲時間（以小時為單位）。
Locale	locale	string	與本合約相關聯的地區設定
Message	message	string	給參與者的可選訊息，說明要傳送的內容或為什麼需要簽名
提醒頻率	reminderFrequency	string	選擇性參數，可設定您要傳送提醒給參與者的頻率。如果未指定，則會使用為帳戶設定的預設頻率
寄件者電子郵件	senderEmail	string	合約寄件者的電子郵件
已啟用保管庫？	vaultingInfo.enabled	boolean	對於針對文件保存而設定的帳戶，以及每個合約啟用的選項，這會決定是否要保存文件
後簽名重定向 URL	postSignOption.redirectUrl	string	成功完成簽署程序後，使用者將被傳送到的可公開存取的 URL
工作流程識別碼	workflowId	string	定義合約路由路徑的自訂工作流程 ID。
參與者集	participantSetsInfo.participantSets	array of WebhookParticipantSets	參與者設定資訊
Documents	documentsInfo.documents	array of WebhookDocument	代表文件的物件清單
證明文件	documentsInfo.supportingDocuments	array of WebhookSupportingDocument	證明文件清單只有在合約中有任何證明文件時才會傳回
簽署文件資訊	signedDocumentInfo.document	string	已簽署文件的 base64 編碼字串

WebhookMegaSignInfo

巨型標誌的完整信息

名稱	路徑	類型	Description
ID	id	string	大型標牌的唯一 ID
名稱	name	string	巨型標誌的名稱
地位	status	string	巨型標誌的地位
抄送	ccs	array of MegaSignCcInfo	您要在此大型標誌上複製的一或多個電子郵件地址清單。
外部 ID	externalId.id	string	來自系統的任意值，可以在傳送時指定，然後稍後傳回或查詢
第一次提醒延遲	firstReminderDelay	integer	整數，指定傳送第一個提醒之前的延遲時間（以小時為單位）。
Locale	locale	string	與本合約相關聯的地區設定
Message	message	string	給參與者的可選訊息，說明要傳送的內容或為什麼需要簽名
後簽名重定向 URL	postSignOption.redirectUrl	string	成功完成簽署程序後，使用者將被傳送到的可公開存取的 URL
寄件者電子郵件	senderEmail	string	大型標誌創建者的電子郵件
簽章類型	signatureType	string	指定所要求的簽名類型 - 電子簽名或書面簽名
已啟用保管庫？	vaultingInfo.enabled	boolean	對於針對文件保存而設定的帳戶，以及每個合約啟用的選項，這會決定是否要保存文件
子合約檔案資訊	childAgreementsInfo.fileInfo	MegaSignChildAgreementsFileInfo	檔案資訊包含 megaSign 的每個子協議資訊。

WebhookWidgetInfo

網路表單的完整資訊

名稱	路徑	類型	Description
ID	id	string	網頁表單的唯一ID
名稱	name	string	網路表單的名稱
地位	status	string	網路表單的狀態
驗證失敗資訊	authFailureInfo	AuthFailureWidgetRedirectionInfo	錯誤頁面的URL和相關屬性，驗證失敗後，網頁表單簽署者將被採用
抄送	ccs	array of WidgetCcInfo	您要在此網頁表單上複製的一或多個電子郵件地址清單。
建立日期	createdDate	date	建立網頁表單的日期
完成資訊	completionInfo	WidgetCompletionRedirectionInfo	成功頁面的URL和相關屬性網頁表單簽署者在網頁表單上執行所需動作後將前往
創作者電子郵件	creatorEmail	string	網路表單建立者的電子郵件
已啟用保管庫？	vaultingInfo.enabled	boolean	對於針對文件保存而設定的帳戶，以及每個合約啟用的選項，這會決定是否要保存文件
其他參與者集資訊	participantSetsInfo.additionalParticipantSets	array of WidgetParticipantSetInfo	網路表單中除網路表單簽署者之外的所有參與者清單
第一個參與者設定角色	participantSetsInfo.widgetParticipantSet.role	string	集合中所有參與者（簽署者、核准者等）所擔任的角色
第一個參與者設定順序	participantSetsInfo.widgetParticipantSet.order	integer	指示循序簽署群組的索引（指定用於混合式遞送）
Documents	documentsInfo.documents	array of WidgetWebhookDocument	代表文件的物件清單

AuthFailureWidget重新導向資訊

錯誤頁面的URL和相關屬性，驗證失敗後，網頁表單簽署者將被採用

名稱	路徑	類型	Description
身份驗證失敗重定向延遲	delay	integer	使用者進入產生頁面之前的延遲（以秒為單位）
身份驗證失敗重定向解幀	deframe	boolean	如果deframe為false，則產生的頁面將顯示在網頁表單框架內
驗證失敗重新導向 URL	url	string	成功完成網頁表單後，使用者將被傳送到的可公開存取的 URL

WidgetCompletion重新導向資訊

成功頁面的URL和相關屬性網頁表單簽署者在網頁表單上執行所需動作後將前往

名稱	路徑	類型	Description
完成重新導向延遲	delay	integer	使用者進入產生頁面之前的延遲（以秒為單位）
完成重定向解構	deframe	boolean	如果deframe為false，則產生的頁面將顯示在網頁表單框架內
完成重新導向 URL	url	string	成功完成網頁表單後，使用者將被傳送到的可公開存取的 URL

WebhookParticipantSets

名稱	路徑	類型	Description
會員資訊	memberInfos	array of MemberInfos	有關參與者成員的信息
訂單	order	integer	指示簽署群組需要簽署的位置的索引。
Role	role	string	集合中所有參與者（簽署者、核准者等）所擔任的角色
地位	status	string	從使用者角度看合約的現況
ID	id	string	參與者集的ID
名稱	name	string	參與者集的名稱
私訊	privateMessage	string	給集合參與者的私訊

MegaSignChildAgreements檔案資訊

檔案資訊包含 megaSign 的每個子協議資訊。

名稱	路徑	類型	Description
子合約檔案 ID	childAgreementsInfoFileId	string	檔案的 ID，其中包含 megaSign 現有 childAgreementsInfo 的相關資訊。

WidgetWebhook文件

有關網路表單文件的資訊

名稱	路徑	類型	Description
ID	id	string	文件的唯一ID
名稱	name	string	文件的名稱

Webhook文件

有關協議文件的信息

名稱	路徑	類型	Description
ID	id	string	文件的唯一ID
名稱	name	string	文件的名稱

Webhook支援文件

有關證明文件的資訊

名稱	路徑	類型	Description
名稱	displayLabel	string	證明文件的顯示名稱
欄位名稱	fieldName	string	支援文件欄位的名稱
ID	id	string	代表證明文件的唯一 ID

小部件 CcInfo

有關網頁表單副本的資訊

名稱	路徑	類型	Description
Email	email	string	網路表單副本參與者的電子郵件

兆環Cc資訊

關於巨型標誌 CC 的信息

名稱	路徑	類型	Description
Email	email	string	大型標誌的 CC 參與者的電子郵件

CC資訊

有關協議的 CC 的信息

名稱	路徑	類型	Description
Email	email	string	協議副本的電子郵件
標籤	label	string	工作流程說明中傳回的副本清單標籤
可見頁面	visiblePages	array of string	副本可見的頁面

WidgetParticipantSetInfo

名稱	路徑	類型	Description
Role	role	string	集合中所有參與者（簽署者、核准者等）所擔任的角色
ID	id	string	參與者集的唯一識別碼
會員資訊	memberInfos	array of MemberInfos	有關參與者成員的信息
訂單	order	integer	指示循序簽署群組的索引（指定用於混合式遞送）

會員資訊

名稱	路徑	類型	Description
ID	id	string	參與者的唯一識別碼
Email	email	string	參與者的電子郵件
公司	company	string	參與者的公司
名稱	name	string	參與者的姓名
私訊	privateMessage	string	參與者的私訊
地位	status	string	參與者的狀態

LibraryDocumentCreationResponseV6 的檔案庫

描述程式庫範本的 JSON 物件

名稱	路徑	類型	Description
程式庫範本識別碼	id	string	可用來參照程式庫範本的唯一ID

圖書館文件

名稱	路徑	類型	Description
程式庫範本識別碼	id	string	用來參照程式庫範本的唯一識別碼
隱藏	hidden	boolean	如果隱藏「文件庫文件」，則為 True
範本類型	templateTypes	array of string	一或多個文件庫範本類型的清單
修改日期	modifiedDate	date	上次修改程式庫範本的日期
程式庫範本名稱	name	string	文件庫範本的名稱
範本分享模式	sharingMode	string	程式庫範本的可見範圍
創作者電子郵件	creatorEmail	string	文件庫文件建立者的電子郵件地址。
群組識別碼	groupId	string	程式庫範本所屬群組的唯一識別碼。
地位	status	string	文件庫文件的狀態

圖書館文件

包含程式庫範本陣列物件的 JSON

名稱	路徑	類型	Description
頁面	page	page	用於瀏覽回應的分頁資訊
「程式庫範本」清單	libraryDocumentList	array of LibraryDocument	文件庫範本項目清單

使用者小工具V6

名稱	路徑	類型	Description
網頁表單ID	id	string	網頁表單的唯一識別碼
修改日期	modifiedDate	string	上次修改網頁表單的日期
隱藏	hidden	boolean	如果使用者隱藏合約，則為 True
群組識別碼	groupId	string	群組的唯一識別碼
名稱	name	string	網路表單的名稱
地位	status	string	網頁表單狀態
網址	url	string	網頁表單的託管網址
Javascript的	javascript	string	網頁表單的內嵌javascript程式碼

userWidgetListV6

包含使用者網頁表單陣列物件的JSON

名稱	路徑	類型	Description
頁面	page	page	用於瀏覽回應的分頁資訊
網頁表單清單	userWidgetList	array of UserWidgetV6	Web 表單項目陣列

使用者工作流程V6

名稱	路徑	類型	Description
工作流程識別碼	id	string	工作流程的唯一識別碼
Description	description	string	建立時為此工作流程提供的說明
建立日期	created	string	建立工作流程的日期。格式為 yyyy-MM-dd'T'HH：mm：ssZ
修改日期	modified	string	修改工作流程的日期。格式為 yyyy-MM-dd'T'HH：mm：ssZ
名稱	name	string	工作流程的名稱
顯示名稱	displayName	string	工作流程的顯示名稱
地位	status	string	工作流程狀態
Scope	scope	string	工作流程範圍
發起人 ID	originatorId	string	工作流程的初始始作端
範圍識別碼	scopeId	string	範圍的識別碼。目前它僅適用於範圍 GROUP，值將是 groupId。

使用者工作流程清單V6

包含使用者工作流程陣列物件的 JSON

名稱	路徑	類型	Description
工作流程清單	userWorkflowList	array of UserWorkflowV6	工作流程項目陣列

WorkflowDefaultParamsV6

包含工作流程預設參數物件的 JSON

名稱	路徑	類型	Description
預設值	defaultValue	string	如果未提供此欄位的輸入，且此欄位是必填欄位，則欄位的預設值
可編輯	editable	boolean	是否可以編輯目前欄位。如果此欄位的可編輯屬性為false，則不應在合約建立請求中提供此欄位，且此欄位的預設值將用於合約建立
為必填項目	required	boolean	此欄位是必填欄位還是選用欄位
可見	visible	boolean	目前欄位是否可見。如果此欄位的可見屬性為 false，則使用此工作流程的合約建立 UI 中不應顯示此欄位對使用者

CCsListInfo說明V6

包含工作流程詳細資訊的 JSON

名稱	路徑	類型	Description
預設值	defaultValues	array of string	如果未為此清單元素提供輸入，則將使用的預設電子郵件陣列
可編輯	editable	boolean	是否可以編輯目前欄位。如果此欄位的可編輯屬性為false，則不應在合約建立請求中提供此欄位，且此欄位的預設值將用於合約建立
標籤	label	string	工作流程使用者的顯示文字，可用於目前的副本清單
CC 項目數上限	maxListCount	integer	目前副本清單中允許的項目數目上限
最小抄送條目	minListCount	integer	目前副本清單中允許的最小條目數
副本清單名稱	name	string	目前副本清單的名稱
為必填項目	required	boolean	此欄位是必填欄位還是選用欄位
可見	visible	boolean	目前欄位是否可見。如果此欄位的可見屬性為 false，則使用此工作流程的合約建立頁面中不應顯示此欄位

ExpirationFieldInfoDescriptionV6

包含到期相關資訊的 JSON

名稱	路徑	類型	Description
預設值	defaultValue	string	如果未提供此欄位的輸入，且此欄位是必填欄位，則欄位的預設值
可編輯	editable	boolean	是否可以編輯目前欄位。如果此欄位的可編輯屬性為false，則不應在合約建立請求中提供此欄位，且此欄位的預設值將用於合約建立
合約到期天數上限	maxDays	integer	合約到期的天數上限
為必填項目	required	boolean	此欄位是必填欄位還是選用欄位
可見	visible	boolean	目前欄位是否可見。如果此欄位的可見屬性為 false，則使用此工作流程的合約建立頁面中不應顯示此欄位

檔案資訊說明V6

包含檔案相關資訊的 JSON

名稱	路徑	類型	Description
標籤	label	string	此欄位的標籤供外部使用者使用
名稱	name	string	fileInfo 元素的名稱
為必填項目	required	boolean	此欄位是必填欄位還是選用欄位
工作流程資料庫文件	workflowLibraryDocumentSelectorList	array of WorkflowLibraryDocumentV6	工作流程程式庫文件清單，可使用此 fileInfo 物件從中選取一個工作流程程式庫文件

工作流程庫文件V6

包含工作流程程式庫文件相關資訊的 JSON

名稱	路徑	類型	Description
標籤	label	string	此表單的顯示文字供工作流程使用者使用
修改日期	modifiedDate	string	上次修改文件庫文件的日期。格式會是 yyyy-MM-dd'T'HH：mm：ssZ。例如，2016-02-25T18：46：19Z 代表 UTC 時間
共享模式	sharingMode	string	指定誰應該有權存取此文件庫文件。 GLOBAL 共用是受限制的作業
範本類型	templateTypes	array of	一或多個文件庫範本類型的清單
工作流程程式庫文件識別碼	workflowLibDoc	string	工作流程程式庫文件的 ID，可在自訂工作流程合約建立要求中作為輸入檔案提供

LocaleFieldInfoDescriptionV6

包含工作流程地區設定詳細資訊的 JSON

名稱	路徑	類型	Description
可用的地區設定	availableLocales	array of string	可為此工作流程選擇哪些地區設定
預設值	defaultValue	string	如果未提供此欄位的輸入，且此欄位是必填欄位，則欄位的預設值
可編輯	editable	boolean	是否可以編輯目前欄位。如果此欄位的可編輯屬性為false，則不應在合約建立請求中提供此欄位，且此欄位的預設值將用於合約建立
為必填項目	required	boolean	此欄位是必填欄位還是選用欄位
可見	visible	boolean	目前欄位是否可見。如果此欄位的可見屬性為 false，則使用此工作流程的合約建立 UI 中不應顯示此欄位對使用者

MergeFieldInfoDescriptionV6

包含合併欄位詳細資訊的 JSON

名稱	路徑	類型	Description
預設值	defaultValue	string	如果未提供此欄位的輸入，且此欄位是必填欄位，則欄位的預設值
顯示名稱	displayName	string	可針對此自訂欄位顯示的顯示文字
可編輯	editable	boolean	是否可以編輯目前欄位。如果此欄位的可編輯屬性為false，則不應在合約建立請求中提供此欄位，且此欄位的預設值將用於合約建立
自訂欄位名稱	fieldName	string	此工作流程中自訂欄位的名稱
為必填項目	required	boolean	此欄位是必填欄位還是選用欄位
可見	visible	boolean	目前欄位是否應在合約建立頁面上顯示。如果此欄位的可見屬性為 false，則使用此工作流程不應將此欄位顯示在合約建立頁面上

PasswordFieldInfo說明V6

包含密碼詳細資訊的 JSON

名稱	路徑	類型	Description
密碼	defaultValue	string	密碼資訊欄位的預設值
可編輯	editable	boolean	是否可以編輯目前欄位。如果此欄位的可編輯屬性為false，則不應在合約建立請求中提供此欄位，且此欄位的預設值將用於合約建立
標籤	label	string	密碼欄位的標籤
名稱	name	string	密碼欄位名稱
為必填項目	required	boolean	此欄位是必填欄位還是選用欄位
可見	visible	boolean	密碼資訊欄位是否顯示在合約建立頁面上

收件者清單資訊說明V6

包含收件者清單詳細資訊的JSON。

名稱	路徑	類型	Description
允許寄件者	allowSender	boolean	是否允許寄件者做為收件者
允許寄件者	allowfax	boolean	是否允許傳真
驗證方法	authenticationMethod	string	目前收件者清單有權檢視和簽署文件的驗證方法，
預設電子郵件/傳真值	defaultValue	string	預設電子郵件或傳真號碼
可編輯	editable	boolean	是否可以編輯目前欄位。如果此欄位的可編輯屬性為false，則不應在合約建立請求中提供此欄位，且此欄位的預設值將用於合約建立
標籤	label	string	工作流程使用者的顯示文字，可用於目前收件者清單
收件者人數上限	maxListCount	integer	目前收件者清單中允許的項目數目上限
最少收件者	minListCount	integer	目前收件者清單中允許的最小項目數
收件人資訊清單的名稱	name	string	目前收件者資訊清單的名稱
參與者角色	role	string	參與者的當前角色
可見	visible	boolean	目前欄位是否可見。如果此欄位的可見屬性為 false，則使用此工作流程的合約建立 UI 中不應顯示此欄位給使用者

工作流程說明V6

包含工作流程詳細資訊的 JSON

名稱	路徑	類型	Description
合約名稱資訊	agreementNameInfo	WorkflowDefaultParamsV6	包含工作流程預設參數物件的 JSON
authoringInfo	authoringInfo	WorkflowDefaultParamsV6	包含工作流程預設參數物件的 JSON
抄送清單資訊	ccsListInfo	array of CCsListInfoDescriptionV6	合約建立請求中副本清單輸入欄位的相關資訊
工作流程建立日期	created	string	建立工作流程的日期
工作流程說明	description	string	建立時為此工作流程提供的說明
工作流程顯示名稱	displayName	string	工作流程的顯示名稱
到期資訊	expirationInfo	ExpirationFieldInfoDescriptionV6	包含到期相關資訊的 JSON
檔案資訊	fileInfos	array of FileInfosDescriptionV6	合約建立請求中檔案資訊輸入欄位的相關資訊
地區資訊	localeInfo	LocaleFieldInfoDescriptionV6	包含工作流程地區設定詳細資訊的 JSON
合併欄位資訊	mergeFieldsInfo	array of MergeFieldInfoDescriptionV6	合約建立請求中自訂資訊輸入欄位的相關資訊
訊息資訊	messageInfo	WorkflowDefaultParamsV6	包含工作流程預設參數物件的 JSON
修改日期	modified	string	上次修改工作流程的日期
工作流程名稱	name	string	工作流程的名稱
密碼資訊	passwordInfo	PasswordFieldInfoDescriptionV6	包含密碼詳細資訊的 JSON
收件者清單資訊	recipientsListInfo	array of RecipientsListInfoDescriptionV6	合約建立要求中收貨人資訊輸入欄位的相關資訊
工作流程範圍	scope	string	工作流程範圍
工作流程狀態	status	string	工作流程狀態
工作流程發起人 ID	originatorId	string	工作流程的初始始作端
工作流程範圍識別碼	scopeId	string	範圍的識別碼。目前僅適用於範圍 GROUP，值為 groupId

布林設定資訊V6

名稱	路徑	類型	Description
價值觀	value	boolean	設定的值
已繼承	inherited	boolean	如果設定繼承自其群組或帳戶值，則為 True

設定資訊V6

名稱	路徑	類型
libaryDocumentCreationVisible	libaryDocumentCreationVisible	BooleanSettingInfoV6
sendRestrictedToWorkflows	sendRestrictedToWorkflows	BooleanSettingInfoV6
userCan發送	userCanSend	BooleanSettingInfoV6
widgetCreation可見	widgetCreationVisible	BooleanSettingInfoV6

使用者群組資訊V6

名稱	路徑	類型	Description
群組識別碼	id	string	群組的唯一識別碼
是群組管理員	isGroupAdmin	boolean	如果使用者是群組管理員，則為 True
是主要群組	isPrimaryGroup	boolean	如果群組是使用者的主要群組，則為 True
地位	status	string	群組成員資格的狀態
建立日期	createdDate	date	建立日期群組
群組名稱	name	string	群組名稱
設定	settings	SettingsInfoV6

使用者群組資訊V6

包含指定使用者群組清單的 JSON

名稱	路徑	類型	Description
使用者群組清單	groupInfoList	array of UserGroupInfoV6	使用者群組資訊項目的陣列

二進位

這是基本數據類型『binary』。

物件

這是類型 'object'。

檔案

這是基本資料類型「檔案」。

共用方式為

Adobe Acrobat Sign 沙盒環境

Adobe Acrobat Sign 沙盒環境

發行商：Adobe， Inc.

先決條件

如何取得認證

開始使用連接器

已知問題與限制

常見錯誤和補救措施

FAQ

節流限制

動作

上傳文件並取得文件 ID

參數

傳回

上傳文件並取得文件 ID （舊版） [已淘汰]

參數

傳回

以 CSV 格式獲取協議的表單字段數據

參數

傳回

以 JSON 格式取得協議的表單欄位資料

參數

傳回

取得使用者所屬之所有群組的清單

參數

傳回

取得合約的狀態

參數

傳回

取得合約的狀態 [已取代]

參數

傳回

取得合約的表單欄位資料 （舊） [已棄用]

參數

傳回

取得合約稽核記錄的 PDF

參數

傳回

取得工作流程的詳細資訊

參數

傳回

取得已簽署合約的 PDF

參數

傳回

取得已簽署合約的 PDF [已淘汰]

參數

傳回

取得所有合約的清單

參數

傳回

取得所有合約的清單 （舊） [已淘汰]

傳回

取得所有工作流程的清單

參數

傳回

取得所有程式庫範本的清單

參數

傳回

取得所有程式庫範本的清單 （舊） [已棄用]

傳回

取得所有網路表單的清單

參數

傳回

取消合約

參數

從上傳的文件建立合約並傳送以供簽署

參數

傳回

從上傳的文件建立合約並傳送以供簽署 （舊） [已淘汰]

參數

傳回

從上傳的文件建立文件庫範本

參數

傳回

從上傳的文件建立文件庫範本 （舊） [已棄用]

參數

傳回

從合約取得所有文件 ID 的清單 [已棄用]

參數

取得合約的表單欄位資料（舊） [已棄用]

取得所有合約的清單（舊） [已淘汰]

取得所有程式庫範本的清單（舊） [已棄用]

從上傳的文件建立合約並傳送以供簽署（舊） [已淘汰]

從上傳的文件建立文件庫範本（舊） [已棄用]

從文件 URL 建立合約並傳送以供簽署（舊版） [已淘汰]

從文件 URL 建立文件庫範本（舊） [已棄用]

從文件庫範本建立合約並傳送以供簽署（舊版） [已淘汰]