Annature (独立した発行元) (プレビュー)
Annature は、統合されたデジタル署名プロバイダーを備えた、オーストラリアが所有する大手 eSigning ソリューションです。 このコネクタは、企業が Annature API (v1) を使用して封筒を作成し、Annature ドキュメント署名ワークフローを統合するのに役立ちます。
このコネクタは、次の製品とリージョンで使用できます。
| サービス | クラス | リージョン |
|---|---|---|
| コピロット スタジオ | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| ロジック アプリ | Standard | 次を除くすべての Logic Apps リージョン : - Azure Government リージョン - Azure China リージョン - 米国国防総省 (DoD) |
| Power Apps | Premium | 次を除くすべての Power Apps リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| Power Automate | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| お問い合わせ | |
|---|---|
| 名前 | Dr Adrian Colquhoun (Strategik) |
| URL | https://www.linkedin.com/in/adriancolquhoun/ |
| adrian@strategik.com.au |
| コネクタ メタデータ | |
|---|---|
| Publisher | Dr Adrian Colquhoun (Strategik) |
| Website | https://annature.com.au |
| プライバシー ポリシー | https://www.annature.com.au/privacy-policy |
| カテゴリ | 生産性 |
接続を作成する
コネクタでは、次の認証の種類がサポートされています。
| デフォルト | 接続を作成するためのパラメーター。 | すべてのリージョン | 共有不可 |
デフォルト
適用対象: すべてのリージョン
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 名前 | タイプ | Description | 必須 |
|---|---|---|---|
| Annature Id | 文字列 | Annature Id | 正しい |
| Annature キー | securestring | Annature キー | 正しい |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| Void エンベロープ |
封筒を送信する |
| アカウントを取得する |
すべてのアカウントを一覧表示する |
| テンプレートから封筒を作成する |
テンプレートを使用する |
| テンプレートの取得 |
テンプレートの取得 |
| テンプレートを取得する |
すべてのテンプレートを一覧表示する |
| ドキュメントを取得する |
封筒のすべてのドキュメントを一覧表示する |
| フィールドのすべての添付ファイルを取得する |
フィールドの添付ファイルを取得する |
| フィールドの取得 |
フィールドの取得 |
| フィールドの取得 |
すべてのフィールドを一覧表示する |
| 受信者の取得 |
封筒の作成応答本文で返された id プロパティを使用して、封筒用に作成された 1 人の受信者を取得します |
| 封筒の削除 |
封筒の削除 |
| 封筒を作成する |
封筒を作成する |
| 封筒を取得する |
封筒を取得する |
| 封筒を取得する |
すべての封筒を一覧表示する |
| 封筒を送信する |
封筒を送信する |
| 組織を取得する |
組織を取得する |
Void エンベロープ
封筒を送信する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
封筒 ID
|
id | True | string |
封筒 ID |
アカウントを取得する
すべてのアカウントを一覧表示する
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string | |
|
名前
|
name | string |
名前 |
|
Email
|
string |
|
|
|
数値
|
number | string | |
|
timezone
|
timezone | string | |
|
ロール
|
role | string | |
|
活動中
|
active | boolean | |
|
group_id
|
group_id | string | |
|
作成済み
|
created | string | |
|
検証
|
verified | string |
テンプレートから封筒を作成する
テンプレートを使用する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
テンプレート識別子
|
id | True | string |
テンプレート識別子 |
|
名前
|
name | string |
受信者に送信された電子メールの件名に表示され、封筒を表示するときに表示される封筒の名前 |
|
|
下書き
|
draft | boolean |
下書き |
|
|
メッセージ
|
message | string |
メッセージ |
|
|
Shared
|
shared | boolean |
Shared |
|
|
アカウント ID
|
account_id | True | string |
アカウント ID |
|
グループ ID
|
group_id | string |
グループ ID |
|
|
グループ ID
|
id | string |
グループ ID |
|
|
名前
|
name | string |
名前 |
|
|
グループ ID
|
type | string |
グループ ID |
|
|
ファイル コンテンツ
|
base | byte |
ファイル コンテンツ |
|
|
ロール ID
|
role_id | string |
ロール ID |
|
|
名前
|
name | string |
名前 |
|
|
電子メール ID
|
string |
電子メール ID |
||
|
モバイル
|
mobile | string |
モバイル |
|
|
SMS 認証
|
sms_auth | string |
SMS 認証 |
|
|
受信者の種類
|
type | string |
受信者の種類。既定では、指定されていない場合は署名者になります |
|
|
メッセージ
|
message | string |
メッセージ |
|
|
パスワード
|
password | string | ||
|
ミュート。
|
muted | boolean |
これにより、Annature が受信者に通信を送信できなくなります |
|
|
署名順序
|
order | integer |
署名順序 |
|
|
フィールド ID (テンプレートから)
|
id | True | string |
テンプレート フィールドの ID |
|
価値
|
value | True | string |
このフィールドの値 |
|
受信者が封筒を完了した後の宛先エンドポイント
|
session_completed | string |
受信者が封筒を完了した後の宛先エンドポイント |
|
|
受信者が封筒への署名を拒否した後の宛先エンドポイント
|
session_declined | string |
受信者が封筒への署名を拒否した後の宛先エンドポイント |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | string |
ID (アイディー) |
|
名前
|
name | string |
名前 |
|
メッセージ
|
message | string |
メッセージ |
|
共有
|
shared | boolean |
共有されますか? |
|
ドラフト
|
draft | boolean | |
|
account_id
|
account_id | string |
アカウント ID |
|
group_id
|
group_id | string |
グループ ID |
|
書類
|
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
|
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 |
テンプレートの取得
テンプレートの取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
テンプレート識別子
|
id | True | string |
テンプレート識別子 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | string | |
|
名前
|
name | string | |
|
Shared
|
shared | boolean |
Shared |
|
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
|
roles | array of object | |
|
ID (アイディー)
|
roles.id | string |
ID (アイディー) |
|
名前
|
roles.name | string |
名前 |
|
受信者名
|
roles.recipient_name | string |
受信者名 |
|
受信者の電子メール
|
roles.recipient_email | string |
受信者の電子メール |
|
Recipient Mobile
|
roles.recipient_mobile | string |
Recipient Mobile |
|
受信者の種類
|
roles.recipient_type | string |
受信者の種類。既定では、指定されていない場合は署名者になります |
|
パスワード
|
roles.recipient_password | string |
パスワード |
|
署名順序
|
roles.order | integer |
署名順序 |
|
受信者が封筒を完了した後の宛先エンドポイント
|
roles.recipient_redirects.session_completed | string |
受信者が封筒を完了した後の宛先エンドポイント |
|
受信者が封筒への署名を拒否した後の宛先エンドポイント
|
roles.recipient_redirects.session_declined | string |
受信者が封筒への署名を拒否した後の宛先エンドポイント |
テンプレートを取得する
すべてのテンプレートを一覧表示する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
名前
|
name | string |
テンプレートに基づくリストの完全一致フィルター |
|
|
前に作成済み
|
created_before | date |
作成された日付が指定された値の前にある結果を返します。 |
|
|
作成後
|
created_after | date |
指定された値の後に作成された日付が含まれる結果を返します。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string | |
|
名前
|
name | string | |
|
Shared
|
shared | boolean |
Shared |
|
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
|
roles | array of object | |
|
ID (アイディー)
|
roles.id | string |
ID (アイディー) |
|
名前
|
roles.name | string |
名前 |
|
受信者名
|
roles.recipient_name | string |
受信者名 |
|
受信者の電子メール
|
roles.recipient_email | string |
受信者の電子メール |
|
Recipient Mobile
|
roles.recipient_mobile | string |
Recipient Mobile |
|
受信者の種類
|
roles.recipient_type | string |
受信者の種類。既定では、指定されていない場合は署名者になります |
|
パスワード
|
roles.recipient_password | string |
パスワード |
|
署名順序
|
roles.order | integer |
署名順序 |
|
受信者が封筒を完了した後の宛先エンドポイント
|
roles.recipient_redirects.session_completed | string |
受信者が封筒を完了した後の宛先エンドポイント |
|
受信者が封筒への署名を拒否した後の宛先エンドポイント
|
roles.recipient_redirects.session_declined | string |
受信者が封筒への署名を拒否した後の宛先エンドポイント |
ドキュメントを取得する
封筒のすべてのドキュメントを一覧表示する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
封筒 ID
|
envelope_id | True | string |
封筒 ID |
|
エンドポイントの期間
|
endpoint_duration | integer |
元のエンドポイントとマスター エンドポイントにアクセスできる時間 (分) を設定します。 数値の範囲は 1 ~ 10080 で、既定値は 60 です |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
ID (アイディー)
|
id | string |
ID (アイディー) |
|
名前
|
name | string |
名前 |
|
pages
|
pages | integer | |
|
元の画像サイズ
|
original | string |
元の画像サイズ |
|
マスター
|
master | string |
マスター |
|
作成済み
|
created | string |
作成済み |
フィールドのすべての添付ファイルを取得する
フィールドの添付ファイルを取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
封筒 ID
|
envelope_id | True | string |
封筒 ID |
|
フィールド ID
|
id | True | string |
フィールド ID |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string | |
|
翻訳元
|
original | string | |
|
名前
|
name | string | |
|
型
|
type | string | |
|
size
|
size | integer | |
|
作成済み
|
created | string |
フィールドの取得
フィールドの取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
封筒 ID
|
envelope_id | True | string |
封筒 ID |
|
フィールド ID
|
id | True | string |
フィールド ID |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | string |
ID (アイディー) |
|
recipient_id
|
recipient_id | string |
受信者 ID |
|
型
|
type | string |
タイプ |
|
page
|
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 | integer | |
|
width
|
width | integer | |
|
options
|
options | ||
|
font_size
|
font_size | integer | |
|
font_type
|
font_type | string |
指定できる値は、courier と helvetica です |
|
date_format
|
date_format | string |
日付形式 |
|
作成済み
|
created | string |
作成済み |
フィールドの取得
すべてのフィールドを一覧表示する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
封筒 ID
|
envelope_id | True | string |
封筒 ID |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string | |
|
recipient_id
|
recipient_id | string | |
|
型
|
type | string | |
|
page
|
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 | integer | |
|
width
|
width | integer | |
|
options
|
options | ||
|
font_size
|
font_size | integer | |
|
font_type
|
font_type | string | |
|
date_format
|
date_format | string | |
|
作成済み
|
created | string |
受信者の取得
封筒の作成応答本文で返された id プロパティを使用して、封筒用に作成された 1 人の受信者を取得します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Recipient
|
id | True | string |
受信者 ID |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID (アイディー)
|
id | string |
ID (アイディー) |
|
名前
|
name | string |
名前 |
|
メール
|
string |
|
|
|
モバイル
|
mobile | string |
モバイル |
|
型
|
type | string |
タイプ |
|
状態
|
status | string |
ステータス |
|
メッセージ
|
message | string |
メッセージ |
|
パスワード
|
password |
パスワード |
|
|
Muted
|
muted | boolean |
Muted |
|
順序
|
order | integer | |
|
declined_reason
|
declined_reason | string |
Declined_reason |
|
作成済み
|
created | string |
作成済み |
|
送信
|
sent | string |
Sent |
|
減少
|
declined | string |
拒否 |
|
完了
|
completed | string |
完了済み |
|
session_completed
|
redirects.session_completed | string |
Session_completed |
|
session_declined
|
redirects.session_declined | string |
Session_declined |
封筒の削除
封筒の削除
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
封筒 ID
|
id | True | string |
封筒 ID |
封筒を作成する
封筒を作成する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
名前
|
name | True | string |
受信者に送信された電子メールの件名に表示され、封筒を表示するときに表示される封筒の名前 |
|
メッセージ
|
message | string |
メッセージ |
|
|
Shared
|
shared | boolean |
Shared |
|
|
下書き
|
draft | boolean |
下書き |
|
|
アカウント ID
|
account_id | True | string |
アカウント ID |
|
グループ ID
|
group_id | string |
グループ ID |
|
|
グループ ID
|
id | string |
グループ ID |
|
|
名前
|
name | string |
名前 |
|
|
タイプ
|
type | string |
タイプ |
|
|
ファイル コンテンツ
|
base | byte |
ファイル コンテンツ |
|
|
名前
|
name | string |
名前 |
|
|
電子メール ID
|
string |
電子メール ID |
||
|
モバイル
|
mobile | string |
モバイル |
|
|
受信者の種類
|
type | string |
受信者の種類。既定では、指定されていない場合は署名者になります |
|
|
メッセージ
|
message | string |
メッセージ |
|
|
パスワード
|
password | string | ||
|
ミュート。
|
muted | boolean |
これにより、Annature が受信者に通信を送信できなくなります |
|
|
署名順序
|
order | integer |
署名順序 |
|
|
セッション完了
|
session_completed | string |
受信者が封筒を完了した後の宛先エンドポイント |
|
|
セッションが拒否されました
|
session_declined | string |
受信者が封筒への署名を拒否した後の宛先エンドポイント |
|
|
id
|
id | string | ||
|
recipient_id
|
recipient_id | string | ||
|
型
|
type | string |
フィールドの種類 |
|
|
page
|
page | integer | ||
|
x_coordinate
|
x_coordinate | integer | ||
|
y_coordinate
|
y_coordinate | integer | ||
|
必須
|
required | boolean |
必須 |
|
|
読み取り専用
|
read_only | boolean |
読み取り専用 |
|
|
コラボレイティブ
|
collaborative | boolean |
コラボレイティブ |
|
|
width
|
width | integer | ||
|
font_size
|
font_size | integer | ||
|
font_type
|
font_type | string |
指定できる値は、courier と helvetica です |
|
|
作成済み
|
created | string |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | string |
ID (アイディー) |
|
名前
|
name | string |
名前 |
|
メッセージ
|
message | string |
メッセージ |
|
状態
|
status | string |
ステータス |
|
Shared
|
shared | boolean |
Shared |
|
作成日
|
created | string |
作成日 |
|
送信日
|
sent | string |
送信日 |
|
無効
|
voided | ||
|
減少
|
declined | ||
|
完了
|
completed | ||
|
アカウント ID
|
account_id | string |
Account_id |
|
グループ ID
|
group_id | string |
グループ ID |
|
Recipients
|
recipients | array of object | |
|
id
|
recipients.id | string | |
|
名前
|
recipients.name | string | |
|
メール
|
recipients.email | string | |
|
モバイル
|
recipients.mobile | string | |
|
型
|
recipients.type | string | |
|
状態
|
recipients.status | string | |
|
メッセージ
|
recipients.message | string | |
|
パスワード
|
recipients.password |
パスワード |
|
|
Muted
|
recipients.muted | boolean |
Muted |
|
順序
|
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 |
封筒を取得する
封筒を取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
封筒 ID
|
id | True | string |
封筒 ID |
|
エンドポイントの期間
|
endpoint_duration | integer |
元のエンドポイントとマスター エンドポイントにアクセスできる時間 (分) を設定します。 数値の範囲は 1 ~ 10080 で、既定値は 60 です |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | string |
ID (アイディー) |
|
名前
|
name | string |
名前 |
|
メッセージ
|
message | string |
メッセージ |
|
状態
|
status | string |
ステータス |
|
共有
|
shared | boolean |
Shared |
|
作成済み
|
created | string |
作成済み |
|
送信
|
sent | string |
Sent |
|
無効
|
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 |
グループ ID |
|
受取人
|
recipients | array of object | |
|
名前
|
recipients.name | string |
名前 |
|
電子メール ID
|
recipients.email | string |
電子メール ID |
|
モバイル
|
recipients.mobile | string |
モバイル |
|
受信者の種類
|
recipients.type | string |
受信者の種類。既定では、指定されていない場合は署名者になります |
|
メッセージ
|
recipients.message | string |
メッセージ |
|
パスワード
|
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 | |
|
id
|
recipients.fields.id | string | |
|
recipient_id
|
recipients.fields.recipient_id | string | |
|
型
|
recipients.fields.type | string | |
|
page
|
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 |
コラボレイティブ |
|
width
|
recipients.fields.width | integer | |
|
font_size
|
recipients.fields.font_size | integer | |
|
font_type
|
recipients.fields.font_type | string | |
|
作成済み
|
recipients.fields.created | string |
封筒を取得する
すべての封筒を一覧表示する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
封筒名
|
name | string |
封筒の name プロパティに基づくリストの完全一致フィルター |
|
|
封筒の状態
|
status | string |
封筒の状態に基づくリストの完全一致フィルター |
|
|
受信者名
|
recipient | string |
受信者の名前または電子メール プロパティに基づくリストの完全一致フィルター |
|
|
前に作成済み
|
created_before | date |
作成された日付が指定された値の前にある結果を返します。 |
|
|
作成後
|
created_after | date |
指定された値の後に作成された日付が含まれる結果を返します。 |
|
|
前に完了しました
|
completed_before | date |
指定された値の前に完了した日付が含まれる結果を返します。 |
|
|
完了後
|
completed_after | date |
指定した値の後に完了した日付が含まれる結果を返します。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string |
ID (アイディー) |
|
名前
|
name | string |
名前 |
|
メッセージ
|
message | string |
メッセージ |
|
状態
|
status | string |
ステータス |
|
共有
|
shared | boolean |
Shared |
|
作成済み
|
created | string |
作成済み |
|
送信
|
sent | string |
Sent |
|
無効
|
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 |
グループ ID |
|
受取人
|
recipients | array of object | |
|
名前
|
recipients.name | string |
名前 |
|
電子メール ID
|
recipients.email | string |
電子メール ID |
|
モバイル
|
recipients.mobile | string |
モバイル |
|
受信者の種類
|
recipients.type | string |
受信者の種類。既定では、指定されていない場合は署名者になります |
|
メッセージ
|
recipients.message | string |
メッセージ |
|
パスワード
|
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 | |
|
id
|
recipients.fields.id | string | |
|
recipient_id
|
recipients.fields.recipient_id | string | |
|
型
|
recipients.fields.type | string | |
|
page
|
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 |
コラボレイティブ |
|
width
|
recipients.fields.width | integer | |
|
font_size
|
recipients.fields.font_size | integer | |
|
font_type
|
recipients.fields.font_type | string | |
|
作成済み
|
recipients.fields.created | string |
封筒を送信する
封筒を送信する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
封筒 ID
|
id | True | string |
封筒 ID |
組織を取得する
組織を取得する
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | string |
ID (アイディー) |
|
名前
|
name | string |
名前 |
|
事
|
business | string |
ビジネス |
|
メール
|
string |
|
|
|
数値
|
number | string |
Number |
|
address
|
address | string |
住所 |
|
Web サイト
|
website | string |
Website |
|
ロゴ
|
logo | string |
Logo |
|
色
|
colour | string |
色 |
|
作成済み
|
created | string |
作成済み |
トリガー
| イベント トリガー - エンベロープと受信者 |
エンベロープの完了または受信者のビューが完了したときにイベントが発生したときにトリガーされます |
イベント トリガー - エンベロープと受信者
定義
WebhookEventContent
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
イベント
|
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 |