Docusign 示範 （預覽版）
Docusign 可讓組織在整個合約生命週期中建立、承諾和管理其合約。 客戶可以加速收入、降低風險並從經營其業務的協議中釋放價值。 Docusign 示範連接器僅連線至 Docusign 示範環境，但提供與生產 DocuSign 連接器相同的功能。 Docusign 示範環境中的任何合約都不具有法律約束力。
此連接器適用於以下產品和區域：
| 服務 | Class | Regions |
|---|---|---|
| Copilot Studio | 標準 | 除以下部分外，所有Power Automate區域： - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部 （DoD） |
| 邏輯應用程式 | 標準 | 所有 Logic Apps 區域， 但下列區域除外： - Azure中國地區 - 美國國防部 （DoD） |
| Power Apps | 標準 | 除以下部分外，所有Power Apps區域 - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部 （DoD） |
| Power Automate（自動化服務） | 標準 | 除以下部分外，所有Power Automate區域： - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部 （DoD） |
| 連絡人 | |
|---|---|
| 名稱 | 文件簽名 |
| URL | https://support.docusign.com |
| 連接器中繼資料 | |
|---|---|
| Publisher | DocuSign， Inc. |
| 網站 | https://www.docusign.com |
| 隱私策略 | https://www.docusign.com/company/privacy-policy |
| 類別 | 內容和文件;生產力 |
Title
DocuSign 可協助組織連線並自動化他們準備、簽署、採取行動和管理合約的方式。 DocuSign 示範連接器僅連線至 DocuSign 示範環境，但提供與一般 DocuSign 連接器相同的功能。 DocuSign 示範環境中的任何文件都不具有法律約束力。 對於所有非示範用途，請使用一般 DocuSign 連接器。
先決條件
若要在此整合中使用 Connect 觸發程序，必須在您的 DocuSign 帳戶中啟用 DocuSign Connect。 預設不會啟用。 啟用後，即可從 DocuSign Admin Web 應用程式存取「連線設定」頁面。 在此整合中使用 Connect 觸發器會自動為您註冊 Webhook。
取得憑證
要試用連接器，請使用模擬帳戶：
- 移至 https://developers.docusign.com/
- 建立沙箱帳戶。
這些與免費試用的不同之處在於它們永不過期，具有我們 90% 的付費帳戶功能，並且通過 DEMO 發送的任何文件都不具有法律約束力 （）。https://support.docusign.com/en/articles/Free-account-vs-Developer-account
連接器文件
有關連接器的詳細文檔，請參閱 https://support.docusign.com/en/guides/DocuSign-eSignature-for-Microsoft-Power-Automate
已知問題和限制
如需 DocuSign 的問題，請先嘗試此連結： https://support.docusign.com/en/articles/How-Do-I-Open-a-Case-in-the-DocuSign-Support-Center。
部署指示
請使用 these instructions 在Power Automate和Power Apps中將此連接器作為自訂連接器Microsoft部署。
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 250 | 60 秒 |
動作
| Create envelope （V2） |
建立新的空白信封。 |
| 使用具有收件人和標籤的範本建立信封 |
使用具有收件人和標籤的範本建立信封 |
| 使用範本大量傳送信封 |
使用範本大量傳送信封 |
| 使用範本建立信封 |
使用指定的範本建立新信封。 |
| 使用複合範本建立信封 |
使用複合範本建立信封 |
| 傳送信封 |
寄送現有信封。 |
| 列出信封 |
此動作會根據信封狀態、日期範圍、收件人名稱、收件人電子郵件地址、信封標題、文件名稱或信封自訂欄位值，帶回相關的 Docusign 信封。 輸出是標題、描述、信封 ID、文件名稱、寄件者名稱、信封狀態、狀態日期、傳送日期，以及信封的 URL，可作為在 Docusign 中檢視信封的連結。 |
| 列出信封中的文件 |
列出信封中的文件 |
| 列出範本中的文件 |
列出範本中的文件 |
| 取得信封自訂欄位資訊 |
取得信封自訂欄位資訊。 |
| 取得收件者索引標籤的資訊 |
傳回指定收件者的索引標籤值 |
| 取得稽核事件清單 |
取得稽核事件清單 |
| 取消信封 |
使信封作廢。 |
| 在信封上新增收件人的索引標籤 |
在信封上新增收件人的索引標籤 |
| 將收件人新增至信封 （V2） |
將收件人新增至信封。 |
| 將文件新增至信封 |
將文件新增至信封。 |
| 將範本套用至文件 |
將範本套用至文件 |
| 將驗證類型新增至收件者 |
將驗證類型新增至收件者。 |
| 已棄用：使用範本建立信封（已棄用）[已棄用] |
用指定的範本（已棄用）建立一個新的信封。 |
| 已棄用：將收件人加入信封（棄用） [棄用] |
在信封中加入收件人（已棄用）。 |
| 已棄用：從信封中取得文件（已棄用） [已棄用] |
從信封取得文件（已停用） |
| 建立大量傳送清單 |
建立大量傳送清單 |
| 從信封中列出收件人 |
從信封中列出收件人 |
| 從信封中取得文件 |
從信封中取得文件 |
| 從信封中移除收件人 |
從信封中移除收件人 |
| 從信封取得收件人資訊 |
從信封取得收件人資訊 |
| 從信封取得收件者標籤 |
從信封取得收件者標籤 |
| 從信封取得文件標籤 |
從信封取得文件標籤 |
| 從信封取得文件產生表單欄位 |
從信封取得文件產生表單欄位 |
| 從信封取得文件自訂欄位 |
從信封取得文件自訂欄位 |
| 從信封取得文件資訊 |
從信封取得文件資訊 |
| 從信封更新文件產生表單欄位 |
從信封更新文件產生表單欄位 |
| 從範本取得文件產生表單欄位（僅限批量傳送範本） |
從範本取得文件產生表單欄位（僅限批量傳送範本） |
| 從範本取得文件索引標籤 |
從範本取得文件索引標籤 |
| 更新信封上的收件人 |
更新信封上的收件人 |
| 更新信封上的收件人標籤值 |
更新信封上的收件人標籤值 |
| 更新信封自訂欄位 |
更新指定信封自訂欄位的值 |
| 更新信封預先填入標籤 |
更新預先填入索引標籤清單的值 |
| 清單範本 |
列出特定帳戶的範本。 |
| 為信封新增提醒事項 |
為信封新增提醒事項 |
| 產生內嵌寄件者 URL |
產生內嵌寄件者 URL |
| 產生內嵌簽署 URL [已棄用] |
產生內嵌簽署 URL |
| 產生內嵌簽署 URL （V2） |
產生內嵌簽署 URL （V2） |
| 用模板和收件人一起製作信封 |
使用指定的範本建立新信封，並指定收件人。 |
| 登錄 |
登錄 |
| 重新寄出信封 |
此動作會重新傳送 Docusign 信封，或傳送提醒給需要根據提供的 EnvelopeId 簽署 Docusign 合約的收件人。 |
| 開始 Docusign 工作流程 |
開始 Docusign 工作流程 |
| 顯示組建編號（僅供參考。不要包含在執行流程中） |
目前部署組建的識別碼。 |
Create envelope （V2）
建立新的空白信封。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
電子郵件主旨
|
emailSubject | True | string |
電子郵件的主旨。 |
|
body
|
body | dynamic |
電子郵件主體和帳戶自訂欄位。 |
傳回
使用具有收件人和標籤的範本建立信封
使用具有收件人和標籤的範本建立信封
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
範本識別碼
|
templateId | True | string |
輸入或選擇範本 ID。 |
|
收件者
|
recipients | dynamic |
文件的簽署者。 |
|
|
合併角色並刪除空的接收者
|
merge_roles_on_draft | string |
合併角色並刪除空的接收者 |
|
|
電子郵件主旨
|
emailSubject | string |
電子郵件主旨 |
傳回
使用範本大量傳送信封
使用範本大量傳送信封
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
大量傳送清單 GUID
|
bulkSendListId | True | string |
大量傳送清單 GUID |
|
範本識別碼
|
envelopeOrTemplateId | True | string |
輸入範本 ID，或從下拉式清單中選擇範本 |
傳回
使用範本建立信封
使用指定的範本建立新信封。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
範本識別碼
|
templateId | True | string |
輸入或選擇範本 ID。 |
|
信封狀態
|
status | True | string |
信封狀態 |
傳回
使用複合範本建立信封
使用複合範本建立信封
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
電子郵件主旨
|
emailSubject | True | string |
電子郵件的主旨。 |
|
電子郵件本文
|
emailBody | string |
電子郵件內文。 |
|
|
信封狀態
|
status | True | string |
信封狀態 |
|
合併角色並刪除空的接收者
|
merge_roles_on_draft | string |
合併角色並刪除空的接收者 |
|
|
body
|
body | dynamic |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
信封ID
|
envelopeId | string |
信封的 ID。 |
|
地位
|
status | string |
信封的狀態。 |
|
狀態日期時間
|
statusDateTime | string |
設定狀態的日期時間。 |
|
URI
|
uri | string |
DocuSign 中信封的 URI。 |
傳送信封
寄送現有信封。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
信封 ID
|
envelopeId | True | string |
輸入信封識別碼。 |
傳回
- response
- object
列出信封
此動作會根據信封狀態、日期範圍、收件人名稱、收件人電子郵件地址、信封標題、文件名稱或信封自訂欄位值，帶回相關的 Docusign 信封。 輸出是標題、描述、信封 ID、文件名稱、寄件者名稱、信封狀態、狀態日期、傳送日期，以及信封的 URL，可作為在 Docusign 中檢視信封的連結。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
收件者名稱
|
recipientName | string |
此動作會根據收件人名稱列出信封 |
|
|
收件者電子郵件
|
recipientEmailId | string |
依收件人電子郵件篩選信封 |
|
|
信封主題
|
envelopeTitle | string |
依信封主旨篩選信封 |
|
|
自訂欄位名稱
|
customFieldName | string |
此動作會根據其自訂欄位的名稱列出信封 |
|
|
自訂欄位值
|
customFieldValue | string |
依自訂欄位值篩選 |
|
|
搜尋詞
|
search_text | string |
輸入一個關鍵字即可找到信封主題、收件人及自訂欄位中的匹配。 |
|
|
信封狀態
|
envelopeStatus | string |
此動作會根據信封的狀態列出信封 |
|
|
資料夾
|
folder_ids | string |
依選取的資料夾篩選信封 |
|
|
訂購方式
|
order_by | string |
依選取的順序排序信封 |
|
|
回郵信封
|
top | integer |
指定要傳回的信封數目 （預設為 10，上限為 1,000） |
|
|
略過信封
|
skip | integer |
指定要從開頭略過的信封數目 |
|
|
開始日期
|
from_date | date-time |
以 UTC 格式輸入開始日期時間：2017-05-02T01：44z |
|
|
結束日期
|
to_date | date-time |
以 UTC 格式輸入結束日期時間：2017-05-02T01：44z。 |
傳回
列出信封中的文件
列出信封中的文件
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
信封 ID
|
envelopeId | True | string |
輸入信封識別碼。 |
傳回
列出範本中的文件
列出範本中的文件
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
範本識別碼
|
templateId | True | string |
輸入或選擇範本 ID。 |
傳回
取得信封自訂欄位資訊
取得信封自訂欄位資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
信封 ID
|
envelopeId | True | string |
輸入信封識別碼。 |
|
自訂欄位名稱
|
fieldName | True | string |
自訂欄位名稱 |
傳回
取得收件者索引標籤的資訊
傳回指定收件者的索引標籤值
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
信封 ID
|
envelopeId | True | string |
輸入信封識別碼。 |
|
收件者 ID
|
recipientId | True | string |
輸入收件人ID。 |
|
索引標籤標籤
|
tabLabel | True | string |
索引標籤標籤 |
傳回
- 身體
- Tab
取得稽核事件清單
取得稽核事件清單
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
信封 ID
|
envelopeId | True | string |
輸入信封識別碼。 |
傳回
- response
- object
取消信封
使信封作廢。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
信封 ID
|
envelopeId | True | string |
輸入信封識別碼。 |
|
無效原因
|
voidedReason | True | string |
無效原因 |
傳回
- response
- object
在信封上新增收件人的索引標籤
在信封上新增收件人的索引標籤
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
信封 ID
|
envelopeId | True | string |
輸入信封識別碼。 |
|
收件者 ID
|
recipientId | True | string |
輸入收件人ID。 |
|
標籤類型
|
tabType | True | string |
標籤類型 |
|
索引標籤詳細資料
|
tabDetails | True | dynamic |
所選錨點標籤的詳細資料。 |
傳回
將收件人新增至信封 （V2）
將收件人新增至信封。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
信封 ID
|
envelopeId | True | string |
輸入信封識別碼。 |
|
收件者類型
|
recipientType | True | string |
輸入或選擇收件人類型。 |
|
用戶端使用者 ID
|
clientUserId | string |
內嵌式簽署者的用戶端使用者 ID |
|
|
收件者 ID
|
recipientId | string |
輸入收件人ID。 |
|
|
內嵌收件者開始 URL
|
embeddedRecipientStartURL | string |
寄件者提供的URL字串，用於重新導向內嵌收件者。 |
|
|
簽署順序
|
routingOrder | string |
收件者的簽署順序。 |
|
|
電子郵件通知語言
|
emailNotificationLanguage | string |
電子郵件通知的語言。 |
|
|
電子郵件通知主旨
|
emailNotificationSubject | string |
電子郵件通知的主題。 |
|
|
電子郵件通知內文
|
emailNotificationBody | string |
電子郵件通知的內文。 |
|
|
備註
|
note | string |
收件者的自訂附註。 |
|
|
角色名稱
|
roleName | string |
與收件者相關聯的角色名稱。 |
|
|
簡訊國家代碼
|
countryCode | string |
對於短信通知，國家代碼，不帶前導 + 符號。 |
|
|
簡訊電話號碼
|
phoneNumber | string |
需要簽署者電子郵件或簡訊電話。 排除電話號碼的國家/地區代碼。 |
|
|
簽約組
|
signingGroupId | string |
簽約組 |
|
|
簽名類型
|
signatureType | string |
DocuSign 標準型簽章 （SBS） 類型。 |
|
|
驗證工作流程
|
workflowId | string |
必須在此處選取具有筆簽名類型的 IDV 工作流程。 |
|
|
所選收件者的詳細資料
|
additionalRecipientParams | dynamic |
所選收件者型別的詳細資料。 |
傳回
- 身體
- Signer
將文件新增至信封
將文件新增至信封。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
信封 ID
|
envelopeId | True | string |
輸入信封識別碼。 |
|
文件基數64 *
|
documentBase64 | True | string |
文件內容的 Base64 |
|
文件類型 *
|
fileExtension | True | string |
PDF、DOCX 等。 |
|
文件名稱 *
|
name | True | string |
文件名稱 |
|
轉換 Pdf 欄位
|
transformPdfFields | string |
否 |
|
|
將索引標籤指派給收件者
|
assignTabsToRecipientId | string |
收件者 ID |
傳回
將範本套用至文件
將範本套用至文件
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
信封 ID
|
envelopeId | True | string |
輸入信封識別碼。 |
|
範本識別碼
|
templateId | True | string |
輸入或選擇範本 ID。 |
|
保留範本收件者
|
preserve_template_recipient | string |
否 |
|
|
文件 ID
|
documentId | True | string |
文件 ID |
|
文件起始頁
|
documentStartPage | True | string |
文件起始頁 |
|
文件結束頁
|
documentEndPage | True | string |
文件結束頁 |
將驗證類型新增至收件者
將驗證類型新增至收件者。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
信封 ID
|
envelopeId | True | string |
輸入信封識別碼。 |
|
收件者 ID
|
recipientId | True | string |
輸入收件人ID。 |
|
收件者類型
|
recipientType | True | string |
輸入或選擇收件人類型。 |
|
驗證類型
|
verificationType | True | string |
驗證類型 |
|
其他收件者資料
|
additionalRecipientData | dynamic |
其他收件者資料。 |
已棄用：使用範本建立信封（已棄用）[已棄用]
用指定的範本（已棄用）建立一個新的信封。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
範本識別碼
|
templateId | True | string |
輸入或選擇範本 ID。 |
|
信封狀態
|
status | True | string |
信封狀態 |
|
自訂欄位
|
accountCustomFields | True | dynamic |
取得在帳戶層級設定的自訂欄位。 |
傳回
已棄用：將收件人加入信封（棄用） [棄用]
在信封中加入收件人（已棄用）。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
帳戶標識碼 |
|
信封
|
envelopeId | True | string |
信封 ID |
|
簽署者名稱
|
AddRecipientToEnvelopeName | True | string |
收件者的名稱。 |
|
簽署者電子郵件
|
AddRecipientToEnvelopeEmail | True | string |
收件者的電子郵件。 |
|
簽署訂單
|
routingOrder | string |
文件中收件者的簽署順序。 |
|
|
Role
|
roleName | string |
簽署者的角色。 |
傳回
已棄用：從信封中取得文件（已棄用） [已棄用]
從信封取得文件（已停用）
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
帳戶標識碼 |
|
信封 ID
|
envelopeId | True | string |
輸入信封識別碼。 |
|
結業證書
|
certificate | True | boolean |
當設定為 false 時，信封簽署憑證會從下載中移除。 |
傳回
- response
- GetDocumentsResponse
建立大量傳送清單
建立大量傳送清單
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
大量傳送清單名稱
|
name | True | string |
大量傳送清單名稱 |
|
CSV 檔案
|
csv | string |
上傳 CSV 檔案 |
|
|
文件產生欄位
|
rawOutput | object |
文件產生欄位 |
傳回
從信封中列出收件人
從信封中列出收件人
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
信封 ID
|
envelopeId | True | string |
輸入信封識別碼。 |
傳回
從信封中取得文件
從信封中取得文件
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
信封 ID
|
envelopeId | True | string |
輸入信封識別碼。 |
|
輸出格式
|
documentId | True | string |
輸入「string（document ID）」即可取得單一文件，或選擇格式。 |
|
結業證書語言（選修）
|
language | string |
選擇語言 |
傳回
- response
- GetDocumentsResponse
從信封中移除收件人
從信封中移除收件人
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
資料夾
|
folderId | True | string |
資料夾 ID |
|
信封 ID
|
envelopeId | True | string |
輸入信封識別碼。 |
|
收件者 ID
|
RemoveRecipientFromEnvelopeRecipientId | True | string |
收件者 ID |
傳回
從信封取得收件人資訊
從信封取得收件人資訊
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
信封 ID
|
envelopeId | True | string |
輸入信封識別碼。 |
|
收件者電子郵件
|
recipientEmail | string |
收件者電子郵件 |
|
|
區號
|
areaCode | string |
收件人的區號 |
|
|
電話號碼
|
phoneNumber | string |
收件人的電話號碼 |
|
|
收件者 ID
|
recipientId | string |
輸入收件人ID。 |
傳回
- 身體
- Signer
從信封取得收件者標籤
從信封取得收件者標籤
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
信封 ID
|
envelopeId | True | string |
輸入信封識別碼。 |
|
收件者 ID
|
recipientId | True | string |
輸入收件人ID。 |
傳回
從信封取得文件標籤
從信封取得文件標籤
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
信封 ID
|
envelopeId | True | string |
輸入信封識別碼。 |
|
文件 ID
|
documentId | True | string |
輸入文件識別碼。 |
傳回
從信封取得文件產生表單欄位
從信封取得文件產生表單欄位
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
信封 ID
|
envelopeId | True | string |
輸入信封識別碼。 |
傳回
從信封取得文件自訂欄位
從信封取得文件自訂欄位
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
信封 ID
|
envelopeId | True | string |
輸入信封識別碼。 |
|
文件 ID
|
documentId | True | string |
輸入文件識別碼。 |
傳回
從信封取得文件資訊
從信封取得文件資訊
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
信封 ID
|
envelopeId | True | string |
輸入信封識別碼。 |
|
文件名稱
|
documentName | True | string |
副檔名的檔案名稱 |
傳回
從信封更新文件產生表單欄位
從信封更新文件產生表單欄位
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
信封 ID
|
envelopeId | True | string |
輸入信封識別碼。 |
|
檔 GUID
|
documentGuid | True | string |
檔 GUID |
|
類型
|
fieldType | string |
選擇要更新的文件產生欄位類型 |
|
|
名稱
|
name | string |
輸入欄位名稱或表格欄名稱 |
|
|
價值觀
|
value | string |
輸入欄位資料 |
|
|
標籤
|
label | string |
「表格列」的必要項目。 輸入 docgen 欄位的標籤。 |
|
|
：表格名稱
|
tableName | string |
「表格列」的必要項目。 輸入表格名稱。 |
|
|
：表格列
|
rowNumber | string |
「表格列」的必要項目。 輸入列號 |
從範本取得文件產生表單欄位（僅限批量傳送範本）
從範本取得文件產生表單欄位（僅限批量傳送範本）
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
範本識別碼
|
templateId | True | string |
輸入或選擇範本 ID。 |
傳回
從範本中產生文件的表單欄位
- DocGen 範本欄位
- object
從範本取得文件索引標籤
從範本取得文件索引標籤
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
範本識別碼
|
templateId | True | string |
輸入或選擇範本 ID。 |
|
文件 ID
|
documentId | True | string |
輸入文件識別碼。 |
傳回
更新信封上的收件人
更新信封上的收件人
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
信封 ID
|
envelopeId | True | string |
輸入信封識別碼。 |
|
收件者 ID
|
recipientId | True | string |
輸入收件人ID。 |
|
簽名類型
|
signatureType | string |
DocuSign 標準型簽章 （SBS） 類型。 |
|
|
收件者類型
|
recipientType | True | string |
收件者類型 |
|
用戶端使用者 ID
|
clientUserId | string |
內嵌式簽署者的用戶端使用者 ID |
|
|
內嵌收件者開始 URL
|
embeddedRecipientStartURL | string |
寄件者提供的URL字串，用於重新導向內嵌收件者。 |
|
|
簽署順序
|
routingOrder | string |
收件者的簽署順序。 |
|
|
電子郵件通知語言
|
emailNotificationLanguage | string |
電子郵件通知的語言。 |
|
|
電子郵件通知主旨
|
emailNotificationSubject | string |
電子郵件通知的主題。 |
|
|
電子郵件通知內文
|
emailNotificationBody | string |
電子郵件通知的內文。 |
|
|
備註
|
note | string |
收件者的自訂附註。 |
|
|
角色名稱
|
roleName | string |
與收件者相關聯的角色名稱。 |
|
|
簡訊國家代碼
|
countryCode | string |
對於短信通知，國家代碼，不帶前導 + 符號。 |
|
|
簡訊電話號碼
|
phoneNumber | string |
需要簽署者電子郵件或簡訊電話。 排除電話號碼的國家/地區代碼。 |
|
|
簽約組
|
signingGroupId | string |
簽約組 |
|
|
所選收件者的詳細資料
|
additionalRecipientParams | dynamic |
所選收件者型別的詳細資料。 |
傳回
- 身體
- Signer
更新信封上的收件人標籤值
更新信封上的收件人標籤值
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
信封 ID
|
envelopeId | True | string |
輸入信封識別碼。 |
|
收件者 ID
|
recipientId | True | string |
輸入收件人ID。 |
|
類型
|
tabType | string |
標籤類型 |
|
|
ID
|
tabId | string |
ID |
|
|
價值觀
|
value | string |
價值觀 |
更新信封自訂欄位
更新指定信封自訂欄位的值
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
信封 ID
|
envelopeId | True | string |
輸入信封識別碼。 |
|
欄位識別碼
|
fieldId | True | string |
自訂欄位ID |
|
欄位類型
|
fieldType | True | string |
自訂欄位類型 |
|
名稱
|
name | True | string |
自訂欄位名稱 |
|
價值觀
|
value | True | string |
自訂欄位值 |
傳回
更新信封預先填入標籤
更新預先填入索引標籤清單的值
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
信封 ID
|
envelopeId | True | string |
輸入信封識別碼。 |
|
文件 ID
|
documentId | True | string |
輸入文件識別碼。 |
|
類型
|
tabType | string |
類型 |
|
|
ID
|
tabId | string |
ID |
|
|
價值觀
|
value | string |
價值觀 |
清單範本
列出特定帳戶的範本。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
傳回
為信封新增提醒事項
為信封新增提醒事項
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
信封 ID
|
envelopeId | True | string |
輸入信封識別碼。 |
|
已啟用提醒
|
reminderEnabled | True | boolean |
當設定為 false 時，提醒會停用。 預設值為 false。 |
|
提醒延遲
|
reminderDelay | True | string |
新增收件者收到提醒電子郵件的天數。 |
|
提醒頻率
|
reminderFrequency | True | string |
新增提醒電子郵件之間的天數。 |
|
到期時間
|
expireAfter | string |
新增到期前的天數。 |
傳回
產生內嵌寄件者 URL
產生內嵌寄件者 URL
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
信封 ID
|
envelopeId | True | string |
輸入信封識別碼。 |
|
開啟方式
|
openIn | True | string |
開啟方式 |
|
傳回網址
|
returnUrl | True | string |
傳回網址 |
|
其他新增的網址
|
additionalURL | dynamic |
其他新增的網址。 |
傳回
產生內嵌簽署 URL [已棄用]
產生內嵌簽署 URL
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
信封 ID
|
envelopeId | True | string |
輸入信封識別碼。 |
|
簽署者名稱
|
signerName | True | string |
簽署者名稱 |
|
簽署者電子郵件
|
signerEmail | True | string |
簽署者電子郵件 |
|
用戶端使用者 ID
|
clientUserId | string |
除非簽署者親自到場，否則必須。 為親自簽署者保留空白 |
|
|
驗證方法
|
authenticationMethod | True | string |
驗證方法 |
|
傳回網址
|
returnUrl | True | string |
傳回網址 |
|
其他新增的網址
|
additionalURL | dynamic |
其他新增的網址。 |
傳回
產生內嵌簽署 URL （V2）
產生內嵌簽署 URL （V2）
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
信封 ID
|
envelopeId | True | string |
輸入信封識別碼。 |
|
這是親自簽署者嗎？
|
isInPersonSigner | True | string |
是/否 |
|
驗證方法
|
authenticationMethod | True | string |
驗證方法 |
|
傳回網址
|
returnUrl | True | string |
傳回網址 |
|
其他新增的網址
|
additionalURL | True | dynamic |
其他新增的網址。 |
傳回
用模板和收件人一起製作信封
使用指定的範本建立新信封，並指定收件人。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
信封狀態
|
status | True | string |
信封狀態 |
|
範本識別碼
|
templateId | True | string |
輸入或選擇範本 ID。 |
|
簽署者
|
signers | dynamic |
文件的簽署者。 |
|
|
電子郵件主旨
|
emailSubject | string |
電子郵件主旨 |
|
|
電子郵件本文
|
emailBody | string |
電子郵件本文 |
傳回
登錄
重新寄出信封
此動作會重新傳送 Docusign 信封，或傳送提醒給需要根據提供的 EnvelopeId 簽署 Docusign 合約的收件人。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
信封 ID
|
envelopeId | True | string |
輸入信封識別碼。 |
傳回
- response
- object
開始 Docusign 工作流程
開始 Docusign 工作流程
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入或選擇帳號 ID。 |
|
工作流程
|
workflowId | True | string |
輸入工作流程識別碼，或從下拉式清單中選取工作流程名稱 |
|
實例名稱
|
instanceName | True | string |
工作流程實例名稱 |
|
變數
|
variable | dynamic |
傳回
觸發 MaestroFlowResponse
- response
- object
顯示組建編號（僅供參考。不要包含在執行流程中）
觸發程序
| 已棄用：當信封狀態變更（連接）（V2）（棄用）[棄用] |
當包絡狀態改變（棄用）時，會觸發新的流程。 |
| 棄用：當信封狀態變更（Connect）（棄用）[棄用] |
當包絡狀態改變（棄用）時，會觸發新的流程。 |
| 當信封狀態變更時 （連線） （V3） |
當信封狀態變更時觸發新流程。 |
| 發生 Docusign Connect 事件時 （帳戶層級） |
當信封狀態變更時觸發新流程。 |
| 發生 Docusign Connect 事件時 （組織層級） |
當信封狀態變更時觸發新流程。 |
已棄用：當信封狀態變更（連接）（V2）（棄用）[棄用]
當包絡狀態改變（棄用）時，會觸發新的流程。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
帳戶標識碼 |
|
連線名稱
|
name | True | string | |
|
信封事件
|
envelopeEvents | True | string |
傳回
棄用：當信封狀態變更（Connect）（棄用）[棄用]
當包絡狀態改變（棄用）時，會觸發新的流程。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
帳戶標識碼 |
|
連線名稱
|
name | True | string | |
|
信封事件
|
envelopeEvents | True | string |
傳回
當信封狀態變更時 （連線） （V3）
當信封狀態變更時觸發新流程。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
帳戶標識碼 |
|
連線名稱
|
name | True | string | |
|
信封事件
|
envelopeEvents | True | string |
傳回
發生 Docusign Connect 事件時 （帳戶層級）
當信封狀態變更時觸發新流程。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
帳戶識別碼
|
accountId | True | string |
輸入帳戶 ID，或從下拉式清單中選取帳戶。 |
|
Connect 組態名稱
|
name | True | string |
請為你的 Connect 設定命名（例如「Envelope Events」）。 |
|
觸發事件
|
events | True | array of string |
選擇一個活動。 若要包含其他活動，請選擇「新增項目」。 |
傳回
發生 Docusign Connect 事件時 （組織層級）
當信封狀態變更時觸發新流程。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織識別碼
|
organizationId | True | string |
輸入或選取組織識別碼。 |
|
Connect 組態名稱
|
name | True | string |
請為你的 Connect 設定命名（例如「Envelope Events」）。 |
|
觸發事件
|
events | True | array of string |
選擇一個活動。 若要包含其他活動，請選擇「新增項目」。 |
傳回
定義
WebhookEnvelopeResponseV2
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
自訂欄位
|
data.envelopeSummary.customFields | object |
代表此信封自訂欄位的索引鍵值組 （其中 key 是欄位名稱，value 是欄位值）。 |
|
信封建立 Date-Time
|
data.envelopeSummary.createdDateTime | date-time |
yyyy-MM-ddTHH：mm：ss.fffZ |
|
信封 ID
|
data.envelopeSummary.envelopeId | string | |
|
信封已寄出 Date-Time
|
data.envelopeSummary.sentDateTime | date-time |
yyyy-MM-ddTHH：mm：ss.fffZ |
|
信封狀態
|
data.envelopeSummary.status | string | |
|
電子郵件主旨
|
data.envelopeSummary.emailSubject | string | |
|
寄件人姓名
|
data.envelopeSummary.sender.userName | string | |
|
寄件者的使用者 ID
|
data.envelopeSummary.sender.userId | string | |
|
寄件者的帳戶 ID
|
data.envelopeSummary.sender.accountId | string | |
|
寄件人的電子郵件地址
|
data.envelopeSummary.sender.email | string | |
|
簽署者
|
data.envelopeSummary.recipients.signers | array of object | |
|
頁籤
|
data.envelopeSummary.recipients.signers.tabs | object |
代表此收件者索引標籤的索引標籤對 （其中 key 是欄位名稱，value 是欄位值）。 |
|
收件者電子郵件
|
data.envelopeSummary.recipients.signers.email | string | |
|
收件者 ID
|
data.envelopeSummary.recipients.signers.recipientId | string | |
|
路由順序
|
data.envelopeSummary.recipients.signers.routingOrder | string | |
|
收件者已傳送 Date-Time
|
data.envelopeSummary.recipients.signers.sentDateTime | date-time |
yyyy-MM-ddTHH：mm：ss.fffZ |
|
收件者狀態
|
data.envelopeSummary.recipients.signers.status | string |
收件者的狀態。 |
|
收件者類型
|
data.envelopeSummary.recipients.signers.recipientType | string |
收件者的型別。 |
|
驗證類型
|
data.envelopeSummary.recipients.signers.verificationType | string |
驗證的類型。 |
|
收件者名稱
|
data.envelopeSummary.recipients.signers.name | string |
收件者的名稱。 |
WebhookEnvelopeResponseV3
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
自訂欄位
|
data.envelopeSummary.customFields | object |
代表此信封自訂欄位的索引鍵值組 （其中 key 是欄位名稱，value 是欄位值）。 |
|
信封建立 Date-Time
|
data.envelopeSummary.createdDateTime | date-time |
yyyy-MM-ddTHH：mm：ss.fffZ |
|
信封 ID
|
data.envelopeSummary.envelopeId | string | |
|
信封已寄出 Date-Time
|
data.envelopeSummary.sentDateTime | date-time |
yyyy-MM-ddTHH：mm：ss.fffZ |
|
信封狀態
|
data.envelopeSummary.status | string | |
|
電子郵件主旨
|
data.envelopeSummary.emailSubject | string | |
|
寄件人姓名
|
data.envelopeSummary.sender.userName | string | |
|
寄件者的使用者 ID
|
data.envelopeSummary.sender.userId | string | |
|
寄件者的帳戶 ID
|
data.envelopeSummary.sender.accountId | string | |
|
寄件人的電子郵件地址
|
data.envelopeSummary.sender.email | string | |
|
簽署者
|
data.envelopeSummary.recipients.signers | array of object | |
|
頁籤
|
data.envelopeSummary.recipients.signers.tabs | object |
代表此收件者索引標籤的索引標籤對 （其中 key 是欄位名稱，value 是欄位值）。 |
|
收件者電子郵件
|
data.envelopeSummary.recipients.signers.email | string | |
|
收件者 ID
|
data.envelopeSummary.recipients.signers.recipientId | string | |
|
路由順序
|
data.envelopeSummary.recipients.signers.routingOrder | string | |
|
收件者已傳送 Date-Time
|
data.envelopeSummary.recipients.signers.sentDateTime | date-time |
yyyy-MM-ddTHH：mm：ss.fffZ |
|
收件者狀態
|
data.envelopeSummary.recipients.signers.status | string |
收件者的狀態。 |
|
收件者類型
|
data.envelopeSummary.recipients.signers.recipientType | string |
收件者的型別。 |
|
驗證類型
|
data.envelopeSummary.recipients.signers.verificationType | string |
驗證的類型。 |
|
收件者名稱
|
data.envelopeSummary.recipients.signers.name | string |
收件者的名稱。 |
WebhookEnvelopeResponseV4
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
信封自訂欄位
|
data.envelopeSummary.customFields | object |
代表此信封自訂欄位的索引鍵值組 （其中 key 是欄位名稱，value 是欄位值）。 |
|
信封建立 Date-Time
|
data.envelopeSummary.createdDateTime | date-time |
yyyy-MM-ddTHH：mm：ss.fffZ |
|
信封 ID
|
data.envelopeSummary.envelopeId | string | |
|
信封已寄出 Date-Time
|
data.envelopeSummary.sentDateTime | date-time |
yyyy-MM-ddTHH：mm：ss.fffZ |
|
信封狀態
|
data.envelopeSummary.status | string | |
|
電子郵件主旨
|
data.envelopeSummary.emailSubject | string | |
|
信封文件
|
data.envelopeSummary.envelopeDocuments | array of object | |
|
文件 ID
|
data.envelopeSummary.envelopeDocuments.documentId | string | |
|
文件指南
|
data.envelopeSummary.envelopeDocuments.documentIdGuid | string | |
|
文件名稱
|
data.envelopeSummary.envelopeDocuments.name | string | |
|
寄件人姓名
|
data.envelopeSummary.sender.userName | string | |
|
寄件者的使用者 ID
|
data.envelopeSummary.sender.userId | string | |
|
寄件者的帳戶 ID
|
data.envelopeSummary.sender.accountId | string | |
|
寄件人的電子郵件地址
|
data.envelopeSummary.sender.email | string | |
|
簽署者
|
data.envelopeSummary.recipients.signers | array of object | |
|
頁籤
|
data.envelopeSummary.recipients.signers.tabs | object |
代表此收件者索引標籤的索引標籤對 （其中 key 是欄位名稱，value 是欄位值）。 |
|
收件者電子郵件
|
data.envelopeSummary.recipients.signers.email | string | |
|
收件者 ID
|
data.envelopeSummary.recipients.signers.recipientId | string | |
|
路由順序
|
data.envelopeSummary.recipients.signers.routingOrder | string | |
|
收件者已傳送 Date-Time
|
data.envelopeSummary.recipients.signers.sentDateTime | date-time |
yyyy-MM-ddTHH：mm：ss.fffZ |
|
收件者狀態
|
data.envelopeSummary.recipients.signers.status | string |
收件者的狀態。 |
|
收件者類型
|
data.envelopeSummary.recipients.signers.recipientType | string |
收件者的型別。 |
|
驗證類型
|
data.envelopeSummary.recipients.signers.verificationType | string |
驗證的類型。 |
|
收件者名稱
|
data.envelopeSummary.recipients.signers.name | string |
收件者的名稱。 |
WebhookOrganizationResponse
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
組織識別碼
|
data.organizationId | string |
組織識別碼。 |
|
自訂欄位
|
data.envelopeSummary.customFields | object |
代表此信封自訂欄位的索引鍵值組 （其中 key 是欄位名稱，value 是欄位值）。 |
|
信封建立 Date-Time
|
data.envelopeSummary.createdDateTime | date-time |
yyyy-MM-ddTHH：mm：ss.fffZ |
|
信封 ID
|
data.envelopeSummary.envelopeId | string | |
|
信封已寄出 Date-Time
|
data.envelopeSummary.sentDateTime | date-time |
yyyy-MM-ddTHH：mm：ss.fffZ |
|
信封狀態
|
data.envelopeSummary.status | string | |
|
電子郵件主旨
|
data.envelopeSummary.emailSubject | string | |
|
信封文件
|
data.envelopeSummary.envelopeDocuments | array of object | |
|
文件 ID
|
data.envelopeSummary.envelopeDocuments.documentId | string | |
|
文件指南
|
data.envelopeSummary.envelopeDocuments.documentIdGuid | string | |
|
文件名稱
|
data.envelopeSummary.envelopeDocuments.name | string | |
|
寄件人姓名
|
data.envelopeSummary.sender.userName | string | |
|
寄件者的使用者 ID
|
data.envelopeSummary.sender.userId | string | |
|
寄件者的帳戶 ID
|
data.envelopeSummary.sender.accountId | string | |
|
寄件人的電子郵件地址
|
data.envelopeSummary.sender.email | string | |
|
簽署者
|
data.envelopeSummary.recipients.signers | array of object | |
|
頁籤
|
data.envelopeSummary.recipients.signers.tabs | object |
代表此收件者索引標籤的索引標籤對 （其中 key 是欄位名稱，value 是欄位值）。 |
|
收件者電子郵件
|
data.envelopeSummary.recipients.signers.email | string | |
|
收件者 ID
|
data.envelopeSummary.recipients.signers.recipientId | string | |
|
路由順序
|
data.envelopeSummary.recipients.signers.routingOrder | string | |
|
收件者已傳送 Date-Time
|
data.envelopeSummary.recipients.signers.sentDateTime | date-time |
yyyy-MM-ddTHH：mm：ss.fffZ |
|
收件者狀態
|
data.envelopeSummary.recipients.signers.status | string |
收件者的狀態。 |
|
收件者類型
|
data.envelopeSummary.recipients.signers.recipientType | string |
收件者的型別。 |
|
驗證類型
|
data.envelopeSummary.recipients.signers.verificationType | string |
驗證的類型。 |
|
收件者名稱
|
data.envelopeSummary.recipients.signers.name | string |
收件者的名稱。 |
WebhookEnvelope回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
信封自訂欄位
|
customFields | object |
代表此信封自訂欄位的索引鍵值組 （其中 key 是欄位名稱，value 是欄位值）。 |
|
信封建立 Date-Time
|
DocuSignEnvelopeInformation.EnvelopeStatus.Created | date-time |
yyyy-MM-ddTHH：mm：ss.fffZ |
|
寄件人的電子郵件地址
|
DocuSignEnvelopeInformation.EnvelopeStatus.Email | string | |
|
信封 ID
|
DocuSignEnvelopeInformation.EnvelopeStatus.EnvelopeID | string | |
|
寄件者的 IP 位址
|
DocuSignEnvelopeInformation.EnvelopeStatus.SenderIPAddress | string | |
|
信封已寄出 Date-Time
|
DocuSignEnvelopeInformation.EnvelopeStatus.Sent | date-time |
yyyy-MM-ddTHH：mm：ss.fffZ |
|
信封狀態
|
DocuSignEnvelopeInformation.EnvelopeStatus.Status | string | |
|
主旨
|
DocuSignEnvelopeInformation.EnvelopeStatus.Subject | string | |
|
寄件人姓名
|
DocuSignEnvelopeInformation.EnvelopeStatus.UserName | string | |
|
收件者狀態
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus | array of object | |
|
頁籤
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.tabs | object |
代表此收件者索引標籤的索引標籤對 （其中 key 是欄位名稱，value 是欄位值）。 |
|
拒絕原因
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.DeclineReason | DeclineReasonWithoutType | |
|
收件者電子郵件
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Email | string | |
|
收件者 ID
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.RecipientId | string | |
|
路由順序
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.RoutingOrder | string | |
|
收件者已傳送 Date-Time
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Sent | date-time |
yyyy-MM-ddTHH：mm：ss.fffZ |
|
收件者狀態
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Status | string |
收件者的狀態。 |
|
收件者類型
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Type | string |
收件者的型別。 |
|
收件者名稱
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.UserName | string |
收件者的名稱。 |
|
時區
|
DocuSignEnvelopeInformation.TimeZone | string | |
|
時區偏移
|
DocuSignEnvelopeInformation.TimeZoneOffset | string |
GetDocuments回應
- 檔案內容
- binary
AddReminders回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
已啟用提醒
|
reminderEnabled | string |
已啟用提醒 |
過濾信封
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Title
|
title | string |
信封標題 |
|
Description
|
description | string |
信封活動的描述 |
|
信封 ID
|
envelopeId | string |
信封 ID |
|
Documents
|
documents | string |
文件名稱列表 |
|
收件者姓名
|
recipients | string |
收件者姓名清單 |
|
寄件者名稱
|
sender | string |
寄件者名稱 |
|
地位
|
status | string |
信封的狀態 |
|
狀態日期
|
statusDate | string |
活動的上次狀態更新 |
|
發送日期
|
dateSent | date-time |
信封寄件日期 |
|
URL
|
url | string |
信封的 URL |
EmbeddedSender回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
內嵌寄件者 URL
|
url | string |
內嵌寄件者檢視的 URL。 |
EmbeddedSigning回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
url | string |
內嵌簽署檢視的 URL。 |
FilteredEnvelopeList回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
過濾信封
|
value | array of FilteredEnvelopes |
過濾信封 |
|
更多信封結果
|
hasMoreResults | boolean |
顯示信封是否超過「回信信封」欄位中的指定數量 |
CreateEnvelope回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
信封ID
|
envelopeId | string |
信封的 ID。 |
|
範本識別碼
|
templateId | string |
範本的識別碼。 |
|
地位
|
status | string |
信封的狀態。 |
|
狀態日期時間
|
statusDateTime | string |
設定狀態的日期時間。 |
|
URI
|
uri | string |
DocuSign 中信封的 URI。 |
ListRecipients回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
信封 ID
|
envelopeId | string | |
|
簽署者
|
signers | array of Signer |
簽署者 |
Tab
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
標籤名稱
|
name | string |
索引標籤的名稱。 |
|
標籤類型
|
tabType | string |
索引標籤的類型。 |
|
索引標籤標籤
|
tabLabel | string |
索引標籤的標籤。 |
|
標籤值
|
value | string |
索引標籤的值。 |
|
索引標籤識別碼
|
tabId | string |
索引標籤的識別碼。 |
|
文件標識碼
|
documentId | string |
文件的 ID。 |
|
收件者 ID
|
recipientId | string |
收件者的ID。 |
|
是預填
|
prefill | boolean |
指出標籤是否為預填類型。 |
|
已選擇
|
selected | string |
如果標籤為核取方塊，則指出是否已選取標籤。 |
RecipientTabs回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
收件者標籤：
|
recipientTabs | array of Tab |
收件者索引標籤 |
簽署者
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
簽署訂單
|
routingOrder | string |
文件中收件者的簽署順序。 |
|
Role
|
roleName | string |
簽署者的角色。 |
|
收件者 ID
|
recipientId | string |
收件者的ID。 |
|
名稱
|
name | string |
收件者的名稱。 |
|
Email
|
string |
收件者的電子郵件。 |
|
|
收件者類型
|
recipientType | string |
收件者的類型。 |
|
驗證類型
|
verificationType | string |
驗證的類型。 |
|
收件人 GUID
|
recipientIdGuid | string |
收件人 GUID。 |
GetLoginAccounts回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
登入帳戶
|
loginAccounts | array of LoginAccount |
登入帳戶 |
登錄帳戶
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名稱
|
name | string |
帳戶的名稱。 |
|
帳戶識別碼 guid
|
accountIdGuid | string |
帳戶的 GUID。 |
ListTabs回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
頁籤
|
tabs | array of Tab |
頁籤 |
ListEnvelopeDocumentFields回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
自訂欄位
|
envelopeDocumentFields | array of EnvelopeDocumentField |
文件自訂欄位 |
DocGenFormFields回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
多根菲爾茲
|
docgenFields | array of DocGenFormField |
多根菲爾茲 |
DocGenFormField
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
文件標識碼
|
documentId | string |
文件 ID。 |
|
標籤
|
label | string |
標籤。 |
|
類型
|
type | string |
類型。 |
|
名稱
|
name | string |
名稱. |
|
價值觀
|
value | string |
價。 |
ListTemplates回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
信封範本
|
envelopeTemplates | array of EnvelopeTemplate |
可用的信封範本。 |
信封範本
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
範本識別碼
|
templateId | string |
範本的識別碼。 |
|
名稱
|
name | string |
範本的名稱。 |
BulkSendListGuid
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
大量傳送清單 guid
|
listId | string |
大量傳送清單 guid |
EnvelopeCustomField回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
欄位識別碼
|
fieldId | string |
信封自訂欄位的 ID。 |
|
欄位類型
|
fieldType | string |
信封自訂欄位的類型。 |
|
名稱
|
name | string |
信封自訂欄位的名稱。 |
|
價值觀
|
value | string |
信封自訂欄位的值。 |
UpdateEnvelopeCustomField回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
欄位識別碼
|
fieldId | string |
信封自訂欄位的 ID。 |
|
欄位類型
|
fieldType | string |
信封自訂欄位的類型。 |
|
名稱
|
name | string |
信封自訂欄位的名稱。 |
|
價值觀
|
value | string |
信封自訂欄位的值。 |
ListDocuments回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
信封文件
|
envelopeDocuments | array of EnvelopeDocument |
信封上附的文件。 |
ListTemplateDocuments回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
範本文件
|
templateDocuments | array of EnvelopeDocument |
附加至範本的文件。 |
AddDocuments回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
信封ID
|
envelopeId | string |
信封的 ID。 |
|
信封文件
|
envelopeDocuments | array of EnvelopeDocument |
信封上附的文件。 |
AddRecipientTabs回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
收件者索引標籤
|
recipientTabs | array of RecipientTab |
新增至收件者的索引標籤。 |
信封文件
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名稱
|
name | string |
文件的名稱。 |
|
文件標識碼
|
documentId | string |
文件的 ID。 |
|
文件指南
|
documentIdGuid | string |
檔的指引。 |
收件者索引標籤
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
索引標籤識別碼
|
tabId | string |
索引標籤的識別碼。 |
|
標籤類型
|
tabType | string |
索引標籤的類型。 |
EnvelopeDocument欄位
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名稱
|
name | string |
自訂欄位的名稱。 |
|
價值觀
|
value | string |
自訂欄位的值。 |
拒絕原因無類型
物件
這是類型 'object'。