立即簽名

SignNow 為企業、法律、人力資源、醫療保健和財務團隊提供安全、合規且可審計的電子簽名工作流程。使用 SignNow 連接器以角色為基礎的順序傳送和追蹤簽名請求、預先填寫文件欄位以及管理文件群組。

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

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

連絡人
名稱	說明中心
URL	https://support.signnow.com/
Email	integrations@pdffiller.com

連接器中繼資料
Publisher	達達文檔
網站	https://signnow.com
隱私策略	https://www.signnow.com/privacy_policy
類別	生產力;人力資源

SignNow 連接器

Pre-requisites

您需要 SignNow 帳戶和 SignNow API 訂閱才能繼續。

部署範例

首先，使用您自己的值更新 apiProperties.json 中的 clientId 值。

執行下列命令並遵循提示：

paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json --secret <client_secret>

支援的動作和觸發器

如需詳細資訊，請參閱文件。

節流限制

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

動作

上傳文件	將文件上傳至 SignNow
下載文件	從 SignNow 下載文件
刪除文件	從 SignNow 刪除文件
刪除文件內嵌邀請	此動作會刪除文件的內嵌邀請
刪除文件群組內嵌邀請	此動作會刪除特定文件群組的內嵌邀請
取代文件群組邀請中的收件者	此動作會依其邀請 ID 取代文件群組邀請中的收件者。您還可以為每個文檔設置邀請到期、提醒、重新分配權限和拒絕選項
取代文件邀請中的收件者	此動作會根據收件者的角色取代文件邀請中的收件者。它還允許更新邀請設置，例如身份驗證類型、到期天數和每個角色的其他高級參數
取得文件欄位	從文件中的可填欄位擷取值
取得文件欄位 [已棄用]	此動作已被取代。請改用取得文件欄位。 ~~取得文件欄位值。~~
取得文件清單	擷取使用者文件清單
取得文件結構描述 [已淘汰]	此動作已被取代。請改用取得文件結構描述。 ~~取得 OpenAPI 文件結構描述~~
取得文件群組	擷取使用者的文件群組清單
取得文件群組	擷取使用者的文件群組清單
取得文件群組邀請狀態	此動作會擷取文件群組邀請的相關資訊，包括每個步驟和動作的狀態
取得文件資訊	獲取文檔屬性，如名稱、ID、創建/更新日期等。
取得文件邀請狀態	此動作會擷取文件邀請的相關資訊，包括每個步驟和動作的狀態
取消邀請	簽名邀請取消
已棄用 - 進階文件邀請	動作已被取代。使用手動定義結構描述的邀請請求。它允許為將來生成的文檔設置邀請
已棄用 - 邀請簽署	動作已被取代。邀請其他人填寫並簽署文件
已棄用 - 邀請簽署文件群組	動作已被取代。邀請其他人填寫並簽署文件群組
建立文件內嵌傳送連結	此動作會產生特定文件的內嵌傳送連結，讓第三方使用者準備並傳送文件以供簽署
建立文件內嵌邀請	此動作會為文件建立內嵌的簽署邀請。建立邀請後，產生內嵌的簽署連結
建立文件群組內嵌傳送連結	此動作會為特定文件群組產生內嵌的傳送連結，讓協力廠商使用者準備並傳送文件群組以供簽署
建立文件群組內嵌邀請	此動作會為文件群組建立內嵌的簽署邀請。建立邀請後，產生內嵌的簽署連結
建立簽署連結	產生文件連結並共用，讓文件簽署
從多個檔案建立文件群組	透過將多個檔案上傳為 base64 編碼字串來建立文件群組
從範本建立文件	從選取的範本產生文件
從群組範本建立文件群組	從選取的群組範本建立文件群組
產生文件內嵌邀請連結	此動作會產生文件內嵌邀請的連結
產生文件群組內嵌邀請連結	此動作會產生文件群組內嵌邀請的連結
邀請簽署文件	此動作會建立並傳送要簽署之文件的欄位邀請
邀請簽署文件群組	此動作會建立簽署文件群組的邀請。您可以設定多步驟工作流程，讓不同的收件者在不同階段對文件群組採取行動
預先填入文件欄位值	使用特定值自動填入文件中的可填寫欄位
預先填入文件欄位值 [已淘汰]	此動作已被取代。請改用預填文件欄位值。 ~~預先填入欄位值和屬性。~~
預先填入文件群組智慧欄位值	使用特定值自動填入文件中的智慧欄位
預先填入文件群組欄位值	使用特定值自動填充文檔中的可填寫字段
預先填入智慧欄位值	預先填入指定文件的「智慧型欄位」值

上傳文件

作業識別碼：: UploadDocument

將文件上傳至 SignNow

參數

名稱	機碼	必要	類型	Description
檔案	file	True	file	要上傳的檔案

傳回

名稱	路徑	類型	Description
文件 ID	id	DocumentId	唯一文件 ID

下載文件

作業識別碼：: DownloadDocument

從 SignNow 下載文件

參數

名稱	機碼	必要	類型	Description
文件 ID	doc_id	True	string	指定唯一的文件 ID 或從清單中選取文件
格式	mode		string	選擇要下載的文件格式

傳回

response: binary

刪除文件

作業識別碼：: DeleteDoc

從 SignNow 刪除文件

參數

名稱	機碼	必要	類型	Description
文件 ID	doc_id	True	string	指定唯一的文件識別碼

傳回

名稱	路徑	類型	Description
地位	status	string	文件移除狀態

刪除文件內嵌邀請

作業識別碼：: DeleteEmbeddedInvites

此動作會刪除文件的內嵌邀請

參數

名稱	機碼	必要	類型	Description
文件 ID	id	True	string	文件 ID

刪除文件群組內嵌邀請

作業識別碼：: DeleteDocGroupEmbeddedInvites

此動作會刪除特定文件群組的內嵌邀請

參數

名稱	機碼	必要	類型	Description
文件群組 ID	id	True	string	文件群組 ID

取代文件群組邀請中的收件者

作業識別碼：: ReplaceRecipientsInDocumentGroupInvite

此動作會依其邀請 ID 取代文件群組邀請中的收件者。您還可以為每個文檔設置邀請到期、提醒、重新分配權限和拒絕選項

參數

