Annature (獨立發行商) (預覽版)
Annature 是澳大利亞領先的電子簽名解決方案,擁有集成的數字簽名提供商。 此連接器可協助企業使用 Annature API (v1) 建立信封並整合 Annature 文件簽署工作流程。
此連接器適用於以下產品和區域:
| 服務 | 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) |
| 連絡人 | |
|---|---|
| 名稱 | Adrian Colquhoun 博士 (Strategik) |
| URL | https://www.linkedin.com/in/adriancolquhoun/ |
| adrian@strategik.com.au |
| 連接器中繼資料 | |
|---|---|
| Publisher | Adrian Colquhoun 博士 (Strategik) |
| 網站 | https://annature.com.au |
| 隱私策略 | https://www.annature.com.au/privacy-policy |
| 類別 | 生產力 |
正在建立連線
連接器支援下列驗證類型:
| 預設值 | 建立連線的參數。 | 所有區域 | 不可共享 |
預設
適用:所有地區
建立連線的參數。
這不是可共用的連線。 如果 Power App 與其他使用者共用,系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| 安自然 ID | 字串 | 安自然 ID | 對 |
| Annature Cd-key/序號 | securestring | Annature Cd-key/序號 | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 刪除信封 |
刪除信封 |
| 取得信封 |
列出所有信封 |
| 取得收件者 |
使用建立信封回應內文中傳回的 id 屬性,取得為信封建立的單一收件人 |
| 取得文件 |
列出信封的所有文件 |
| 取得欄位 |
取得欄位 |
| 取得欄位 |
列出所有欄位 |
| 取得欄位的所有附件 |
取得欄位附件 |
| 取得範本 |
取得範本 |
| 取得範本 |
列出所有模板 |
| 建立信封 |
建立信封 |
| 從範本建立信封 |
使用範本 |
| 獲取信封 |
獲取信封 |
| 獲取帳戶 |
列出所有帳戶 |
| 獲取組織 |
獲取組織 |
| 發送信封 |
發送信封 |
| 虛空信封 |
發送信封 |
刪除信封
刪除信封
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
信封 ID
|
id | True | string |
信封 ID |
取得信封
列出所有信封
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
信封名稱
|
name | string |
清單上根據信封名稱屬性的精確比對篩選器 |
|
|
信封狀態
|
status | string |
清單上根據信封狀態的精確比對篩選器 |
|
|
收件者名稱
|
recipient | string |
清單上根據任何收件者的名稱或電子郵件屬性的完全比對篩選器 |
|
|
創建於之前
|
created_before | date |
傳回建立日期早於指定值的結果 |
|
|
建立時間
|
created_after | date |
傳回建立日期在指定值之後的結果 |
|
|
之前完成
|
completed_before | date |
傳回完成日期早於指定值的結果 |
|
|
完成時間
|
completed_after | date |
傳回完成日期在指定值之後的結果 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
|
array of object | ||
|
識別碼
|
id | string |
Id |
|
名稱
|
name | string |
名稱 |
|
訊息
|
message | string |
Message |
|
狀態
|
status | string |
地位 |
|
共享
|
shared | boolean |
共用 |
|
創建
|
created | string |
已建立 |
|
已發送
|
sent | string |
寄件日期 |
|
無效
|
voided | string |
無效 |
|
拒絕了
|
declined | string |
已拒絕 |
|
已完成
|
completed | string |
完成 |
|
結合
|
combined | string |
結合 |
|
master
|
master | string |
大師 |
|
憑證
|
certificate | string |
Certificate |
|
account_id
|
account_id | string |
帳戶 ID |
|
group_id
|
group_id | string |
群組識別碼 |
|
收件者
|
recipients | array of object | |
|
名稱
|
recipients.name | string |
名稱 |
|
電子郵件 ID
|
recipients.email | string |
電子郵件 ID |
|
行動裝置
|
recipients.mobile | string |
行動裝置 |
|
收件者類型
|
recipients.type | string |
收件者類型在未提供時預設為簽署者 |
|
Message
|
recipients.message | string |
Message |
|
密碼
|
recipients.password | ||
|
靜音?
|
recipients.muted | boolean |
這將阻止 Annature 向收件人發送任何信件 |
|
簽署訂單
|
recipients.order | integer |
簽署訂單 |
|
收件人完成信封後的目的地端點
|
recipients.redirects.session_completed | string |
收件人完成信封後的目的地端點 |
|
收件人拒絕簽署信封後的目的地端點
|
recipients.redirects.session_declined | string |
收件人拒絕簽署信封後的目的地端點 |
|
fields
|
recipients.fields | array of object | |
|
識別碼
|
recipients.fields.id | string | |
|
recipient_id
|
recipients.fields.recipient_id | string | |
|
型別
|
recipients.fields.type | string | |
|
頁面
|
recipients.fields.page | integer | |
|
x_coordinate
|
recipients.fields.x_coordinate | integer | |
|
y_coordinate
|
recipients.fields.y_coordinate | integer | |
|
為必填項目
|
recipients.fields.required | boolean |
為必填項目 |
|
Read_only
|
recipients.fields.read_only | boolean |
Read_only |
|
協作
|
recipients.fields.collaborative | boolean |
協作 |
|
寬度
|
recipients.fields.width | integer | |
|
font_size
|
recipients.fields.font_size | integer | |
|
font_type
|
recipients.fields.font_type | string | |
|
創建
|
recipients.fields.created | string |
取得收件者
使用建立信封回應內文中傳回的 id 屬性,取得為信封建立的單一收件人
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Recipient
|
id | True | string |
收件者 ID |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Id
|
id | string |
Id |
|
名稱
|
name | string |
名稱 |
|
電子郵件
|
string |
|
|
|
行動
|
mobile | string |
行動裝置 |
|
型別
|
type | string |
類型 |
|
狀態
|
status | string |
地位 |
|
訊息
|
message | string |
Message |
|
密碼
|
password |
密碼 |
|
|
靜音
|
muted | boolean |
靜音 |
|
順序
|
order | integer | |
|
declined_reason
|
declined_reason | string |
Declined_reason |
|
創建
|
created | string |
已建立 |
|
已發送
|
sent | string |
寄件日期 |
|
拒絕了
|
declined | string |
已拒絕 |
|
已完成
|
completed | string |
完成 |
|
session_completed
|
redirects.session_completed | string |
Session_completed |
|
session_declined
|
redirects.session_declined | string |
Session_declined |
取得文件
列出信封的所有文件
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
信封 ID
|
envelope_id | True | string |
信封 ID |
|
端點持續時間
|
endpoint_duration | integer |
設定原始端點和主要端點可存取的分鐘數。 數字的範圍介於 1 到 10080 之間,預設值為 60 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
|
array of object | ||
|
Id
|
id | string |
Id |
|
名稱
|
name | string |
名稱 |
|
pages
|
pages | integer | |
|
原始
|
original | string |
原始 |
|
大師
|
master | string |
大師 |
|
已建立
|
created | string |
已建立 |
取得欄位
取得欄位
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
信封 ID
|
envelope_id | True | string |
信封 ID |
|
欄位識別碼
|
id | True | string |
欄位識別碼 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | string |
Id |
|
recipient_id
|
recipient_id | string |
收件者 ID |
|
型別
|
type | string |
類型 |
|
頁面
|
page | integer | |
|
錨點
|
anchor | string |
Anchor |
|
x_coordinate
|
x_coordinate | integer | |
|
y_coordinate
|
y_coordinate | integer | |
|
為必填項目
|
required | boolean |
為必填項目 |
|
Read_only
|
read_only | boolean |
Read_only |
|
協作
|
collaborative | boolean |
允許信封上的其他收件人修改值 |
|
value
|
value | string |
欄位的值 |
|
已核對
|
checked | boolean |
已核對 |
|
height
|
height | integer | |
|
寬度
|
width | integer | |
|
options
|
options | ||
|
font_size
|
font_size | integer | |
|
font_type
|
font_type | string |
可能的值是 courier 和 helvetica |
|
date_format
|
date_format | string |
日期格式 |
|
創建
|
created | string |
已建立 |
取得欄位
列出所有欄位
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
信封 ID
|
envelope_id | True | string |
信封 ID |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
|
array of object | ||
|
識別碼
|
id | string | |
|
recipient_id
|
recipient_id | string | |
|
型別
|
type | string | |
|
頁面
|
page | integer | |
|
錨點
|
anchor | string | |
|
x_coordinate
|
x_coordinate | integer | |
|
y_coordinate
|
y_coordinate | integer | |
|
為必填項目
|
required | boolean |
為必填項目 |
|
Read_only
|
read_only | boolean |
Read_only |
|
協作
|
collaborative | boolean |
協作 |
|
value
|
value | string | |
|
已核對
|
checked | boolean |
已核對 |
|
height
|
height | integer | |
|
寬度
|
width | integer | |
|
options
|
options | ||
|
font_size
|
font_size | integer | |
|
font_type
|
font_type | string | |
|
date_format
|
date_format | string | |
|
創建
|
created | string |
取得欄位的所有附件
取得欄位附件
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
信封 ID
|
envelope_id | True | string |
信封 ID |
|
欄位識別碼
|
id | True | string |
欄位識別碼 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
|
array of object | ||
|
識別碼
|
id | string | |
|
源語言
|
original | string | |
|
名稱
|
name | string | |
|
型別
|
type | string | |
|
size
|
size | integer | |
|
創建
|
created | string |
取得範本
取得範本
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
範本識別碼
|
id | True | string |
範本識別碼 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | string | |
|
名稱
|
name | string | |
|
共用
|
shared | boolean |
共用 |
|
envelope_name
|
envelope_name | string | |
|
envelope_message
|
envelope_message | string | |
|
Envelope_shared
|
envelope_shared | boolean |
Envelope_shared |
|
創建
|
created | string | |
|
account_id
|
account_id | string | |
|
group_id
|
group_id | string | |
|
檔
|
documents | array of object | |
|
Id
|
documents.id | string |
Id |
|
名稱
|
documents.name | string |
名稱 |
|
pages
|
documents.pages | integer | |
|
原始
|
documents.original | string |
原始 |
|
大師
|
documents.master | string |
大師 |
|
已建立
|
documents.created | string |
已建立 |
|
角色
|
roles | array of object | |
|
Id
|
roles.id | string |
Id |
|
名稱
|
roles.name | string |
名稱 |
|
收件者名稱
|
roles.recipient_name | string |
收件者名稱 |
|
收件者電子郵件
|
roles.recipient_email | string |
收件者電子郵件 |
|
收件者手機
|
roles.recipient_mobile | string |
收件者手機 |
|
收件者類型
|
roles.recipient_type | string |
收件者類型在未提供時預設為簽署者 |
|
密碼
|
roles.recipient_password | string |
密碼 |
|
簽署訂單
|
roles.order | integer |
簽署訂單 |
|
收件人完成信封後的目的地端點
|
roles.recipient_redirects.session_completed | string |
收件人完成信封後的目的地端點 |
|
收件人拒絕簽署信封後的目的地端點
|
roles.recipient_redirects.session_declined | string |
收件人拒絕簽署信封後的目的地端點 |
取得範本
列出所有模板
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
名稱
|
name | string |
根據範本在清單上進行精確比對篩選 |
|
|
創建於之前
|
created_before | date |
傳回建立日期早於指定值的結果 |
|
|
建立時間
|
created_after | date |
傳回建立日期在指定值之後的結果 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
|
array of object | ||
|
識別碼
|
id | string | |
|
名稱
|
name | string | |
|
共用
|
shared | boolean |
共用 |
|
envelope_name
|
envelope_name | string | |
|
envelope_message
|
envelope_message | string | |
|
Envelope_shared
|
envelope_shared | boolean |
Envelope_shared |
|
創建
|
created | string | |
|
account_id
|
account_id | string | |
|
group_id
|
group_id | string | |
|
檔
|
documents | array of object | |
|
Id
|
documents.id | string |
Id |
|
名稱
|
documents.name | string |
名稱 |
|
pages
|
documents.pages | integer | |
|
原始
|
documents.original | string |
原始 |
|
大師
|
documents.master | string |
大師 |
|
已建立
|
documents.created | string |
已建立 |
|
角色
|
roles | array of object | |
|
Id
|
roles.id | string |
Id |
|
名稱
|
roles.name | string |
名稱 |
|
收件者名稱
|
roles.recipient_name | string |
收件者名稱 |
|
收件者電子郵件
|
roles.recipient_email | string |
收件者電子郵件 |
|
收件者手機
|
roles.recipient_mobile | string |
收件者手機 |
|
收件者類型
|
roles.recipient_type | string |
收件者類型在未提供時預設為簽署者 |
|
密碼
|
roles.recipient_password | string |
密碼 |
|
簽署訂單
|
roles.order | integer |
簽署訂單 |
|
收件人完成信封後的目的地端點
|
roles.recipient_redirects.session_completed | string |
收件人完成信封後的目的地端點 |
|
收件人拒絕簽署信封後的目的地端點
|
roles.recipient_redirects.session_declined | string |
收件人拒絕簽署信封後的目的地端點 |
建立信封
建立信封
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
名稱
|
name | True | string |
信封的名稱,顯示在傳送給收件人的電子郵件主旨中,以及檢視信封時 |
|
Message
|
message | string |
Message |
|
|
共用
|
shared | boolean |
共用 |
|
|
是草稿
|
draft | boolean |
是草稿 |
|
|
帳戶識別碼
|
account_id | True | string |
帳戶識別碼 |
|
群組識別碼
|
group_id | string |
群組識別碼 |
|
|
群組識別碼
|
id | string |
群組識別碼 |
|
|
名稱
|
name | string |
名稱 |
|
|
類型
|
type | string |
類型 |
|
|
檔案內容
|
base | byte |
檔案內容 |
|
|
名稱
|
name | string |
名稱 |
|
|
電子郵件 ID
|
string |
電子郵件 ID |
||
|
行動裝置
|
mobile | string |
行動裝置 |
|
|
收件者類型
|
type | string |
收件者類型在未提供時預設為簽署者 |
|
|
Message
|
message | string |
Message |
|
|
密碼
|
password | string | ||
|
靜音?
|
muted | boolean |
這將阻止 Annature 向收件人發送任何信件 |
|
|
簽署訂單
|
order | integer |
簽署訂單 |
|
|
會議完成
|
session_completed | string |
收件人完成信封後的目的地端點 |
|
|
會話已拒絕
|
session_declined | string |
收件人拒絕簽署信封後的目的地端點 |
|
|
識別碼
|
id | string | ||
|
recipient_id
|
recipient_id | string | ||
|
型別
|
type | string |
欄位類型 |
|
|
頁面
|
page | integer | ||
|
x_coordinate
|
x_coordinate | integer | ||
|
y_coordinate
|
y_coordinate | integer | ||
|
為必填項目
|
required | boolean |
為必填項目 |
|
|
唯讀模式
|
read_only | boolean |
唯讀模式 |
|
|
協作
|
collaborative | boolean |
協作 |
|
|
寬度
|
width | integer | ||
|
font_size
|
font_size | integer | ||
|
font_type
|
font_type | string |
可能的值是 courier 和 helvetica |
|
|
創建
|
created | string |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | string |
Id |
|
名稱
|
name | string |
名稱 |
|
訊息
|
message | string |
Message |
|
狀態
|
status | string |
地位 |
|
共用
|
shared | boolean |
共用 |
|
創建日期
|
created | string |
創建日期 |
|
發送時間
|
sent | string |
發送時間 |
|
無效
|
voided | ||
|
拒絕了
|
declined | ||
|
已完成
|
completed | ||
|
帳戶 ID
|
account_id | string |
Account_id |
|
群組識別碼
|
group_id | string |
群組識別碼 |
|
收件人
|
recipients | array of object | |
|
識別碼
|
recipients.id | string | |
|
名稱
|
recipients.name | string | |
|
電子郵件
|
recipients.email | string | |
|
行動
|
recipients.mobile | string | |
|
型別
|
recipients.type | string | |
|
狀態
|
recipients.status | string | |
|
訊息
|
recipients.message | string | |
|
密碼
|
recipients.password |
密碼 |
|
|
靜音
|
recipients.muted | boolean |
靜音 |
|
順序
|
recipients.order | integer | |
|
declined_reason
|
recipients.declined_reason | ||
|
創建
|
recipients.created | string | |
|
已發送
|
recipients.sent | string | |
|
拒絕了
|
recipients.declined | ||
|
已完成
|
recipients.completed | ||
|
session_completed
|
recipients.redirects.session_completed | string | |
|
session_declined
|
recipients.redirects.session_declined | string |
從範本建立信封
使用範本
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
範本識別碼
|
id | True | string |
範本識別碼 |
|
名稱
|
name | string |
信封的名稱,顯示在傳送給收件人的電子郵件主旨中,以及檢視信封時 |
|
|
是草稿
|
draft | boolean |
是草稿 |
|
|
Message
|
message | string |
Message |
|
|
共用
|
shared | boolean |
共用 |
|
|
帳戶識別碼
|
account_id | True | string |
帳戶識別碼 |
|
群組識別碼
|
group_id | string |
群組識別碼 |
|
|
群組識別碼
|
id | string |
群組識別碼 |
|
|
名稱
|
name | string |
名稱 |
|
|
群組識別碼
|
type | string |
群組識別碼 |
|
|
檔案內容
|
base | byte |
檔案內容 |
|
|
角色識別碼
|
role_id | string |
角色識別碼 |
|
|
名稱
|
name | string |
名稱 |
|
|
電子郵件 ID
|
string |
電子郵件 ID |
||
|
行動裝置
|
mobile | string |
行動裝置 |
|
|
簡訊驗證
|
sms_auth | string |
簡訊驗證 |
|
|
收件者類型
|
type | string |
收件者類型在未提供時預設為簽署者 |
|
|
Message
|
message | string |
Message |
|
|
密碼
|
password | string | ||
|
靜音?
|
muted | boolean |
這將阻止 Annature 向收件人發送任何信件 |
|
|
簽署訂單
|
order | integer |
簽署訂單 |
|
|
欄位識別碼 (來自範本)
|
id | True | string |
範本欄位的ID |
|
價值觀
|
value | True | string |
此欄位的值 |
|
收件人完成信封後的目的地端點
|
session_completed | string |
收件人完成信封後的目的地端點 |
|
|
收件人拒絕簽署信封後的目的地端點
|
session_declined | string |
收件人拒絕簽署信封後的目的地端點 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | string |
Id |
|
名稱
|
name | string |
名稱 |
|
訊息
|
message | string |
Message |
|
共享
|
shared | boolean |
是共享的嗎? |
|
草稿
|
draft | boolean | |
|
account_id
|
account_id | string |
帳戶 ID |
|
group_id
|
group_id | string |
群組識別碼 |
|
檔
|
documents | array of object | |
|
Id
|
documents.id | string |
Id |
|
名稱
|
documents.name | string |
名稱 |
|
pages
|
documents.pages | integer | |
|
原始
|
documents.original | string |
原始 |
|
大師
|
documents.master | string |
大師 |
|
已建立
|
documents.created | string |
已建立 |
|
收件人
|
recipients | array of object | |
|
role_id
|
recipients.role_id | string | |
|
名稱
|
recipients.name | string | |
|
電子郵件
|
recipients.email | string | |
|
行動
|
recipients.mobile | string | |
|
訊息
|
recipients.message | string | |
|
密碼
|
recipients.password | boolean | |
|
靜音
|
recipients.muted | boolean | |
|
session_completed
|
recipients.redirects.session_completed | string | |
|
session_declined
|
recipients.redirects.session_declined | string |
獲取信封
獲取信封
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
信封 ID
|
id | True | string |
信封 ID |
|
端點持續時間
|
endpoint_duration | integer |
設定原始端點和主要端點可存取的分鐘數。 數字的範圍介於 1 到 10080 之間,預設值為 60 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | string |
Id |
|
名稱
|
name | string |
名稱 |
|
訊息
|
message | string |
Message |
|
狀態
|
status | string |
地位 |
|
共享
|
shared | boolean |
共用 |
|
創建
|
created | string |
已建立 |
|
已發送
|
sent | string |
寄件日期 |
|
無效
|
voided | string |
無效 |
|
拒絕了
|
declined | string |
已拒絕 |
|
已完成
|
completed | string |
完成 |
|
master
|
master | string |
大師 |
|
結合
|
combined | string |
結合 |
|
憑證
|
certificate | string |
Certificate |
|
account_id
|
account_id | string |
帳戶 ID |
|
group_id
|
group_id | string |
群組識別碼 |
|
收件者
|
recipients | array of object | |
|
名稱
|
recipients.name | string |
名稱 |
|
電子郵件 ID
|
recipients.email | string |
電子郵件 ID |
|
行動裝置
|
recipients.mobile | string |
行動裝置 |
|
收件者類型
|
recipients.type | string |
收件者類型在未提供時預設為簽署者 |
|
Message
|
recipients.message | string |
Message |
|
密碼
|
recipients.password | ||
|
靜音?
|
recipients.muted | boolean |
這將阻止 Annature 向收件人發送任何信件 |
|
簽署訂單
|
recipients.order | integer |
簽署訂單 |
|
收件人完成信封後的目的地端點
|
recipients.redirects.session_completed | string |
收件人完成信封後的目的地端點 |
|
收件人拒絕簽署信封後的目的地端點
|
recipients.redirects.session_declined | string |
收件人拒絕簽署信封後的目的地端點 |
|
fields
|
recipients.fields | array of object | |
|
識別碼
|
recipients.fields.id | string | |
|
recipient_id
|
recipients.fields.recipient_id | string | |
|
型別
|
recipients.fields.type | string | |
|
頁面
|
recipients.fields.page | integer | |
|
x_coordinate
|
recipients.fields.x_coordinate | integer | |
|
y_coordinate
|
recipients.fields.y_coordinate | integer | |
|
為必填項目
|
recipients.fields.required | boolean |
為必填項目 |
|
Read_only
|
recipients.fields.read_only | boolean |
Read_only |
|
協作
|
recipients.fields.collaborative | boolean |
協作 |
|
寬度
|
recipients.fields.width | integer | |
|
font_size
|
recipients.fields.font_size | integer | |
|
font_type
|
recipients.fields.font_type | string | |
|
創建
|
recipients.fields.created | string |
獲取帳戶
列出所有帳戶
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
|
array of object | ||
|
識別碼
|
id | string | |
|
名稱
|
name | string |
名稱 |
|
Email
|
string |
|
|
|
數字
|
number | string | |
|
timezone
|
timezone | string | |
|
角色
|
role | string | |
|
活動中
|
active | boolean | |
|
group_id
|
group_id | string | |
|
創建
|
created | string | |
|
已驗證
|
verified | string |
獲取組織
獲取組織
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | string |
Id |
|
名稱
|
name | string |
名稱 |
|
商
|
business | string |
商業 |
|
電子郵件
|
string |
|
|
|
數字
|
number | string |
Number |
|
address
|
address | string |
Address |
|
網站
|
website | string |
網站 |
|
標誌
|
logo | string |
商標 |
|
顏色
|
colour | string |
顏色 |
|
創建
|
created | string |
已建立 |
發送信封
發送信封
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
信封 ID
|
id | True | string |
信封 ID |
虛空信封
發送信封
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
信封 ID
|
id | True | string |
信封 ID |
觸發程序
| 事件觸發程序 - 信封和收件人 |
當信封完成或收件人檢視時發生事件時觸發 |
事件觸發程序 - 信封和收件人
定義
WebhookEvent內容
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
事件
|
event | string | |
|
envelope_id
|
envelope_id | string | |
|
無效
|
voided | string | |
|
已完成
|
completed | string | |
|
master
|
master | string | |
|
憑證
|
certificate | string | |
|
已發送
|
sent | string | |
|
方法
|
method | string | |
|
recipient_id
|
recipient_id | string | |
|
已查看
|
viewed | string | |
|
拒絕了
|
declined | string | |
|
declined_reason
|
declined_reason | string | |
|
失敗
|
failed | string | |
|
诊断
|
diagnosis | string |