Annature (独立発行者) (プレビュー)
Annature は、統合されたデジタル署名プロバイダーを備えた、オーストラリアが所有する主要な電子署名ソリューションです。 このコネクタは、企業がエンベロープを作成し、Annature API (v1) を使用して annature ドキュメント署名ワークフローを統合するのに役立ちます。
このコネクタは、次の製品および地域で利用可能です:
| Service | クラス | 地域 |
|---|---|---|
| Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
| Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 国防総省 (DoD) |
| Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| お問い合わせ先 | |
|---|---|
| 件名 | Dr Adrian Colquhoun (Strategik) |
| [URL] | https://www.linkedin.com/in/adriancolquhoun/ |
| メール | adrian@strategik.com.au |
| Connector Metadata | |
|---|---|
| 発行者 | Dr Adrian Colquhoun (Strategik) |
| Web サイト | https://annature.com.au |
| プライバシー ポリシー | https://www.annature.com.au/privacy-policy |
| カテゴリー | 生産性 |
接続を作成する
コネクタは、次の認証タイプをサポートしています:
| 既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
既定
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 Power App が別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 件名 | タイプ | Description | Required |
|---|---|---|---|
| Annature Id | string | Annature Id | True |
| Annature キー | securestring | Annature キー | True |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| エンベロープの無効 |
エンベロープの送信 |
| エンベロープの送信 |
エンベロープの送信 |
| エンベロープを作成する |
エンベロープを作成する |
| エンベロープを削除する |
エンベロープを削除する |
| エンベロープを取得する |
エンベロープを取得する |
| エンベロープを取得する |
すべてのエンベロープの一覧 |
| テンプレートからエンベロープを作成する |
テンプレートの使用 |
| テンプレートの取得 |
テンプレートの取得 |
| テンプレートの取得 |
すべてのテンプレートを一覧表示する |
| ドキュメントを取得する |
エンベロープのすべてのドキュメントを一覧表示する |
| フィールドのすべての添付書類を取得する |
フィールドの添付書類を取得する |
| フィールドを取得する |
フィールドを取得する |
| フィールドを取得する |
すべてのフィールドを表示する |
| 取引先企業を取得する |
すべてのアカウントのリスト |
| 受信者を取得する |
エンベロープの作成レスポンス本文で返されたidプロパティを使用して、エンベロープ用に作成された単一の受信者を取得します |
| 組織を取得する |
組織を取得する |
エンベロープの無効
エンベロープの送信
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
エンベロープ ID
|
id | True | string |
エンベロープ ID |
エンベロープの送信
エンベロープの送信
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
エンベロープ ID
|
id | True | string |
エンベロープ ID |
エンベロープを作成する
エンベロープを作成する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
件名
|
name | True | string |
受信者に送信される電子メールの件名およびエンベロープを表示するときに表示されるエンベロープの名前 |
|
Message
|
message | string |
Message |
|
|
共有
|
shared | boolean |
共有 |
|
|
ドラフト
|
draft | boolean |
ドラフト |
|
|
Account ID
|
account_id | True | string |
Account ID |
|
グループ ID
|
group_id | string |
グループ ID |
|
|
グループ ID
|
id | string |
グループ ID |
|
|
件名
|
name | string |
件名 |
|
|
タイプ
|
type | string |
タイプ |
|
|
ファイル内容
|
base | byte |
ファイル内容 |
|
|
件名
|
name | string |
件名 |
|
|
電子メール ID
|
string |
電子メール ID |
||
|
Mobile
|
mobile | string |
Mobile |
|
|
受信者の種類
|
type | string |
受信者のタイプ。指定されていない場合はデフォルトで署名者になります |
|
|
Message
|
message | string |
Message |
|
|
password
|
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_座標
|
x_coordinate | integer | ||
|
y_座標
|
y_coordinate | integer | ||
|
Required
|
required | boolean |
Required |
|
|
読み取り専用
|
read_only | boolean |
読み取り専用 |
|
|
共同作業
|
collaborative | boolean |
共同作業 |
|
|
幅
|
width | integer | ||
|
font_size
|
font_size | integer | ||
|
font_type
|
font_type | string |
可能な値は、courier と helvetica です |
|
|
created
|
created | string |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | string |
Id |
|
名称
|
name | string |
件名 |
|
message
|
message | string |
Message |
|
ステータス
|
status | string |
Status |
|
共有
|
shared | boolean |
共有 |
|
作成日
|
created | string |
作成日 |
|
送信日
|
sent | string |
送信日 |
|
無効化済み
|
voided | ||
|
拒否済み
|
declined | ||
|
completed
|
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 | |
|
message
|
recipients.message | string | |
|
Password
|
recipients.password |
Password |
|
|
ミュート
|
recipients.muted | boolean |
ミュート |
|
注文
|
recipients.order | integer | |
|
declined_reason
|
recipients.declined_reason | ||
|
created
|
recipients.created | string | |
|
送信数
|
recipients.sent | string | |
|
拒否済み
|
recipients.declined | ||
|
completed
|
recipients.completed | ||
|
session_completed
|
recipients.redirects.session_completed | string | |
|
session_declined
|
recipients.redirects.session_declined | string |
エンベロープを削除する
エンベロープを削除する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
エンベロープ ID
|
id | True | string |
エンベロープ ID |
エンベロープを取得する
エンベロープを取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
エンベロープ ID
|
id | True | string |
エンベロープ ID |
|
エンドポイント期間
|
endpoint_duration | integer |
元のエンドポイントとマスター エンドポイントにアクセスできる分数を設定します。 数値は 1 ～ 10080 の範囲で、デフォルトは 60 です |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | string |
Id |
|
名称
|
name | string |
件名 |
|
message
|
message | string |
Message |
|
ステータス
|
status | string |
Status |
|
共有済み
|
shared | boolean |
共有 |
|
created
|
created | string |
Created |
|
送信数
|
sent | string |
送信数 |
|
無効化済み
|
voided | string |
無効化済み |
|
拒否済み
|
declined | string |
辞退 |
|
completed
|
completed | string |
Completed |
|
master
|
master | string |
マスター |
|
結合済み
|
combined | string |
結合済み |
|
証明書
|
certificate | string |
証明書 |
|
account_id
|
account_id | string |
取引先企業 ID |
|
group_id
|
group_id | string |
グループ ID |
|
Recipients
|
recipients | array of object | |
|
件名
|
recipients.name | string |
件名 |
|
電子メール ID
|
recipients.email | string |
電子メール ID |
|
Mobile
|
recipients.mobile | string |
Mobile |
|
受信者の種類
|
recipients.type | string |
受信者のタイプ。指定されていない場合はデフォルトで署名者になります |
|
Message
|
recipients.message | string |
Message |
|
Password
|
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_座標
|
recipients.fields.x_coordinate | integer | |
|
y_座標
|
recipients.fields.y_coordinate | integer | |
|
Required
|
recipients.fields.required | boolean |
Required |
|
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 | |
|
created
|
recipients.fields.created | string |
エンベロープを取得する
すべてのエンベロープの一覧
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
エンベロープの名前
|
name | string |
エンベロープの name プロパティに基づくリストの完全一致フィルター |
|
|
エンベロープの状態
|
status | string |
エンベロープのステータスに基づくリストの完全一致フィルター |
|
|
受取人の名前
|
recipient | string |
受信者の name または email プロパティに基づくリストの完全一致フィルター |
|
|
以前に作成済
|
created_before | date |
作成日が指定された値より前の結果を返します |
|
|
作成後
|
created_after | date |
作成日が指定された値より後の結果を返します |
|
|
以下以前に完了
|
completed_before | date |
完了日が指定された値より前の結果を返します |
|
|
以下の後に完了
|
completed_after | date |
完了日が指定された値より後の結果を返します |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string |
Id |
|
名称
|
name | string |
件名 |
|
message
|
message | string |
Message |
|
ステータス
|
status | string |
Status |
|
共有済み
|
shared | boolean |
共有 |
|
created
|
created | string |
Created |
|
送信数
|
sent | string |
送信数 |
|
無効化済み
|
voided | string |
無効化済み |
|
拒否済み
|
declined | string |
辞退 |
|
completed
|
completed | string |
Completed |
|
結合済み
|
combined | string |
結合済み |
|
master
|
master | string |
マスター |
|
証明書
|
certificate | string |
証明書 |
|
account_id
|
account_id | string |
取引先企業 ID |
|
group_id
|
group_id | string |
グループ ID |
|
Recipients
|
recipients | array of object | |
|
件名
|
recipients.name | string |
件名 |
|
電子メール ID
|
recipients.email | string |
電子メール ID |
|
Mobile
|
recipients.mobile | string |
Mobile |
|
受信者の種類
|
recipients.type | string |
受信者のタイプ。指定されていない場合はデフォルトで署名者になります |
|
Message
|
recipients.message | string |
Message |
|
Password
|
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_座標
|
recipients.fields.x_coordinate | integer | |
|
y_座標
|
recipients.fields.y_coordinate | integer | |
|
Required
|
recipients.fields.required | boolean |
Required |
|
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 | |
|
created
|
recipients.fields.created | string |
テンプレートからエンベロープを作成する
テンプレートの使用
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
テンプレート ID
|
id | True | string |
テンプレート ID |
|
件名
|
name | string |
受信者に送信される電子メールの件名およびエンベロープを表示するときに表示されるエンベロープの名前 |
|
|
ドラフト
|
draft | boolean |
ドラフト |
|
|
Message
|
message | string |
Message |
|
|
共有
|
shared | boolean |
共有 |
|
|
Account ID
|
account_id | True | string |
Account 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
|
mobile | string |
Mobile |
|
|
SMS Auth
|
sms_auth | string |
SMS Auth |
|
|
受信者の種類
|
type | string |
受信者のタイプ。指定されていない場合はデフォルトで署名者になります |
|
|
Message
|
message | string |
Message |
|
|
password
|
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
|
message | string |
Message |
|
共有済み
|
shared | boolean |
共有されていますか? |
|
下書き
|
draft | boolean | |
|
account_id
|
account_id | string |
取引先企業 ID |
|
group_id
|
group_id | string |
グループ ID |
|
documents
|
documents | array of object | |
|
Id
|
documents.id | string |
Id |
|
件名
|
documents.name | string |
件名 |
|
pages
|
documents.pages | integer | |
|
元の画像サイズ
|
documents.original | string |
元の画像サイズ |
|
マスター
|
documents.master | string |
マスター |
|
Created
|
documents.created | string |
Created |
|
recipients
|
recipients | array of object | |
|
role_id
|
recipients.role_id | string | |
|
名称
|
recipients.name | string | |
|
メールアドレス
|
recipients.email | string | |
|
携帯電話
|
recipients.mobile | string | |
|
message
|
recipients.message | string | |
|
password
|
recipients.password | string | |
|
ミュート済み
|
recipients.muted | boolean | |
|
session_completed
|
recipients.redirects.session_completed | string | |
|
session_declined
|
recipients.redirects.session_declined | string |
テンプレートの取得
テンプレートの取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
テンプレート ID
|
id | True | string |
テンプレート ID |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | string | |
|
名称
|
name | string | |
|
共有
|
shared | boolean |
共有 |
|
envelope_name
|
envelope_name | string | |
|
envelope_message
|
envelope_message | string | |
|
Envelope_shared
|
envelope_shared | boolean |
Envelope_shared |
|
created
|
created | string | |
|
account_id
|
account_id | string | |
|
group_id
|
group_id | string | |
|
documents
|
documents | array of object | |
|
Id
|
documents.id | string |
Id |
|
件名
|
documents.name | string |
件名 |
|
pages
|
documents.pages | integer | |
|
元の画像サイズ
|
documents.original | string |
元の画像サイズ |
|
マスター
|
documents.master | string |
マスター |
|
Created
|
documents.created | string |
Created |
|
roles
|
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 |
受信者のタイプ。指定されていない場合はデフォルトで署名者になります |
|
Password
|
roles.recipient_password | string |
Password |
|
署名順序
|
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 | boolean |
共有 |
|
envelope_name
|
envelope_name | string | |
|
envelope_message
|
envelope_message | string | |
|
Envelope_shared
|
envelope_shared | boolean |
Envelope_shared |
|
created
|
created | string | |
|
account_id
|
account_id | string | |
|
group_id
|
group_id | string | |
|
documents
|
documents | array of object | |
|
Id
|
documents.id | string |
Id |
|
件名
|
documents.name | string |
件名 |
|
pages
|
documents.pages | integer | |
|
元の画像サイズ
|
documents.original | string |
元の画像サイズ |
|
マスター
|
documents.master | string |
マスター |
|
Created
|
documents.created | string |
Created |
|
roles
|
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 |
受信者のタイプ。指定されていない場合はデフォルトで署名者になります |
|
Password
|
roles.recipient_password | string |
Password |
|
署名順序
|
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
|
created | string |
Created |
フィールドのすべての添付書類を取得する
フィールドの添付書類を取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
エンベロープ 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
|
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 |
アンカー |
|
x_座標
|
x_coordinate | integer | |
|
y_座標
|
y_coordinate | integer | |
|
Required
|
required | boolean |
Required |
|
Read_only
|
read_only | boolean |
Read_only |
|
共同作業
|
collaborative | boolean |
エンベロープの他の受信者が値を変更できるようにします |
|
価値
|
value | string |
フィールドの値 |
|
選択済みです
|
checked | boolean |
選択済みです |
|
高さ
|
height | integer | |
|
幅
|
width | integer | |
|
options
|
options | ||
|
font_size
|
font_size | integer | |
|
font_type
|
font_type | string |
可能な値は、courier と helvetica です |
|
date_format
|
date_format | string |
日付の表示形式 |
|
created
|
created | string |
Created |
フィールドを取得する
すべてのフィールドを表示する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
エンベロープ 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_座標
|
x_coordinate | integer | |
|
y_座標
|
y_coordinate | integer | |
|
Required
|
required | boolean |
Required |
|
Read_only
|
read_only | boolean |
Read_only |
|
共同作業
|
collaborative | boolean |
共同作業 |
|
価値
|
value | string | |
|
選択済みです
|
checked | boolean |
選択済みです |
|
高さ
|
height | integer | |
|
幅
|
width | integer | |
|
options
|
options | ||
|
font_size
|
font_size | integer | |
|
font_type
|
font_type | string | |
|
date_format
|
date_format | string | |
|
created
|
created | string |
取引先企業を取得する
すべてのアカウントのリスト
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string | |
|
件名
|
name | string |
件名 |
|
メール
|
string |
メール |
|
|
number
|
number | string | |
|
タイムゾーン
|
timezone | string | |
|
role
|
role | string | |
|
active
|
active | boolean | |
|
group_id
|
group_id | string | |
|
created
|
created | string | |
|
検証済み
|
verified | string |
受信者を取得する
エンベロープの作成レスポンス本文で返されたidプロパティを使用して、エンベロープ用に作成された単一の受信者を取得します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Recipient
|
id | True | string |
受信者の ID |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Id
|
id | string |
Id |
|
名称
|
name | string |
件名 |
|
メールアドレス
|
string |
メール |
|
|
携帯電話
|
mobile | string |
Mobile |
|
タイプ
|
type | string |
タイプ |
|
ステータス
|
status | string |
Status |
|
message
|
message | string |
Message |
|
Password
|
password |
Password |
|
|
ミュート
|
muted | boolean |
ミュート |
|
注文
|
order | integer | |
|
declined_reason
|
declined_reason | string |
Declined_reason |
|
created
|
created | string |
Created |
|
送信数
|
sent | string |
送信数 |
|
拒否済み
|
declined | string |
辞退 |
|
completed
|
completed | string |
Completed |
|
session_completed
|
redirects.session_completed | string |
Session_completed |
|
session_declined
|
redirects.session_declined | string |
Session_declined |
組織を取得する
組織を取得する
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | string |
Id |
|
名称
|
name | string |
件名 |
|
ビジネス
|
business | string |
事業 |
|
メールアドレス
|
string |
メール |
|
|
number
|
number | string |
回数 |
|
address
|
address | string |
番地 |
|
web サイト
|
website | string |
Web サイト |
|
ロゴ
|
logo | string |
Logo |
|
色
|
colour | string |
色 |
|
created
|
created | string |
Created |
トリガー
| イベント トリガー - エンベロープと受信者 |
エンベロープが完了したとき、または受信者が表示されたときにイベントが発生したときにトリガーされます |
イベント トリガー - エンベロープと受信者
定義
WebhookEventContent
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
event
|
event | string | |
|
envelope_id
|
envelope_id | string | |
|
無効化済み
|
voided | string | |
|
completed
|
completed | string | |
|
master
|
master | string | |
|
証明書
|
certificate | string | |
|
送信数
|
sent | string | |
|
方法
|
method | string | |
|
recipient_id
|
recipient_id | string | |
|
viewed
|
viewed | string | |
|
拒否済み
|
declined | string | |
|
declined_reason
|
declined_reason | string | |
|
失敗
|
failed | string | |
|
診断
|
diagnosis | string |