名稱	機碼	必要	類型	Description
文件群組 ID	id	True	string	文件群組 ID
邀請ID	invite_id	True	string	文件群組邀請 ID
步驟識別碼	step_id		string	文件群組邀請中邀請步驟的識別碼
要取代的收件者	recipient_to_update		string	要替換的收件者的電子郵件
新收件者	new_recipient		string	新收件者的電子郵件
到期日	expiration_days		integer	邀請到期的天數;最多 30 天
提醒	reminder		integer	在多少天內向簽署者發送提醒;最多 30 天
文件 ID	document_id	True	string	文件群組中的文件 ID
允許轉發	allow_forwarding		boolean	是否允許收件者將此邀請重新指派給另一個電子郵件地址。可能的值：False - 不允許。 True - 允許。
允許依簽章拒絕	decline_by_signature		boolean	定義是否在簽名欄位上顯示 [拒絕簽署] 選項。 True：顯示拒絕選項;False：隱藏拒絕選項

傳回

名稱	路徑	類型	Description
地位	status	string	收件人替換狀態

取代文件邀請中的收件者

作業識別碼：: ReplaceRecipientsInDocumentInvite

此動作會根據收件者的角色取代文件邀請中的收件者。它還允許更新邀請設置，例如身份驗證類型、到期天數和每個角色的其他高級參數

參數

名稱	機碼	必要	類型	Description
文件 ID	id	True	string	文件 ID
Role	role	True	string	要取代的收件者的角色名稱
新電子郵件	email	True	string	新收件者電子郵件
Role	role	True	string	需要額外邀請參數的角色名稱
到期日	expiration_days		integer	邀請到期的天數。最多 30 天
允許依簽章拒絕	decline_by_signature		boolean	定義是否在簽名欄位上顯示 [拒絕簽署] 選項。 True：顯示拒絕選項;False：隱藏拒絕選項
提醒	reminder		integer	在多少天內向收件人發送提醒。最多 30 天
驗證類型	authentication_type		string	在簽署工作階段期間用於收件者驗證的驗證類型。允許的值：「密碼」、「電話」和「簡訊」
驗證密碼	authentication_password		string	為簽署者驗證設定的密碼。「密碼」驗證類型需要
驗證電話	authentication_phone		string	用於驗證簽署者的電話號碼。「電話通話」和「簡訊」驗證類型為必要項目。範例：+1XXXXXXXXX
驗證簡訊訊息	authentication_sms_message		string	傳送給簽署者的自訂簡訊訊息，包含 {password} 預留位置。與「簡訊」驗證類型一起使用。如果沒有此參數，簽署者會收到帶有自動產生密碼（解鎖碼）的預設簡訊 - 「SignNow 文件邀請解鎖碼：123456」。範例：輸入密碼 {password} 以解除鎖定文件

傳回

名稱	路徑	類型	Description
替換	replacements	array of object	新收件人的詳細信息
新的邀請ID	replacements.new_invite_id	string	新欄位邀請ID
Role	replacements.role	string	已取代之收件者的角色名稱
新電子郵件	replacements.new_email	string	新收件者電子郵件

取得文件欄位

作業識別碼：: GetDocFields_V2

從文件中的可填欄位擷取值

參數

名稱	機碼	必要	類型	Description
Template	template_id	True	string	指定要從中取得欄位的文件範本
文件 ID	doc_id	True	string	指定唯一的文件識別碼

傳回

此作業會輸出隨機的結果。

取得文件欄位 [已棄用]

作業識別碼：: GetDocFields

此動作已被取代。請改用取得文件欄位。

~~取得文件欄位值。~~

參數

名稱	機碼	必要	類型	Description
Template	template_id	True	string	指定要從中取得欄位的文件範本
文件 ID	doc_id	True	string	指定唯一的文件識別碼

傳回

此作業會輸出隨機的結果。

取得文件清單

作業識別碼：: GetListDoc

擷取使用者文件清單

參數

名稱	機碼	必要	類型	Description
Template	template		boolean	指定是否應擷取文件或範本
包括預設範本	includeDefaultTemplate		boolean	指定是否應將預設範本新增至範本清單

傳回

response: array of DocumentProperties

取得文件結構描述 [已淘汰]

作業識別碼：: GetDocSchema

此動作已被取代。請改用取得文件結構描述。

~~取得 OpenAPI 文件結構描述~~

參數

名稱	機碼	必要	類型	Description
文件 ID	doc_id		string	指定唯一的文件識別碼
欄位類型篩選器	select		string	用逗號分隔您要擷取的欄位類型

傳回

名稱	路徑	類型	Description
properties	properties	object

取得文件群組

作業識別碼：: GetDocumentGroup

擷取使用者的文件群組清單

參數

名稱	機碼	必要	類型	Description
群組範本	doc_group_id	True	string	從清單中選取群組範本
Template	template	True	boolean	指定是否應擷取文件群組或群組範本

傳回

身體: DocumentGroupProperties

取得文件群組

作業識別碼：: GetListDocGroups

擷取使用者的文件群組清單

參數

名稱	機碼	必要	類型	Description
Template	template	True	boolean	指定是否應擷取文件群組或群組範本
限制	limit		integer	退回的項目總數（介於 1 到 50 之間）
Offset	offset		integer	集合中要傳回的第一個項目的（從零開始）位移

傳回

身體: DocumentGroupsResponse

取得文件群組邀請狀態

作業識別碼：: GetDocumentGroupInviteStatus

此動作會擷取文件群組邀請的相關資訊，包括每個步驟和動作的狀態

參數

名稱	機碼	必要	類型	Description
文件群組 ID	id	True	string	文件群組 ID

傳回

名稱	路徑	類型	Description
文件群組邀請標識符	document_group_invite_id	string	文件群組的邀請ID
文件群組狀態	status	string	文件群組簽署狀態。可能的值：「已建立」、「擱置」、「已履行」、「已取消」
擁有者電子郵件	owner_email	string	文件群組擁有者的電子郵件地址
文件組被拒絕	is_document_declined	boolean	如果簽署者或核准者拒絕群組中的任何文件，則傳回 'true';否則，傳回 'false'
steps	steps	array of object	Steps
步驟識別碼	steps.step_id	string	文件群組邀請中的步驟識別碼
簽署訂單	steps.signing_order	integer	簽署順序
文件標識碼	steps.document_id	string	文件 ID
文件名稱	steps.document_name	string	文件名稱
簽署者電子郵件	steps.signer_email	string	收件者電子郵件地址
角色名稱	steps.role_name	string	收件者角色名稱
動作類型	steps.action_type	string	文件中收件者所需的動作。可能的值：「Sign」、「View」、「Approve」或「FreeFormSign」
步驟邀請ID	steps.invite_id	string	邀請步驟的ID
地位	steps.status	string	步驟的簽署狀態
已拒絕	steps.declined	boolean	如果此步驟中的收件者拒絕文件，則為 True
拒絕原因	steps.decline_reason	string	收件者在拒絕文件時提供的訊息
已建立	steps.created	integer	建立步驟的日期
Updated	steps.updated	integer	上次更新步驟狀態的日期

取得文件資訊

作業識別碼：: GetDoc

