GetAccept
GetAccept 為銷售人員提供了一個銷售支持平台，用於設計、發送、推廣、跟踪和電子簽署銷售文檔，在一個地方利用銷售資料、合同管理、提案和電子簽名。
此連接器適用於以下產品和區域：
| 服務 | 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） |
| 連絡人 | |
|---|---|
| 名稱 | GetAccept API 團隊 |
| URL | https://app.getaccept.com/api |
| integrations@getaccept.com |
| 連接器中繼資料 | |
|---|---|
| Publisher | GetAccept 公司 |
| 網站 | https://www.getaccept.com |
| 隱私策略 | https://www.getaccept.com/privacy-policy |
| 類別 | 銷售和客戶關係管理;生產力 |
GetAccept 為銷售人員提供了一個銷售支持平台，用於設計、發送、推廣、跟踪和電子簽署銷售文檔，在一個地方利用銷售資料、合同管理、提案和電子簽名。 此連接器有助於自動化文件儲存、擷取、任務指派和自訂通知的工作流程。
先決條件
需要 GetAccept 帳戶才能使用此連線。 前往 getaccept.com 註冊一個免費帳戶。
如何取得憑證？
只需要有效的 GetAccept 帳戶，因為 OAuth2 用於驗證 GetAccept 中目前登入的使用者。
已知問題與限制
請聯絡我們的 [mailto：support@getaccept.com]（技術支援） 以解決任何與整合相關的問題。
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 上傳影片 |
您可以上傳附件檔，以包含在您傳送的文件中。 成功的請求將返回attachment_id。 使用 attachment_id 將附件指派給文件。 |
| 上傳文件檔案 |
您可以一次上傳一個檔案並取得檔案 ID。檔案 ID 可用來將檔案與傳送給收件者的 GetAccept 檔案連線。 如果您想上傳多個文件，請運行多個 POST。 我們只接受最大 10 MB 的檔案作為預設。 上傳的檔案需要在上傳後 48 小時內匯入/新增至文件。 我們建議您上傳 PDF 文件，以確保發送時的外觀相同。 可以轉換其他檔案類型，例如： Mirosoft Office：doc、docx、xl、xls、xlsx、ppt、pptx Mac：數字、鍵 圖像：jpg、jpeg、png 其他：html、tex、csv |
| 上傳附件 |
您可以上傳附件檔，以包含在您傳送的文件中。 成功的請求將返回attachment_id。 使用 attachment_id 將附件指派給文件。 |
| 下載文件 |
文檔文件始終可以下載，但您很可能希望在它處於“已簽名”狀態時下載它。 您可以選擇接收下載網址或取得二進位檔案。 下載網址可在提出要求後 10 分鐘存取。 |
| 傳送現有文件 |
當您透過 GetAccept 傳送文件時，我們會向所有收件者發送一封電子郵件，每個收件者都包含一個唯一的安全連結。 此 API 呼叫會觸發文件傳送動作，且只能對 document_status = 草稿的文件執行。 文件將傳送給您在建立文件時提供的收件者。 如果文件是使用自我簽署選項建立的，則在傳送之前，也將由經過驗證或指定的使用者自行簽署。 |
| 列出使用者 |
擷取目前已驗證實體的作用中使用者清單 |
| 列出文件 |
取得可用文件清單 |
| 列出聯絡人 |
接收目前實體的可用聯絡人清單。 新增為收件者的所有連絡人都會儲存為連絡人，並可供稍後在該實體上使用。 |
| 列出視頻 |
接收有關該實體的可用視頻列表。 您可以在移動應用程序或 GetAccept 中添加新視頻。 |
| 列出附件 |
接收可用附件的清單。 您可以使用新文件在 GetAccept 中新增附件。 |
| 取得使用者詳細資料 |
此呼叫將傳回單一使用者的詳細資料。 使用 user-id me 接收目前已驗證使用者的詳細資料和可用實體 |
| 取得文件收件者 |
取得特定文件的收件者清單。 |
| 取得文件欄位 |
取得文件或範本的欄位清單。 可在簽署文件之前和之後使用。 |
| 取得文件詳細資料 |
透過指定文件 ID 來取得文件詳細資料。 |
| 取得文件附件 |
透過指定文件 ID 來取得文件附件。 |
| 取得範本定價表 |
接收特定範本的定價表項目清單。 |
| 取得範本欄位 |
接收特定範本的欄位清單。 |
| 取得範本角色 |
接收特定範本的角色清單。 |
| 建立使用者 |
這將在資料庫中為目前實體建立一個新聯絡人 |
| 建立和傳送文件或範本 |
您必須建立文件，才能將其傳送給收件者。 創建文檔時，您可以使用file_id參考以前上傳的文件，也可以選擇創建文檔並在 API 帖子上上傳文件。 在建立文件 POST 中包含檔案時，您只能上傳一個檔案。 使用任一file_ids參數來使用現有上傳的檔案，file_content以 base64 編碼字串的形式傳送文件，或使用檔案參數執行多部分發布。 所有收件人必須擁有有效的電子郵件或手機號碼。 所有事件都會使用請求者 IP 位址記錄。 您可以使用包含一般使用者公用 IP 位址的標頭CLIENT_IP覆寫此專案。 |
| 建立連絡人 |
這將在資料庫中為目前實體建立一個新聯絡人 |
| 更新文件到期 |
使用此方法來更新文件的到期日期和時間。 |
| 清單範本 |
接收可用文件範本的清單。 您可以在 GetAccept 的 [範本] 區段下新增範本。 |
上傳影片
您可以上傳附件檔，以包含在您傳送的文件中。 成功的請求將返回attachment_id。 使用 attachment_id 將附件指派給文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
檔案內容
|
file_content | string |
以 base64 編碼的方式傳送檔案。 請注意，base64 編碼檔案將使檔案大小增加約 30% |
|
|
檔案名稱
|
file_name | string |
文件的檔案名稱，副檔名。 這將有助於轉換不同的文件類型。 |
|
|
檔案網址
|
file_url | string |
文件檔案的 URL。 檔案必須在未經任何授權的情況下可供下載 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
檔案狀態
|
file_status | string |
視頻狀態 |
|
檔案名稱
|
filename | string |
影片檔案名稱 |
|
作業識別碼
|
job_id | string |
轉換和壓縮視訊的處理作業的 ID。 使用 /video/job/<ID> 輪詢工作狀態更新。 |
|
視訊 ID
|
video_id | string |
建立文件時要用於video_id的上傳影片的 ID |
上傳文件檔案
您可以一次上傳一個檔案並取得檔案 ID。檔案 ID 可用來將檔案與傳送給收件者的 GetAccept 檔案連線。 如果您想上傳多個文件，請運行多個 POST。 我們只接受最大 10 MB 的檔案作為預設。 上傳的檔案需要在上傳後 48 小時內匯入/新增至文件。
我們建議您上傳 PDF 文件，以確保發送時的外觀相同。 可以轉換其他檔案類型，例如：
Mirosoft Office：doc、docx、xl、xls、xlsx、ppt、pptx Mac：數字、鍵 圖像：jpg、jpeg、png 其他：html、tex、csv
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
檔案內容
|
file_content | string |
以 base64 編碼的方式傳送檔案。 請注意，base64 編碼檔案將使檔案大小增加約 30% |
|
|
檔案名稱
|
file_name | string |
文件的檔案名稱，副檔名。 這將有助於轉換不同的文件類型。 |
|
|
檔案網址
|
file_url | string |
文件檔案的 URL。 檔案必須在未經任何授權的情況下可供下載 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
檔案識別碼 (file_id)
|
file_id | string |
建立文件時要在file_ids中使用的上傳檔案的 ID |
|
file_status
|
file_status | string |
上傳檔案的狀態 |
上傳附件
您可以上傳附件檔，以包含在您傳送的文件中。 成功的請求將返回attachment_id。 使用 attachment_id 將附件指派給文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
檔案內容
|
file_content | string |
以 base64 編碼的方式傳送檔案。 請注意，base64 編碼檔案將使檔案大小增加約 30% |
|
|
檔案名稱
|
file_name | string |
文件的檔案名稱，副檔名。 這將有助於轉換不同的文件類型。 |
|
|
檔案網址
|
file_url | string |
文件檔案的 URL。 檔案必須在未經任何授權的情況下可供下載 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
檔案名稱
|
filename | string |
附件的檔案名稱 |
|
附件 ID
|
id | string |
建立文件時要在attachment_id中使用的上傳附件的 ID |
|
附件標題
|
title | string |
附件標題 |
|
附件類型
|
type | string |
附件類型 |
下載文件
文檔文件始終可以下載，但您很可能希望在它處於“已簽名”狀態時下載它。
您可以選擇接收下載網址或取得二進位檔案。
下載網址可在提出要求後 10 分鐘存取。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文件 ID
|
documentId | True | string |
文件 ID |
|
直接傳回二進位檔
|
direct | string |
直接傳回二進位檔 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
document_url
|
document_url | string | |
|
檔案
|
file | string |
傳送現有文件
當您透過 GetAccept 傳送文件時，我們會向所有收件者發送一封電子郵件，每個收件者都包含一個唯一的安全連結。 此 API 呼叫會觸發文件傳送動作，且只能對 document_status = 草稿的文件執行。 文件將傳送給您在建立文件時提供的收件者。
如果文件是使用自我簽署選項建立的，則在傳送之前，也將由經過驗證或指定的使用者自行簽署。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文件 ID
|
documentId | True | string |
文件 ID |
|
sender_email
|
sender_email |
使用此選項可依電子郵件地址指定要用於對文件進行自我簽署的電子郵件地址的寄件者使用者/擁有者。 |
||
|
sender_id
|
sender_id | string |
使用此選項可依 ID 指定要用於對文件進行自我簽署的寄件者使用者/擁有者。 |
傳回
文件是一個或多個上傳的檔案，要傳送給使用者建立的一或多個收件者。
- 文件
- Document
列出使用者
列出文件
取得可用文件清單
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
狀態篩選清單
|
filter | string |
狀態篩選清單 |
|
|
如何排序結果
|
sort_by | string |
如何排序結果 |
|
|
結果的排序順序
|
sort_order | string |
結果的排序順序 |
|
|
包含來自團隊成員的文件
|
showteam | boolean |
包含來自團隊成員的文件 |
|
|
包括實體的所有文件
|
showall | boolean |
包括實體的所有文件 |
|
|
外部 ID
|
external_id | string |
外部 ID 是自訂欄位，可以包含來自 GetAccept 外部系統的唯一記錄識別碼 |
|
|
Offset
|
offset | number |
從記錄 x 開始清單，直到限制為止 |
|
|
限制
|
limit | number |
要列出的記錄數 |
傳回
文件清單
- 物品
- Documents
列出聯絡人
列出視頻
接收有關該實體的可用視頻列表。 您可以在移動應用程序或 GetAccept 中添加新視頻。
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
videos
|
videos | array of object | |
|
可編輯
|
videos.editable | boolean | |
|
發表
|
videos.published | boolean | |
|
已保存
|
videos.saved | boolean | |
|
thumb_url
|
videos.thumb_url | string | |
|
video_id
|
videos.video_id | string | |
|
video_title
|
videos.video_title | string | |
|
video_type
|
videos.video_type | string | |
|
video_url
|
videos.video_url | string |
列出附件
取得使用者詳細資料
此呼叫將傳回單一使用者的詳細資料。 使用 user-id me 接收目前已驗證使用者的詳細資料和可用實體
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
使用者識別碼
|
userId | True | string |
使用者識別碼 |
傳回
使用者由其電子郵件地址定義，並連線到一或多個實體。
使用者角色
系統管理員：
- 查看所有文件
- 編輯所有文件
- 變更實體設定、資訊和帳單
- 將新使用者新增至實體
- 指派實體角色
經理：
- 檢視小組文件
- 編輯所有文件
- 將新使用者新增至實體
實體
實體是頂端節點，所有使用者及對應文件都連接至實體。 實體通常與大型組織中的公司、國家或部門相同。
- User
- User
取得文件收件者
取得文件欄位
取得文件或範本的欄位清單。 可在簽署文件之前和之後使用。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文件 ID
|
documentId | True | string |
文件 ID |
傳回
欄位清單
- Fields
- Fields
取得文件詳細資料
透過指定文件 ID 來取得文件詳細資料。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文件 ID
|
documentId | True | string |
文件 ID |
傳回
文件是一個或多個上傳的檔案，要傳送給使用者建立的一或多個收件者。
- 文件
- Document
取得文件附件
透過指定文件 ID 來取得文件附件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文件 ID
|
documentId | True | string |
文件 ID |
傳回
附件清單
- Attachments
- Attachments
取得範本定價表
接收特定範本的定價表項目清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
範本識別碼
|
templateId | True | string |
範本識別碼 |
傳回
定價表
- Pricing
- PricingTables
取得範本欄位
取得範本角色
接收特定範本的角色清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
範本識別碼
|
templateId | True | string |
範本識別碼 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
角色
|
roles | array of object | |
|
電子郵件
|
roles.email | string | |
|
first_name
|
roles.first_name | string | |
|
last_name
|
roles.last_name | string | |
|
行動
|
roles.mobile | string | |
|
角色
|
roles.role | string | |
|
role_id
|
roles.role_id | string | |
|
role_name
|
roles.role_name | string |
建立使用者
這將在資料庫中為目前實體建立一個新聯絡人
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
company_name
|
company_name | string |
關聯公司名稱 |
|
|
company_number
|
company_number | string |
關聯公司編號 |
|
|
電子郵件
|
string |
聯絡人的電子郵件地址 |
||
|
first_name
|
first_name | string |
聯絡人的名字 |
|
|
全名
|
fullname | string |
用於指定全名而不是名字/姓氏 |
|
|
last_name
|
last_name | string |
聯絡人的姓氏 |
|
|
行動
|
mobile | string |
國際格式的手機號碼 |
|
|
注意
|
note | string |
可選的內部聯繫註釋 |
|
|
phone
|
phone | string |
國際格式的電話號碼 |
|
|
title
|
title | string |
連絡人的職稱，例如。 執行長、銷售經理 |
傳回
使用者由其電子郵件地址定義，並連線到一或多個實體。
使用者角色
系統管理員：
- 查看所有文件
- 編輯所有文件
- 變更實體設定、資訊和帳單
- 將新使用者新增至實體
- 指派實體角色
經理：
- 檢視小組文件
- 編輯所有文件
- 將新使用者新增至實體
實體
實體是頂端節點，所有使用者及對應文件都連接至實體。 實體通常與大型組織中的公司、國家或部門相同。
- User
- User
建立和傳送文件或範本
您必須建立文件，才能將其傳送給收件者。 創建文檔時，您可以使用file_id參考以前上傳的文件，也可以選擇創建文檔並在 API 帖子上上傳文件。 在建立文件 POST 中包含檔案時，您只能上傳一個檔案。
使用任一file_ids參數來使用現有上傳的檔案，file_content以 base64 編碼字串的形式傳送文件，或使用檔案參數執行多部分發布。
所有收件人必須擁有有效的電子郵件或手機號碼。
所有事件都會使用請求者 IP 位址記錄。 您可以使用包含一般使用者公用 IP 位址的標頭CLIENT_IP覆寫此專案。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ID
|
id | string |
從清單或上傳後收到的附件 ID |
|
|
需要檢視
|
require_view | boolean |
要求收件者檢視附件 |
|
|
類型
|
type | string |
檔案或外部，其中檔案是上傳的檔案，外部是外部檔案的連結 |
|
|
欄位識別碼
|
id | string |
自訂範本欄位的ID |
|
|
欄位名稱
|
name | string |
自訂範本欄位的名稱 |
|
|
欄位值
|
value | string |
自訂範本欄位的值 |
|
|
貨幣
|
currency | string |
貨幣，例如。 瑞典克朗 |
|
|
Locale
|
locale | string |
地區設定，例如 sv-SE |
|
|
顯示名稱
|
display_name | string |
定價表的顯示名稱 |
|
|
外部 ID
|
external_id | string |
外部 ID 以代表協力廠商系統內的摘要物件 |
|
|
表格 ID
|
id | string |
表格 ID |
|
|
預先計算的總計
|
pre_calculated | boolean |
如果應預先計算定價表總計 |
|
|
顯示名稱
|
display_name | string |
定價表的顯示名稱 |
|
|
ID
|
id | string |
區段 ID |
|
|
Rows
|
rows |
具有值的數組物件具有column_id數組，值 |
||
|
已啟用
|
enabled | boolean |
如果應啟用區段折扣 |
|
|
固定費用
|
flat_fee | boolean |
如果部分應該使用固定費用折扣 |
|
|
折扣值
|
value | string |
區段折扣的值 |
|
|
已啟用
|
enabled | boolean |
如果應啟用區段價格 |
|
|
固定費用
|
flat_fee | boolean |
如果部分應該使用固定費用定價 |
|
|
價格價值
|
value | string |
區段價格的值 |
|
|
已啟用
|
enabled | boolean |
如果應啟用區段稅金 |
|
|
固定費用
|
flat_fee | boolean |
如果部分應使用固定費用稅 |
|
|
稅值
|
value | string |
部分稅的價值 |
|
|
已啟用
|
enabled | boolean |
如果應啟用定價表折扣 |
|
|
固定費用
|
flat_fee | boolean |
如果定價表應使用固定費用折扣 |
|
|
折扣值
|
value | string |
摘要折扣的值 |
|
|
已啟用
|
enabled | boolean |
如果應啟用定價表價格 |
|
|
固定費用
|
flat_fee | boolean |
如果定價表應使用固定費用定價 |
|
|
價格價值
|
value | string |
摘要價格的值 |
|
|
已啟用
|
enabled | boolean |
如果應啟用定價表稅金 |
|
|
固定費用
|
flat_fee | boolean |
如果定價表應使用固定費用稅 |
|
|
價值觀
|
value | string |
摘要稅的價值 |
|
|
到期日期
|
expiration_date | date-time |
文件到期的日期和時間 |
|
|
外部 ID
|
external_id | string |
用於識別的外部系統 ID |
|
|
檔案內容
|
file_content | string |
Base64 編碼的檔案內容 |
|
|
檔案 ID
|
file_ids | string |
上傳檔案時收到的逗號分隔的唯一檔案 ID |
|
|
檔案名稱
|
file_name | string |
文件的檔案名稱，副檔名。 這將有助於轉換不同的文件類型。 |
|
|
檔案網址
|
file_url | string |
文件檔案的 URL。 文件必須公開可供下載 |
|
|
自動發送
|
is_automatic_sending | boolean |
如果文件應在建立後傳送 |
|
|
傳送提醒
|
is_reminder_sending | boolean |
是否應該發送自動提醒 |
|
|
排程傳送
|
is_scheduled_sending | boolean |
傳送是否應該排程在未來傳送 |
|
|
簽署文件
|
is_signing | boolean |
文件是否應該被發送以供簽署 |
|
|
手寫簽名
|
is_signing_biometric | boolean |
使用手寫簽名 |
|
|
允許簽章轉移
|
is_signing_forward | boolean |
收件者是否能夠轉移簽名權限 |
|
|
使用姓名縮寫簽名
|
is_signing_initials | boolean |
使用收件者姓名縮寫簽署文件 |
|
|
發送短信
|
is_sms_sending | boolean |
文件是否應該透過簡訊傳送給收件者手機 |
|
|
文件名稱
|
name | True | string |
輸入文件的名稱 |
|
公司名稱
|
company_name | string |
收件人的公司名稱 |
|
|
公司編號
|
company_number | string |
收件人的公司編號 |
|
|
Email
|
string |
收件者的電子郵件地址 |
||
|
名字
|
first_name | string |
收件人名字 |
|
|
姓氏
|
last_name | string |
收件人姓氏 |
|
|
行動裝置
|
mobile | string |
國際格式的手機 |
|
|
備註
|
note | string |
收件人的附加附註 |
|
|
簽署順序
|
order_num | integer |
如果已啟用簽署順序 |
|
|
收件者類型
|
role | string |
文件中的收件者類型 |
|
|
範本角色
|
role_name | string |
範本中的角色名稱 |
|
|
驗證 EID
|
verify_eid | boolean |
使用 EID 進行驗證 |
|
|
EID 類型
|
verify_eid_type | string |
用於個人驗證的 EID 類型 |
|
|
啟用問題
|
verify_qna | boolean |
是否應該提出問題 |
|
|
驗證答案
|
verify_qna_answer | string |
問題的答案 |
|
|
關於開放的質詢
|
verify_qna_open | boolean |
打開文件前應提出問題 |
|
|
驗證問題
|
verify_qna_question | string |
要求驗證的問題 |
|
|
簽名問題
|
verify_qna_sign | boolean |
簽字前應否問一個問題 |
|
|
驗證簡訊
|
verify_sms | boolean |
透過簡訊驗證收件人 |
|
|
在開啟時驗證簡訊
|
verify_sms_open | boolean |
在開啟時驗證簡訊 |
|
|
透過簡訊驗證
|
verify_sms_sign | boolean |
簡訊是否應該在簽署前驗證收件者 |
|
|
排程傳送日期
|
scheduled_sending_time | date-time |
應發送文件的日期和時間 |
|
|
寄件者電子郵件覆寫
|
sender_email | string |
從已驗證使用者以外的其他電子郵件傳送 |
|
|
寄件者使用者覆寫
|
sender_id | string |
從已驗證以外的其他使用者傳送 |
|
|
範本識別碼
|
template_id | string |
選取要用於傳送的範本 |
|
|
文件類型
|
type | string |
設定文件的類型/類別 |
|
|
文件價值
|
value | integer |
交易或文件的價值 |
|
|
視訊 ID
|
video_id | string |
選擇要用於發送的視頻 |
傳回
文件是一個或多個上傳的檔案，要傳送給使用者建立的一或多個收件者。
- 文件
- Document
建立連絡人
這將在資料庫中為目前實體建立一個新聯絡人
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
公司名稱
|
company_name | string |
關聯公司名稱 |
|
|
公司編號
|
company_number | string |
關聯公司編號 |
|
|
Email
|
string |
聯絡人的電子郵件地址 |
||
|
名字
|
first_name | string |
聯絡人的名字 |
|
|
完整名稱
|
fullname | string |
用於指定全名而不是名字/姓氏 |
|
|
姓氏
|
last_name | string |
聯絡人的姓氏 |
|
|
行動裝置
|
mobile | string |
國際格式的手機號碼 |
|
|
備註
|
note | string |
可選的內部聯繫註釋 |
|
|
電話
|
phone | string |
國際格式的電話號碼 |
|
|
Title
|
title | string |
連絡人的職稱，例如。 執行長、銷售經理 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
連絡人識別碼
|
contact_id | string |
已建立聯絡人的 ID |
更新文件到期
使用此方法來更新文件的到期日期和時間。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文件 ID
|
documentId | True | string |
文件 ID |
|
到期日期
|
expiration_date | date-time |
文件到期的日期和時間 （UTC） |
|
|
傳送通知
|
send_notification | boolean |
是否應該將有關更新的通知傳送給收件者 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
地位
|
status | integer |
更新狀態 |
清單範本
接收可用文件範本的清單。 您可以在 GetAccept 的 [範本] 區段下新增範本。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
顯示全部
|
showall | string |
顯示實體的所有範本 |
|
|
資料夾 ID
|
folder_id | string |
顯示特定資料夾中的範本 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
templates
|
templates | array of object | |
|
tags
|
templates.tags | string | |
|
建立於
|
templates.created_at | string | |
|
external_editor_type
|
templates.external_editor_type | string | |
|
field_count
|
templates.field_count | integer | |
|
識別碼
|
templates.id | string | |
|
is_editable
|
templates.is_editable | boolean | |
|
is_private
|
templates.is_private | boolean | |
|
名稱
|
templates.name | string | |
|
page_count
|
templates.page_count | integer | |
|
role_count
|
templates.role_count | integer | |
|
sender_name
|
templates.sender_name | string | |
|
sender_thumb_url
|
templates.sender_thumb_url | string | |
|
thumb_url
|
templates.thumb_url | string | |
|
型別
|
templates.type | string | |
|
user_id
|
templates.user_id | string | |
|
video_id
|
templates.video_id | string | |
|
video_thumb_url
|
templates.video_thumb_url | string |
觸發程序
| 當文件已檢閱時 |
當文件已由任何收件者檢閱時觸發 |
| 當文件被拒絕時 |
當文件被任何收件者拒絕時觸發 |
| 簽署文件時 |
當文件已由所有簽署方簽署時觸發 |
| 訂閱文件事件 |
此呼叫將建立新的訂用帳戶。 即使對於根據 REST 掛鉤標準的單個對象，響應也會包裝在陣列中。
|
當文件已檢閱時
當文件已由任何收件者檢閱時觸發
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
所有實體使用者
|
global | boolean |
如果 Webhook 應該攔截所有實體使用者的事件。 |
|
|
錯誤電子郵件
|
notification_email | string |
如果事件失敗，請傳送通知至此電子郵件，而不是寄件者 |
|
|
承載
|
payload | string |
要張貼的其他承載資料 |
傳回
Webhook 負載
- Webhook
- Webhook
當文件被拒絕時
當文件被任何收件者拒絕時觸發
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
所有實體使用者
|
global | boolean |
如果 Webhook 應該攔截所有實體使用者的事件。 |
|
|
錯誤電子郵件
|
notification_email | string |
如果事件失敗，請傳送通知至此電子郵件，而不是寄件者 |
|
|
承載
|
payload | string |
要張貼的其他承載資料 |
傳回
Webhook 負載
- Webhook
- Webhook
簽署文件時
當文件已由所有簽署方簽署時觸發
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
所有實體使用者
|
global | boolean |
如果 Webhook 應該攔截所有實體使用者的事件。 |
|
|
錯誤電子郵件
|
notification_email | string |
如果事件失敗，請傳送通知至此電子郵件，而不是寄件者 |
|
|
承載
|
payload | string |
要張貼的其他承載資料 |
傳回
Webhook 負載
- Webhook
- Webhook
訂閱文件事件
此呼叫將建立新的訂用帳戶。 即使對於根據 REST 掛鉤標準的單個對象，響應也會包裝在陣列中。
活動
-
document.created- 文件已建立 -
document.sent- 文件已傳送 -
document.viewed- 文件已傳送 -
document.signed- 文件已簽署 -
document.approved- 文件已核准 -
document.expired- 文件已過期 -
document.rejected- 文件被拒絕 -
document.downloaded- 文件已下載完畢 -
document.printed- 列印文件 -
document.forwarded- 文件已轉發 -
document.partially_signed- 文件已部分簽署 -
document.commented- 文件已註解 -
document.hardbounced- 文件已硬退回 -
document.imported- 文件已匯入
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選擇活動
|
event | True | string |
事件觸發器 |
|
所有實體使用者
|
global | boolean |
如果 Webhook 應該攔截所有實體使用者的事件。 |
|
|
錯誤電子郵件
|
notification_email | string |
如果事件失敗，請傳送通知至此電子郵件，而不是寄件者 |
|
|
承載
|
payload | string |
要張貼的其他承載資料 |
傳回
Webhook 負載
- Webhook
- Webhook
定義
Attachment
文件附件
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
存取收件者
|
access_recipient_names | array of string |
有權存取附件的收件者 |
|
Description
|
attachment_description | string |
附件說明 |
|
下載網址
|
attachment_download_url | string |
下載附件的網址 |
|
副檔名
|
attachment_extension | string |
附件的副檔名 |
|
檔名
|
attachment_filename | string |
附件的檔案名稱 |
|
ID
|
attachment_id | string |
附件的 ID |
|
預覽 URL
|
attachment_preview_url | string |
用於預覽附件的內部 URL |
|
Title
|
attachment_title | string |
附件標題 |
|
類型
|
attachment_type | string |
附件類型 |
|
URL
|
attachment_url | string |
附件的網址 |
|
最後檢視
|
last_attachment_view | string |
上次檢視附件的日期和時間 |
|
限制存取
|
restrict_access | boolean |
附件的存取受到限制 |
Attachments
附件清單
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
attachments
|
attachments | array of Attachment |
連絡人
每個唯一的電子郵件地址（或手機號碼）都定義為聯繫人。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
公司編號
|
company_id | string |
公司編號 |
|
公司標誌
|
company_logo_url | string |
公司標誌 |
|
公司名稱
|
company_name | string |
聯絡人的公司名稱 |
|
公司編號
|
company_number | string |
聯絡人的公司號碼 |
|
連絡人識別碼
|
contact_id | string |
連絡人識別碼 |
|
已建立
|
created_at | string |
建立聯絡人的日期 |
|
Documents
|
document_count | number |
聯絡人的文件數量 |
|
連絡電子郵件
|
string |
已建立文件的名稱 |
|
|
名字
|
first_name | string |
聯絡人的名字 |
|
完整名稱
|
fullname | string |
聯絡人的全名 |
|
性別
|
gender | string |
收件人的性別 |
|
姓氏
|
last_name | string |
聯絡人的姓氏 |
|
行動裝置
|
mobile | string |
聯絡人的手機號碼 |
|
備註
|
note | string |
聯絡人須知 |
|
拇指網址
|
thumb_url | string |
連絡人的拇指 URL |
|
Title
|
title | string |
聯絡人的標題 |
聯繫人
聯繫人清單
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
contacts
|
contacts | array of Contact |
文件
文件是一個或多個上傳的檔案，要傳送給使用者建立的一或多個收件者。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Tags
|
tags | string |
文件標籤 |
|
自動聊天文字
|
auto_comment_text | string |
自動聊天文字 |
|
公司名稱
|
company_name | string |
公司名稱 |
|
建立時間
|
created_at | string |
建立文件的時間 |
|
下載網址
|
download_url | string |
下載已簽署文件的 URL |
|
電子郵件訊息
|
email_send_message | string |
傳送電子郵件訊息 |
|
電子郵件主旨
|
email_send_subject | string |
電子郵件主旨文字 |
|
到期日期
|
expiration_date | string |
文件到期日 |
|
外部用戶端識別碼
|
external_client_id | string | |
|
外部編輯者 ID
|
external_editor_id | string |
外部編輯器中的 ID |
|
外部編輯器類型
|
external_editor_type | string | |
|
外部 ID
|
external_id | string | |
|
欄位計數
|
field_count | integer |
文件中的欄位數 |
|
ID
|
id | string | |
|
自動註解
|
is_auto_comment | boolean |
如果啟用了自動聊天評論 |
|
自動評論電子郵件
|
is_auto_comment_email | boolean |
如果啟用了自動聊天電子郵件 |
|
識別收件者
|
is_identify_recipient | boolean |
如果文件已啟用識別收件人 |
|
是私人的
|
is_private | boolean |
如果文件是私人的 |
|
傳送提醒
|
is_reminder_sending | boolean |
如果啟用了自動提醒 |
|
排程傳送
|
is_scheduled_sending | boolean |
如果文件已排定傳送 |
|
自行簽署
|
is_selfsign | boolean |
如果文件已由寄件人自行簽署 |
|
已簽署
|
is_signed | boolean |
如果文件已簽署 |
|
可簽署的文件
|
is_signing | boolean |
如果文件可簽署 |
|
手寫簽名
|
is_signing_biometric | boolean |
如果啟用了手寫簽名 |
|
允許簽章轉移
|
is_signing_forward | boolean |
如果已啟用簽署權限的轉移 |
|
簽名順序
|
is_signing_order | boolean |
如果已啟用收件者簽署順序 |
|
有視頻
|
is_video | boolean |
如果文件有簡介影片 |
|
名稱
|
name | string |
文件名稱 |
|
父 ID
|
parent_id | string |
先前文件版本的 ID |
|
預覽 URL
|
preview_url | string |
文件內部預覽的連結 |
|
收件人
|
recipients | array of Recipient | |
|
預定發送時間
|
scheduled_sending_time | string |
文件排程傳送的時間 |
|
傳送日期
|
send_date | string |
文件傳送日期 |
|
寄件者電子郵件
|
sender_email | string |
寄件者使用者的電子郵件地址 |
|
寄件者名稱
|
sender_name | string |
寄件者使用者名稱 |
|
寄件者縮圖URL
|
sender_thumb_url | string |
寄件者使用者的拇指影像 |
|
簽約日期
|
sign_date | string |
文件簽署日期 |
|
地位
|
status | string |
文件的當前狀態 |
|
拇指網址
|
thumb_url | string |
文件的拇指影像 |
|
類型
|
type | string |
文件類型 |
|
唯一識別碼
|
unique_id | integer |
文件的唯一 ID |
|
使用者識別碼
|
user_id | string |
寄件者使用者的 ID |
|
價值觀
|
value | integer |
文件價值 |
Documents
文件清單
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
tags
|
tags | string | |
|
company_name
|
company_name | string | |
|
建立於
|
created_at | string | |
|
expiration_date
|
expiration_date | string | |
|
識別碼
|
id | string | |
|
is_private
|
is_private | boolean | |
|
is_signing
|
is_signing | boolean | |
|
名稱
|
name | string | |
|
sender_name
|
sender_name | string | |
|
sender_thumb
|
sender_thumb | string | |
|
狀態
|
status | string | |
|
型別
|
type | string | |
|
value
|
value | integer |
Editor欄位
編輯器欄位詳細資料
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
ID |
|
標籤
|
input_settings.label | string |
標籤 |
|
選項
|
input_settings.options | array of string |
選項 |
|
為必填項目
|
input_settings.required | boolean |
為必填項目 |
|
類型
|
input_settings.type | string |
類型 |
|
收件者 ID
|
recipient_id | string |
收件者 ID |
|
類型
|
type | string |
類型 |
|
使用者識別碼
|
user_id | string |
使用者識別碼 |
領域
欄位詳細資料
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
公司名稱
|
company_name | string |
公司名稱 |
|
公司編號
|
company_number | string |
公司編號 |
|
欄位識別碼
|
field_id | string |
欄位識別碼 |
|
標籤
|
field_label | string |
標籤 |
|
選項
|
field_options | array of object |
選項 |
|
價值觀
|
field_options.value | string | |
|
類型
|
field_type | string |
類型 |
|
價值觀
|
field_value | string |
價值觀 |
|
is_collectable
|
is_collectable | boolean |
收藏領域 |
|
is_editable
|
is_editable | boolean |
可編輯欄位 |
|
is_required
|
is_required | boolean |
必要欄位 |
|
頁面 ID
|
page_id | string |
頁面 ID |
|
收件者 ID
|
recipient_id | string |
收件者 ID |
|
收件者名稱
|
recipient_name | string |
收件者名稱 |
|
角色名稱
|
role_name | string |
角色名稱 |
Fields
欄位清單
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
editor_fields
|
editor_fields | array of EditorField | |
|
fields
|
fields | array of Field |
定價專欄
定價表欄
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
column_id | string |
ID |
|
顯示名稱
|
display_name | string |
顯示名稱 |
|
已啟用
|
enabled | boolean |
已啟用 |
|
名稱
|
name | string |
名稱 |
定價部分
定價表部分
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
columns
|
columns | array of PricingColumn | |
|
顯示名稱
|
display_name | string |
顯示名稱 |
|
名稱
|
name | string |
名稱 |
|
ID
|
section_id | string |
ID |
定價表
定價表
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
貨幣
|
currency_settings.currency | string |
貨幣 |
|
Locale
|
currency_settings.locale | string |
Locale |
|
預先計算的總計
|
pre_calculated | boolean |
預先計算的總計 |
|
部分
|
sections | array of PricingSection | |
|
ID
|
table_id | string |
表格 ID |
定價表
定價表
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
pricing_tables
|
pricing_tables | array of PricingTable |
Recipient
連接到文檔的每個唯一電子郵件地址（或手機號碼）都是收件人。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
公司名稱
|
company_name | string |
收件人的公司名稱 |
|
公司編號
|
company_number | string |
收件人的公司編號 |
|
文件網址
|
document_url | string |
收件者可檢視/簽署的唯一URL |
|
收件者電子郵件
|
string |
收件人的電子郵件 |
|
|
名字
|
first_name | string |
收件人的名字 |
|
完整名稱
|
fullname | string |
收件人的全名 |
|
性別
|
gender | string |
收件人的性別 |
|
ID
|
id | string |
收件者的 ID |
|
姓氏
|
last_name | string |
收件者的姓氏 |
|
行動裝置
|
mobile | string |
收件人的手機號碼 |
|
備註
|
note | string |
收件人註釋 |
|
簽署訂單編號
|
order_num | string |
收件者的簽署順序 |
|
地位
|
status | string |
收件者的狀態 |
|
拇指網址
|
thumb_url | string |
收件者的拇指 URL |
|
Title
|
title | string |
收件者的頭銜 |
收件者
收件者清單
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
收件人
|
recipients | array of Recipient |
User
使用者由其電子郵件地址定義，並連線到一或多個實體。
使用者角色
系統管理員：
- 查看所有文件
- 編輯所有文件
- 變更實體設定、資訊和帳單
- 將新使用者新增至實體
- 指派實體角色
經理：
- 檢視小組文件
- 編輯所有文件
- 將新使用者新增至實體
實體
實體是頂端節點，所有使用者及對應文件都連接至實體。 實體通常與大型組織中的公司、國家或部門相同。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
應用程式模式
|
app_mode | string | |
|
disallow_create
|
disallow_create | boolean | |
|
Email
|
string |
使用者的電子郵件地址 |
|
|
實體 ID
|
entity_id | string | |
|
實體名稱
|
entity_name | string | |
|
名字
|
first_name | string |
使用者的名字 |
|
ID
|
id | string |
使用者的 ID |
|
語言
|
language | string | |
|
姓氏
|
last_name | string |
使用者的姓氏 |
|
行動
|
mobile | string |
國際格式的手機號碼 |
|
備註
|
note | string |
用戶可選的內部註釋 |
|
電話
|
phone | string |
國際格式的電話號碼 |
|
Role
|
role | string | |
|
略過傳送邀請
|
skip_invitation | boolean | |
|
地位
|
status | string | |
|
團隊識別碼
|
team_id | string | |
|
拇指網址
|
thumb_url | string | |
|
Timezone
|
timezone | string | |
|
Title
|
title | string |
使用者的頭銜，例如。 執行長、銷售經理 |
使用者
使用者清單
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
users
|
users | array of object | |
|
Email
|
users.email | string | |
|
名字
|
users.first_name | string | |
|
上次登入
|
users.last_login | string | |
|
姓氏
|
users.last_name | string | |
|
使用者名
|
users.name | string | |
|
Role
|
users.role | string | |
|
地位
|
users.status | string | |
|
小組名稱
|
users.team_name | string | |
|
使用者識別碼
|
users.user_id | string |
Webhook
Webhook 負載
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
自訂欄位
|
custom_fields | object | |
|
文件
|
document | Document |
文件是一個或多個上傳的檔案，要傳送給使用者建立的一或多個收件者。 |
|
實體自訂網域
|
entity.custom_domain | string |
實體的自訂網域設定 |
|
預設電子郵件訊息
|
entity.email_send_message | string |
預設電子郵件訊息 |
|
預設電子郵件主旨
|
entity.email_send_subject | string |
預設電子郵件主旨 |
|
實體子網域
|
entity.sub_domain | string |
實體的子網域 |
|
事件名稱
|
event | string | |
|
事件動作
|
event_action | string | |
|
事件類型
|
event_type | string | |
|
Recipient
|
recipient | Recipient |
連接到文檔的每個唯一電子郵件地址（或手機號碼）都是收件人。 |
|
訂用帳戶識別碼
|
subscription_id | string |