獲取文檔屬性，如名稱、ID、創建/更新日期等。

參數

名稱	機碼	必要	類型	Description
Template	template	True	boolean	指定是否應擷取文件或範本
文件 ID	doc_id	True	string	指定唯一的文件 ID 或從清單中選取文件

傳回

身體: DocumentProperties

取得文件邀請狀態

作業識別碼：: GetInviteStatus

此動作會擷取文件邀請的相關資訊，包括每個步驟和動作的狀態

參數

名稱	機碼	必要	類型	Description
文件 ID	id	True	string	文件 ID

傳回

名稱	路徑	類型	Description
文件被拒絕	is_document_declined	boolean	如果文件被簽署者或核准者拒絕，則為 true，否則為 false
steps	steps	array of object	Steps
簽署訂單	steps.signing_order	integer	簽署順序
收件者電子郵件	steps.signer_email	string	收件者電子郵件地址
角色名稱	steps.role_name	string	收件者角色名稱
動作類型	steps.action_type	string	文件中收件者所需的動作。可能的值：「Sign」、「View」、「Approve」或「FreeFormSign」
邀請ID	steps.invite_id	string	邀請ID
地位	steps.status	string	簽署狀態。可能的值：「已建立」、「擱置」、「已履行」、「已取消」、「略過」
已拒絕	steps.declined	boolean	如果此步驟的收件者拒絕文件，則傳回 'true'
拒絕原因	steps.decline_reason	string	收件者在拒絕文件時提供的訊息
已建立	steps.created	integer	建立步驟的日期
Updated	steps.updated	integer	上次更新步驟狀態的日期

取消邀請

作業識別碼：: CancelInvite

簽名邀請取消

參數

名稱	機碼	必要	類型	Description
文件標識碼	doc_id	True	string	指定取消簽名邀請的文件識別碼

傳回

response: object

已棄用 - 進階文件邀請

作業識別碼：: SendUserDefinedInvite

動作已被取代。使用手動定義結構描述的邀請請求。它允許為將來生成的文檔設置邀請

參數

名稱	機碼	必要	類型	Description
文件 ID	doc_id	True	string	提供文件 ID
名稱	role		string	簽署者的角色名稱
電子郵件	email		email	指定簽署者的電子郵件
電話號碼（透過簡訊邀請）	phone_invite		string	指定 +XXXXXXXXXXXX 收件人的電話號碼。透過簡訊邀請時需要。
訂單	order		integer	設定多個簽署者的簽署順序
個人化主題	subject		string	為簽署者新增個人化主旨
個人化訊息	message		string	為簽署者新增個人化訊息
驗證類型	authentication_type		string	透過密碼、簡訊或電話驗證使用者身分
密碼	password		string	設定驗證類型密碼的密碼
電話	phone		string	為驗證類型電話或簡訊指定 +XXXXXXXXXX 電話號碼
到期前天數	expiration_days		integer	讓簽署者在邀請到期的天數內收到通知
發送提醒	reminder		integer	傳送邀請後自動跟進電子郵件提醒的天數
每 X 天發送一次提醒	remind_repeat		integer	收件人將每隔設定的天數收到一封提醒電子郵件。
允許轉發	reassign		boolean	允許簽署者將簽署委派給其他人
在簽名上顯示拒絕	decline_by_signature		boolean	如果收件者拒絕簽署文件，請將簽名欄位蓋章為「拒絕簽署」
CC	cc		string	以逗號分隔的電子郵件，將在邀請中進行 Carbon 複製
主旨	subject		string	輸入您的主旨
Message	message		string	輸入您的訊息
完成後向各方發送電子郵件	on_complete		string	簽署文件時，各方都會收到通知電子郵件

傳回

response: object

已棄用 - 邀請簽署

作業識別碼：: SendInvite

動作已被取代。邀請其他人填寫並簽署文件

參數

名稱	機碼	必要	類型	Description
Template	template	True	boolean	指定是否應擷取文件或範本
文件	template_id	True	string	從清單中選取範本
body	body	True	dynamic

傳回

response: object

已棄用 - 邀請簽署文件群組

作業識別碼：: SendGroupInvite

動作已被取代。邀請其他人填寫並簽署文件群組

參數

名稱	機碼	必要	類型	Description
Template	template	True	boolean	指定是否應擷取文件群組或群組範本
文件群組	template_group_id	True	string	從清單中選取文件群組
body	body	True	dynamic

傳回

response: object

建立文件內嵌傳送連結

作業識別碼：: CreateEmbeddedInviteSettingsLink

此動作會產生特定文件的內嵌傳送連結，讓第三方使用者準備並傳送文件以供簽署

參數

名稱	機碼	必要	類型	Description
文件 ID	id	True	string	文件 ID
類型	type		string	指定連結應開啟的傳送步驟。可能的值：「邀請」：開啟文件的「傳送邀請」頁面，使用者可以在其中新增簽署者電子郵件、主旨、訊息等。「文件」：在編輯器中開啟文件以新增可填寫的欄位，然後開啟「傳送邀請」頁面
重新導向 URI	redirect_uri		string	內嵌傳送設定後開啟的頁面。如果新增「重新導向目標」，則為必要項目
連結到期	link_expiration		integer	指定連結將保持作用中的分鐘數。允許的範圍：15 到 45 分鐘。管理員層級使用者最多可以將持續時間設定為 43200 分鐘
重新導向目標	redirect_target		string	決定是否要在瀏覽器的新索引標籤中開啟重新導向 URI，或在簽署工作階段之後在相同的索引標籤中開啟重新導向 URI。可能的值：「在新分頁中」 – 在新分頁中開啟連結，「在同一分頁中」 — 在同一分頁中開啟連結

傳回

名稱	路徑	類型	Description
網址	url	string	內嵌文件傳送的連結

建立文件內嵌邀請

作業識別碼：: CreateEmbeddedInvites

此動作會為文件建立內嵌的簽署邀請。建立邀請後，產生內嵌的簽署連結

參數

名稱	機碼	必要	類型	Description
文件 ID	id	True	string	文件 ID
簽署者電子郵件	email	True	email	收件者電子郵件地址
Role	role	True	string	收件者角色名稱，例如「簽署者 1」（不支援檢視者角色）
訂單	order	True	integer	簽署順序
名稱公式	name_formula		string	使用前置詞（任何文字）和可填寫欄位資料產生完整文件名稱的公式。範例：「Contract\|signer_name\|signed_date」，其中「Contract」是前置詞，「signer_name」和「signed_date」是可填寫欄位的名稱
Role	role	True	string	收件者角色名稱，例如「簽署者 1」（不支援檢視者角色）
語言	language		string	指定簽署者簽署工作階段和通知電子郵件的語言。可能的值：en 代表英文，es 代表西班牙文，fr 代表法文。如果未設定，則語言由您的 SignNow 帳戶的語言決定
名字	first_name		string	收件人名字
姓氏	last_name		string	收件者姓氏
必要的預設簽名名稱	required_preset_signature_name		string	簽名欄位的預先填入文字，已鎖定以供收件者編輯。不能與「prefill_signature_name」或「force_new_signature」一起使用
預先填入簽名名稱	prefill_signature_name		string	具有簽名名稱的字串，當簽署者按一下簽名欄位時出現。簽署者可以編輯簽名
需要新簽名	force_new_signature		boolean	定義簽署者是否可以使用其儲存的簽名。如果設定為「true」，簽署者必須新增簽名。如果設定為「false」，簽署者可以使用已儲存的簽名
重新導向 URI	redirect_uri		string	簽署工作階段完成後開啟的連結
拒絕重新導向 Uri	decline_redirect_uri		string	收件者拒絕簽署文件後開啟的連結
關閉重新導向 Uri	close_redirect_uri		string	收件者在簽署工作階段期間按一下 [儲存進度] 和 [稍後完成] 或 [在檢視模式中關閉] 時開啟的連結
重新導向目標	redirect_target		string	決定是否要在瀏覽器的新索引標籤中開啟重新導向 URI，或在簽署工作階段之後在相同的索引標籤中開啟重新導向 URI。可能的值：「在新分頁中」 – 在新分頁中開啟連結，「在同一分頁中」 — 在同一分頁中開啟連結
驗證類型	authentication_type		string	在簽署工作階段期間用於收件者驗證的驗證類型。允許的值：「密碼」、「電話」和「簡訊」
驗證密碼	authentication_password		string	為簽署者驗證設定的密碼。「密碼」驗證類型需要
驗證電話	authentication_phone		string	用於驗證簽署者的電話號碼。「電話通話」和「簡訊」驗證類型為必要項目。範例：+1XXXXXXXXX
驗證簡訊訊息	authentication_sms_message		string	傳送給簽署者的自訂簡訊訊息，包含 {password} 預留位置。與「簡訊」驗證類型一起使用。如果沒有此參數，簽署者會收到包含自動產生密碼（解鎖碼）的預設簡訊 - 「SignNow 文件邀請解除鎖定碼：123456」範例：輸入密碼 {password} 以解除鎖定您的文件
送貨類型	delivery_type		string	定義邀請的傳送方式
連結到期	link_expiration		integer	電子郵件邀請會在多少分鐘內到期。只有在「傳遞類型=電子郵件」時才能使用。有效範圍：15–43200分鐘
工作階段到期	session_expiration		integer	簽署工作階段會在多少分鐘內到期。如果為此邀請產生連結，則會話到期會重設。僅適用於「傳遞類型=電子郵件」和「簽署」動作。有效範圍：15–1440分鐘
QES 簽名	signature		string	QES 類型。可能的值：「Eideasy」、「Nom151」。用於向簽署者請求 QES 簽名。邀請中的所有簽署者都必須使用相同的簽名類型。若要使用 QES 建立邀請，使用者必須屬於已啟用 QES 的組織

傳回

名稱	路徑	類型	Description
資料	data	array of object	資料
身份識別碼	data.id	string	已建立內嵌邀請的ID
Email	data.email	string	收件者電子郵件
角色識別碼	data.role_id	string	收件者角色識別碼
訂單	data.order	integer	收件者簽署順序
地位	data.status	string	內嵌邀請狀態

建立文件群組內嵌傳送連結

作業識別碼：: CreateDocGroupEmbeddedInviteSettingsLink

此動作會為特定文件群組產生內嵌的傳送連結，讓協力廠商使用者準備並傳送文件群組以供簽署

參數

名稱	機碼	必要	類型	Description
文件群組 ID	id	True	string	文件群組 ID
類型	type		string	指定內嵌連結應開啟的傳送步驟：「管理」 — 在「將文件新增至文件群組」頁面上開啟連結;'edit'：在編輯器中開啟連結;'send-invite'：開啟「傳送邀請」頁面上的連結
重新導向 URI	redirect_uri		string	內嵌傳送設定後開啟的頁面。如果新增「重新導向目標」，則為必要項目
連結到期	link_expiration		integer	指定連結將保持作用中的分鐘數。允許的範圍：15 到 45 分鐘。管理員層級使用者最多可以將持續時間設定為 43200 分鐘
重新導向目標	redirect_target		string	決定是否要在瀏覽器的新索引標籤中開啟重新導向 URI，或在簽署工作階段之後在相同的索引標籤中開啟重新導向 URI。可能的值：「在新分頁中」 – 在新分頁中開啟連結，「在同一分頁中」 — 在同一分頁中開啟連結

傳回

名稱	路徑	類型	Description
網址	url	string	內嵌文件群組傳送的連結

建立文件群組內嵌邀請

作業識別碼：: CreateDocGroupEmbeddedInvites

此動作會為文件群組建立內嵌的簽署邀請。建立邀請後，產生內嵌的簽署連結

參數

名稱	機碼	必要	類型	Description
文件群組 ID	id	True	string	文件群組 ID
訂單	order	True	integer	簽署訂單步驟。指派給特定 `order` 步驟（例如 `order: 1`）的所有簽署者都會同時收到邀請電子郵件。下一個訂單步驟（例如 `order: 2`）的電子郵件只有在完成上一個訂單步驟中的所有動作後才會傳送
Email	email	True	string	收件者電子郵件地址
文件標識碼	id	True	string	文件的 ID
Role	role		string	檔案中的收件者角色。不應為「檢視」動作指定角色
行動	action	True	string	文件中收件者所需的動作。允許的值：「sign」、「view」
訂單	order	True	string	簽署訂單步驟
Email	email	True	string	收件者電子郵件地址
語言	language		string	指定簽署者簽署工作階段和通知電子郵件的語言。可能的值：en 代表英文，es 代表西班牙文，fr 代表法文。如果未設定，則語言由您的 SignNow 帳戶的語言決定
名字	first_name		string	收件人名字
姓氏	last_name		string	收件者姓氏
必要的預設簽名名稱	required_preset_signature_name		string	簽名欄位的預先填入文字，已鎖定以供收件者編輯
重新導向 URI	redirect_uri		string	簽署工作階段完成後開啟的連結
拒絕重新導向 Uri	decline_redirect_uri		string	收件者拒絕簽署文件後開啟的連結
關閉重新導向 Uri	close_redirect_uri		string	收件者在簽署工作階段期間按一下 [儲存進度] 和 [稍後完成] 或 [在檢視模式中關閉] 時開啟的連結
重新導向目標	redirect_target		string	決定是否要在瀏覽器的新索引標籤中開啟重新導向 URI，或在簽署工作階段之後在相同的索引標籤中開啟重新導向 URI。可能的值：「在新分頁中」 – 在新分頁中開啟連結，「在同一分頁中」 — 在同一分頁中開啟連結
送貨類型	delivery_type		string	定義邀請的傳送方式
連結到期	link_expiration		integer	電子郵件邀請會在多少分鐘內到期。只有在「傳遞類型=電子郵件」時才能使用。有效範圍：15–43200分鐘
工作階段到期	session_expiration		integer	簽署工作階段會在多少分鐘內到期。如果為此邀請產生連結，則會話到期會重設。僅適用於「傳遞類型=電子郵件」和「簽署」動作。有效範圍：15–1440分鐘
驗證類型	authentication_type		string	在簽署工作階段期間用於收件者驗證的驗證類型。允許的值：「密碼」、「電話」和「簡訊」
驗證密碼	authentication_password		string	為簽署者驗證設定的密碼。「密碼」驗證類型需要
驗證電話	authentication_phone		string	用於驗證簽署者的電話號碼。「電話通話」和「簡訊」驗證類型為必要項目。範例：+1XXXXXXXXX
驗證簡訊訊息	authentication_sms_message		string	傳送給簽署者的自訂簡訊訊息，包含 {password} 預留位置。與「簡訊」驗證類型一起使用。如果沒有此參數，簽署者會收到帶有自動產生密碼（解鎖碼）的預設簡訊 - 「SignNow 文件邀請解鎖碼：123456」。範例：輸入密碼 {password} 以解除鎖定文件
QES 簽名	signature		string	QES 類型。可能的值：「Eideasy」、「Nom151」。用於向簽署者請求 QES 簽名。邀請中的所有簽署者都必須使用相同的簽名類型。若要使用 QES 建立邀請，使用者必須屬於已啟用 QES 的組織

傳回

名稱	路徑	類型	Description
邀請ID	id	string	已建立內嵌邀請的ID

建立簽署連結

作業識別碼：: CreateSigningLink

產生文件連結並共用，讓文件簽署

參數

名稱	機碼	必要	類型	Description
文件 ID	doc_id	True	string	指定唯一的文件 ID 或從清單中選取文件
fields	fields		dynamic

傳回

名稱	路徑	類型	Description
URL	url_no_signup	string	簽署連結

從多個檔案建立文件群組

作業識別碼：: CreateDocGroupFromFiles

透過將多個檔案上傳為 base64 編碼字串來建立文件群組

參數

名稱	機碼	必要	類型	Description
文件群組名稱	group_name	True	string	輸入文件群組的名稱
文件名稱	name	True	string	帶副檔名的文件名稱：Report.pdf、Letter.docx 等
檔案內容	content	True	string	代表文件內容的 Base64 編碼字串

傳回

身體: CreateDocumentGroupFromFilesResponse

從範本建立文件

作業識別碼：: CreateFromTemplate

從選取的範本產生文件

參數

名稱	機碼	必要	類型	Description
文件範本	doc_id	True	string	從清單中選取範本
文件名稱	document_name		string	輸入文件的新檔案名稱

傳回

名稱	路徑	類型	Description
文件 ID	id	DocumentId	唯一文件 ID

從群組範本建立文件群組

作業識別碼：: CreateFromTemplateGroup

從選取的群組範本建立文件群組

參數

名稱	機碼	必要	類型	Description
群組範本	doc_group_id	True	string	從清單中選取群組範本
文件群組名稱	group_name		string	輸入文件群組的新名稱

傳回

名稱	路徑	類型	Description
文件群組 ID	id	DocumentGroupId	唯一文件群組 ID

產生文件內嵌邀請連結

作業識別碼：: GenerateEmbeddedInviteLink

此動作會產生文件內嵌邀請的連結

參數

名稱	機碼	必要	類型	Description
文件 ID	id	True	string	文件 ID
欄位邀請ID	field_invite_id	True	string	來自「建立文件內嵌邀請」動作的內嵌邀請 ID
連結到期	link_expiration		integer	指定連結將保持作用中的分鐘數。有效範圍：15-45分鐘
工作階段到期	session_expiration		integer	指定簽署工作階段將保持作用中的分鐘數。有效範圍：15-1440分鐘

傳回

名稱	路徑	類型	Description
Link	data.link	string	為文件產生的內嵌邀請連結

產生文件群組內嵌邀請連結

作業識別碼：: GenerateDocGroupEmbeddedInviteLink

此動作會產生文件群組內嵌邀請的連結

參數

名稱	機碼	必要	類型	Description
文件群組 ID	id	True	string	文件群組 ID
文件群組內嵌邀請ID	invite_id	True	string	來自「建立文件群組內嵌邀請」動作的文件群組內嵌邀請的ID
Email	email	True	email	收件者電子郵件地址
連結到期	link_expiration		integer	指定連結將保持作用中的分鐘數。有效範圍：15-45分鐘
工作階段到期	session_expiration		integer	指定簽署工作階段將保持作用中的分鐘數。有效範圍：15-1440分鐘

傳回

名稱	路徑	類型	Description
內嵌邀請連結	link	string	文件群組內嵌邀請的連結

邀請簽署文件

作業識別碼：: InviteToSignAllOptions

此動作會建立並傳送要簽署之文件的欄位邀請

參數

名稱	機碼	必要	類型	Description
文件 ID	id	True	string	文件 ID
Email	email		string	收件者電子郵件地址
電子郵件群組	email_group		string	應收到邀請的使用者群組。當其中一個使用者簽署文件時，即視為已完成。必須與「電子郵件群組」進階參數搭配使用。如果未新增「電子郵件」或「電話邀請」，但無法與上述任一參數同時使用，則為必要
電話邀請	phone_invite		string	收件者電話號碼。透過簡訊邀請的必要條件
Role	role	True	string	收件者角色名稱。例如簽署者 1、簽署者 2
訂單	order	True	integer	簽署順序。簽署順序會定義收件者必須簽署或填寫文件的順序。訂單步驟中的所有收件者完成簽署後，文件將繼續進行下一個訂單步驟（例如，2、3）。多個收件者可以共用相同的簽署順序
Role	role	True	string	收件者角色名稱，用於對應進階引數
預先填入簽名名稱	prefill_signature_name		string	簽名欄位中的預先填入文字，可供簽署者編輯
必要的預設簽名名稱	required_preset_signature_name		string	簽名欄位的預先填入文字，已鎖定以供收件者編輯。不能與「預先填寫簽名名稱」或「需要新簽名」一起使用
需要新簽名	force_new_signature		boolean	定義簽署者是否可以使用已儲存的簽名。 False – 簽署者可以使用已儲存的簽名;True – 簽署者必須建立新簽名
允許轉發	reassign		boolean	定義收件者是否可以將邀請轉寄至另一個電子郵件地址。 'true'：收件者可以轉發邀請;'false'：收件者無法轉寄邀請
允許依簽章拒絕	decline_by_signature		boolean	定義是否在簽名欄位上顯示 [拒絕簽署] 選項。 True – 顯示拒絕選項;false – 隱藏拒絕選項
在 X 天內發送提醒	remind_after		integer	邀請後 X 天，收件人會收到提醒電子郵件（從 1 到 179 天）。必須小於「到期前天數」
在到期前 X 天內發送提醒	remind_before		integer	到期前 X 天，收款人會收到提醒電子郵件（從 1 到 179 天）。必須小於「到期前天數」
每 X 天發送一次提醒	remind_repeat		integer	邀請傳送後，接收者每 x 天收到一封提醒電子郵件（1 到 7 天）
到期前天數	expiration_days		integer	在 X 天內，邀請到期（從 3 到 180 天）
驗證類型	authentication_type		string	在簽署工作階段期間用於收件者驗證的驗證類型。允許的值：「密碼」、「電話」和「簡訊」
驗證密碼	password		string	為簽署者驗證設定的密碼。「密碼」驗證類型需要
驗證電話	phone		string	用於驗證簽署者的電話號碼。「電話通話」和「簡訊」驗證類型為必要項目。範例：+1XXXXXXXXX
驗證簡訊訊息	authentication_sms_message		string	傳送給簽署者的自訂簡訊訊息，包含 {password} 預留位置。與「簡訊」驗證類型一起使用。如果沒有此參數，簽署者會收到帶有自動產生密碼（解鎖碼）的預設簡訊 - 「SignNow 文件邀請解鎖碼：123456」。範例：輸入密碼 {password} 以解除鎖定文件
主旨	subject		string	收件者的自訂電子郵件主旨
Message	message		string	收件者的自訂電子郵件訊息
重新導向 URI	redirect_uri		string	完成並簽署所有要求的欄位後，簽署者會重新導向至此 URI
重新導向目標	redirect_target		string	決定是否要在瀏覽器的新索引標籤中開啟重新導向 URI，或在簽署工作階段之後在相同的索引標籤中開啟重新導向 URI。可能的值：「在新分頁中」 – 在新分頁中開啟連結，「在同一分頁中」 — 在同一分頁中開啟連結
拒絕重新導向 Uri	decline_redirect_uri		string	收件者拒絕文件後開啟的連結
關閉重新導向 Uri	close_redirect_uri		string	收件者在簽署工作階段期間按一下 [儲存進度] 和 [稍後完成] 或 [在檢視模式中關閉] 時開啟的連結
完成重定向是否已取消	is_finish_redirect_canceled		boolean	指定是否取消組織的完成重新導向設定。 True – 重新導向已取消;False – 重新導向保持作用中
關閉重新導向是否已取消	is_close_redirect_canceled		boolean	指定是否取消組織的儲存進度重新導向設定。 True – 重新導向已取消;False – 重新導向保持作用中
拒絕重新導向是否已取消	is_decline_redirect_canceled		boolean	指定是否取消組織的拒絕重新導向設定。 True – 重新導向已取消;False – 重新導向保持作用中
語言	language		string	指定簽署者簽署工作階段和通知電子郵件的語言。可能的值：en 代表英文，es 代表西班牙文，fr 代表法文。如果未設定，則語言由您的 SignNow 帳戶的語言決定
Email	email	True	string	檢視者電子郵件地址
Role	role	True	string	檢視者角色名稱
訂單	order	True	integer	整數：發送的順序，從1開始
Role	role	True	string	檢視者角色名稱。用於映射進階參數
主旨	subject		string	檢視者的自訂電子郵件主旨
Message	message		string	檢視者的自訂電子郵件訊息
Email	email	True	string	核准者電子郵件地址
Role	role	True	string	核准者角色名稱
訂單	order	True	integer	接收核准要求的順序
Role	role	True	string	核准者角色名稱。用於映射進階參數
到期日	expiration_days		integer	邀請到期前的天數
Message	message		string	核准者的自訂電子郵件訊息
主旨	subject		string	核准者的自訂電子郵件主旨
驗證類型	authentication_type		string	在簽署工作階段期間用於收件者驗證的驗證類型。允許的值：「密碼」、「電話」和「簡訊」
密碼	password		string	為簽署者驗證設定的密碼。「密碼」驗證類型需要
電話	phone		string	用於驗證簽署者的電話號碼。「電話通話」和「簡訊」驗證類型為必要項目。範例：+1XXXXXXXXX
驗證簡訊訊息	authentication_sms_message		string	傳送給簽署者的自訂簡訊訊息，包含 {password} 預留位置。與「簡訊」驗證類型一起使用。如果沒有此參數，簽署者會收到帶有自動產生密碼（解鎖碼）的預設簡訊 - 「SignNow 文件邀請解鎖碼：123456」。範例：輸入密碼 {password} 以解除鎖定文件
重新導向 URI	redirect_uri		string	核准者核准文件後開啟的 URL
重新導向目標	redirect_target		string	決定是否要在瀏覽器的新索引標籤中開啟重新導向 URI，或在簽署工作階段之後在相同的索引標籤中開啟重新導向 URI。可能的值：「在新分頁中」 – 在新分頁中開啟連結，「在同一分頁中」 — 在同一分頁中開啟連結
寄件者	from		string	寄件者電子郵件地址。只能使用與您的 SignNow 帳戶關聯的電子郵件（登入電子郵件）。如果留空，則會自動設定
ID	id		string	電子郵件群組的ID。必須事先建立的唯一 40 個字元識別碼
名稱	name		string	群組的名稱。在「簽署者 > 電子郵件群組」欄位中使用該選項
Email	email		string	應收到邀請的電子郵件地址
Email	email		string	應收到邀請的電子郵件地址
名稱	name		string	步驟名稱
Email	email		string	副本收件人電子郵件地址
Step	step		integer	發送順序，從1開始
主旨	subject		string	所有收件者的電子郵件主旨
Message	message		string	所有收件者的電子郵件訊息
CC 主題	cc_subject		string	所有副本收件者的副本電子郵件主旨
抄送訊息	cc_message		string	所有副本收件者的副本電子郵件訊息
QES 簽名	signature		string	QES 類型。可能的值：「Eideasy」、「Nom151」。用於向簽署者請求 QES 簽名。邀請中的所有簽署者都必須使用相同的簽名類型。若要使用 QES 建立邀請，使用者必須屬於已啟用 QES 的組織

傳回

名稱	路徑	類型	Description
地位	status	string	地位

邀請簽署文件群組

作業識別碼：: InviteToSignDocGroupAllOptions

此動作會建立簽署文件群組的邀請。您可以設定多步驟工作流程，讓不同的收件者在不同階段對文件群組採取行動

參數

名稱	機碼	必要	類型	Description
文件群組 ID	id	True	string	文件群組 ID
訂單	order	True	integer	簽署步驟順序：1 - 收件人先簽署文件組，然後將文件組發送到 2、3 等。數個收件者可以保留相同的簽署順序
Email	email		string	收件者電子郵件地址
電子郵件群組	email_group		string	收件者的連絡人群組
角色名稱	role_name	True	string	文件中的收件者角色名稱（可用來識別指派給此特定收件者的檔案中的欄位）
行動	action	True	string	允許對文件執行動作。可能的值：檢視、簽署、核准
文件 ID	document_id	True	string	此收件者需要採取動作的文件識別碼
必要的預設簽名名稱	required_preset_signature_name		string	簽名欄位的預先填入文字，已鎖定以供收件者編輯
允許轉發	allow_reassign		boolean	定義收件者是否可以將邀請轉寄至另一個電子郵件地址。 'true'：收件者可以轉發邀請;'false'：收件者無法轉寄邀請
允許依簽章拒絕	decline_by_signature		boolean	定義是否在簽名欄位上顯示 [拒絕簽署] 選項。 True：顯示拒絕選項;False：隱藏拒絕選項
驗證類型	type		string	在簽署工作階段期間用於收件者驗證的驗證類型。允許的值：「密碼」、「電話」和「簡訊」
密碼	value		string	為簽署者驗證設定的密碼。「密碼」驗證類型需要
電話	phone		string	用於驗證簽署者的電話號碼。「電話通話」和「簡訊」驗證類型為必要項目。範例：+1XXXXXXXXX
Message	message		string	傳送給簽署者的自訂簡訊訊息，包含 {password} 預留位置。與「簡訊」驗證類型一起使用。如果沒有此參數，簽署者會收到帶有自動產生密碼（解鎖碼）的預設簡訊 - 「SignNow 文件邀請解鎖碼：123456」
商家標識符	merchant_id		string	新增至您組織的商家帳戶的ID
貨幣	currency		string	要求的付款貨幣
總數	amount		string	要求的付款金額
Uri	redirect_uri		string	完成並簽署所有要求的欄位後，簽署者會重新導向至此 URI
重新導向目標	redirect_target		string	決定是否要在瀏覽器的新索引標籤中開啟重新導向 URI，或在簽署工作階段之後在相同的索引標籤中開啟重新導向 URI。可能的值：「在新分頁中」 – 在新分頁中開啟連結，「在同一分頁中」 — 在同一分頁中開啟連結
拒絕重新導向 Uri	decline_redirect_uri		string	收件者拒絕文件後開啟的連結
關閉重新導向 Uri	close_redirect_uri		string	當簽署者在簽署工作階段期間按一下「儲存進度」和「稍後完成」或「在檢視模式中關閉」時開啟的連結
完成重定向是否已取消	is_finish_redirect_canceled		boolean	指定是否取消組織的完成重新導向設定。 True – 重新導向已取消;False – 重新導向保持作用中
關閉重新導向是否已取消	is_close_redirect_canceled		boolean	指定是否取消組織的儲存進度重新導向設定。 True – 重新導向已取消;False – 重新導向保持作用中
拒絕重新導向是否已取消	is_decline_redirect_canceled		boolean	指定是否取消組織的拒絕重新導向設定。 True – 重新導向已取消;False – 重新導向保持作用中
語言	language		string	指定簽署者簽署工作階段和通知電子郵件的語言。可能的值：en 代表英文，es 代表西班牙文，fr 代表法文。如果未設定，則語言由您的 SignNow 帳戶的語言決定
訂單	order	True	integer	簽署步驟順序：1 - 收件人先簽署文件組，然後將文件組發送到 2、3 等。數個收件者可以保留相同的簽署順序
Email	email	True	string	收件者的電子郵件地址
電子郵件群組	email_group		string	收件者的連絡人群組
主旨	subject		string	收件者的自訂電子郵件主旨
Message	message		string	收件者的自訂電子郵件訊息
到期前天數	expiration_days		integer	在 x 天內，邀請會過期（從 3 到 180 天）
在 X 天內發送提醒	remind_after		integer	邀請後 X 天，收件人會收到提醒電子郵件（從 1 到 179 天）。必須少於到期日
在到期前 X 天內發送提醒	remind_before		integer	到期前 X 天，收款人會收到提醒電子郵件（從 1 到 179 天）。必須少於到期日
每 X 天發送一次提醒	remind_repeat		integer	邀請傳送後，接收者每 x 天收到一封提醒電子郵件（1 到 7 天）
身份識別碼	id		string	電子郵件群組的ID。必須事先建立的唯一 40 個字元識別碼
名稱	name		string	群組的名稱。在「邀請步驟 > 電子郵件群組」中使用它
Email	email		string	應收到邀請的電子郵件地址
Email	email		string	將收到完成電子郵件的收件者的電子郵件地址
停用文件附件	disable_document_attachment		boolean	是否停用傳送包含完成電子郵件的文件附件。可能的值：False - 啟用文件附件，True - 停用文件附件
主旨	subject		string	完成電子郵件的自訂主旨
Message	message		string	完成電子郵件的自訂訊息
簽署為合併	sign_as_merged		boolean	如果為true，則允許API使用者傳送邀請，該邀請會在單一檔案中以合併檔案群組的形式開啟
用戶端時間戳記	client_timestamp		integer	文件群組邀請的時間戳記
Email	email		string	應收到邀請的電子郵件地址
QES 簽名	signature		string	QES 類型。可能的值：「Eideasy」、「Nom151」。用於向簽署者請求 QES 簽名。邀請中的所有簽署者都必須使用相同的簽名類型。若要使用 QES 建立邀請，使用者必須屬於已啟用 QES 的組織

傳回

名稱	路徑	類型	Description
身份識別碼	id	string	文件群組邀請 ID
待處理的邀請連結	pending_invite_link	string	待處理的邀請連結

預先填入文件欄位值

作業識別碼：: UpdateFieldValues_V2

使用特定值自動填入文件中的可填寫欄位

參數

名稱	機碼	必要	類型	Description
Template	template_id	True	string	指定要從中取得欄位的文件範本
文件 ID	doc_id	True	string	指定唯一的文件識別碼
fields	fields		dynamic

傳回

名稱	路徑	類型	Description
文件 ID	id	DocumentId	唯一文件 ID

預先填入文件欄位值 [已淘汰]

作業識別碼：: UpdateFieldValues

此動作已被取代。請改用預填文件欄位值。

~~預先填入欄位值和屬性。~~

參數

名稱	機碼	必要	類型	Description
Template	template_id	True	string	指定要從中取得欄位的文件範本
文件 ID	doc_id	True	string	指定唯一的文件識別碼
fields	fields		dynamic

傳回

名稱	路徑	類型	Description
文件 ID	id	DocumentId	唯一文件 ID

預先填入文件群組智慧欄位值

作業識別碼：: UpdateGroupSmartFieldValues

使用特定值自動填入文件中的智慧欄位

參數

名稱	機碼	必要	類型	Description
Template	template_group_id	True	string	指定要從中取得欄位的文件群組範本
文件群組 ID	doc_group_id	True	string	指定唯一的文件群組 ID
fields	fields		dynamic

傳回

名稱	路徑	類型	Description
文件群組 ID	id	DocumentGroupId	唯一文件群組 ID

預先填入文件群組欄位值

作業識別碼：: UpdateGroupFieldValues

使用特定值自動填充文檔中的可填寫字段

參數

名稱	機碼	必要	類型	Description
Template	template_group_id	True	string	指定要從中取得欄位的文件群組範本
文件群組 ID	doc_group_id	True	string	指定唯一的文件群組 ID
fields	fields		dynamic

傳回

名稱	路徑	類型	Description
文件群組 ID	id	DocumentGroupId	唯一文件群組 ID

預先填入智慧欄位值

作業識別碼：: PrefillSmartFields

預先填入指定文件的「智慧型欄位」值

參數

名稱	機碼	必要	類型	Description
Template	template_id	True	string	指定要從中取得欄位的文件範本
文件 ID	doc_id	True	string	指定唯一的文件識別碼
fields	fields		dynamic

觸發程序

在文件事件上啟動流程

選取要觸發的事件：新的或更新的簽名邀請;當有人建立、更新、完成或刪除文件時

在文件事件上啟動流程 [已淘汰]

此動作已被取代。請改用 [在文件事件上啟動流程 ]。

~~您可以為下列其中一個事件建立觸發器：文件建立、文件更新、文件刪除、文件完成、邀請建立、邀請更新~~

在文件事件上啟動流程

作業識別碼：: Triggers_V2

選取要觸發的事件：新的或更新的簽名邀請;當有人建立、更新、完成或刪除文件時

參數

名稱	機碼	必要	類型	Description
Event	event	True	string	選取應觸發流程的事件

傳回

名稱	路徑	類型	Description
Event	meta.event	string	導致觸發程序的文件事件。
文件 ID	content.document_id	string	導致事件的目標文件的唯一ID。
文件名稱	content.document_name	string	目標文件檔名，不含副檔名

在文件事件上啟動流程 [已淘汰]

作業識別碼：: Triggers

此動作已被取代。請改用 [在文件事件上啟動流程 ]。

~~您可以為下列其中一個事件建立觸發器：文件建立、文件更新、文件刪除、文件完成、邀請建立、邀請更新~~

參數

名稱	機碼	必要	類型	Description
Event	event	True	string	選取應該觸發流程的事件。

傳回

名稱	路徑	類型	Description
時間戳	meta.timestamp	integer	事件發生的日期和時間（Unix 時間戳記格式）。
Event	meta.event	string	導致觸發程序的文件事件。
文件 ID	content.document_id	string	導致事件的目標文件的唯一ID。
文件名稱	content.document_name	string	目標文件檔名，不含副檔名

定義

文件屬性

名稱	路徑	類型	Description
文件 ID	id	DocumentId	唯一文件 ID
文件名稱	document_name	string	沒有副檔名的文件檔名
頁數	page_count	integer	文件中的頁數
已建立	created	integer	以 Unix 時間戳記格式建立文件的日期和時間
Updated	updated	integer	文件以 Unix 時間戳記格式更新的日期和時間
範本名稱	original_filename	string	範本檔案名稱與副檔名（如有）
範本識別碼	origin_document_id	string	範本文件 ID （如有）
是模板	template	boolean	如果文件是範本，則為 true。
文件狀態	status	string	文件狀態

DocumentGroups回應

名稱	路徑	類型	Description
document_groups	document_groups	array of DocumentGroupProperties
文件群組總計數	document_group_total_count	integer	SignNow 帳戶中的文件群組總數

文件群組屬性

名稱	路徑	類型	Description
文件群組 ID	group_id	DocumentGroupId	唯一文件群組 ID
文件群組名稱	group_name	string	文件群組名稱
Documents	documents	array of DocumentGroupDocumentProperties	Documents

DocumentGroupDocumentProperties

名稱	路徑	類型	Description
文件 ID	id	DocumentId	唯一文件 ID
文件名稱	document_name	string	沒有副檔名的文件檔名
範本識別碼	origin_document_id	string	範本文件 ID （如有）

CreateDocumentGroupFromFiles回應

名稱	路徑	類型	Description
文件群組名稱	group_name	string	文件群組名稱
文件群組識別碼	group_id	string	文件群組識別碼
檔	documents	array of object
文件 ID	documents.id	DocumentId	唯一文件 ID
文件名稱	documents.name	string	文件名稱

DocumentId

唯一文件 ID

文件 ID: string

文件群組識別碼

唯一文件群組 ID

文件群組 ID: string

物件

這是類型 'object'。

二進位

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

共用方式為

立即簽名

SignNow 連接器

Pre-requisites

部署範例

支援的動作和觸發器

節流限制

動作

上傳文件

參數

傳回

下載文件

參數

傳回

刪除文件

參數

傳回

刪除文件內嵌邀請

參數

刪除文件群組內嵌邀請

參數

取代文件群組邀請中的收件者

參數

傳回

取代文件邀請中的收件者

參數

傳回

取得文件欄位

參數

傳回

取得文件欄位 [已棄用]

參數

傳回

取得文件清單

參數

傳回

取得文件結構描述 [已淘汰]

參數

傳回

取得文件群組

參數

傳回

取得文件群組

參數

傳回

取得文件群組邀請狀態

參數

傳回

取得文件資訊

參數

傳回

取得文件邀請狀態

參數

傳回

取消邀請

參數

傳回

已棄用 - 進階文件邀請

參數

傳回

已棄用 - 邀請簽署

參數

傳回

已棄用 - 邀請簽署文件群組

參數

傳回

建立文件內嵌傳送連結

參數

傳回

建立文件內嵌邀請

參數

傳回

建立文件群組內嵌傳送連結

參數

傳回

建立文件群組內嵌邀請

參數

傳回

建立簽署連結

參數