Docusign - エンベロープ受信者の取得アクション
Get envelope recipientsアクションは、署名者、カーボンコピー受信者など、指定したエンベロープの受信者リストを取得します。 詳細については、Docusign EnvelopeRecipients: list APIリファレンスを参照してください。
入力
| 入力フィールド | 説明 |
|---|---|
| エンベロープID | Docusign エンベロープのIDを入力します。 |
| タブを含める | 有効にすると、レスポンスに各受信者のタブデータが含まれます。 |
出力
Docusignは受信者を受信者タイプ別にグループ化します。各タイプには共通のフィールドセットに加え、タイプ固有のフィールドがあります。 各受信者タイプの完全なフィールドリファレンスについては、EnvelopeRecipientsリソースを参照してください。
| 出力フィールド | 説明 |
|---|---|
| 現在のルーティング順序 | 現在の受信者のルーティング順序値です。エンベロープがこの受信者に送信されたものの、受信者がまだアクションを完了していないことを示します。 |
| 受信者数 | エンベロープ上の受信者の数。 |
| 署名者 | ドキュメントに署名、イニシャルの記入、日付の入力、または情報の追加を行う必要がある受信者のリスト。 |
| 対面署名者 | 署名者と同じ物理的な場所で、Docusignユーザーが署名ホストとして機能する対面署名を行う受信者のリスト。 |
| 証人 | 別の受信者の署名に立ち会う受信者のリスト。 |
| カーボンコピー | エンベロープのコピーを受信するものの、ドキュメントに署名、イニシャルの記入、日付の入力、または情報の追加を行う必要がない受信者のリスト。 |
| 認証配信 | エンベロープを完了するために完了済みドキュメントを受信する必要があるものの、ドキュメントに署名、イニシャルの記入、日付の入力、または情報の追加を行う必要がない受信者のリスト。 |
| エージェント | ルーティング順序の後の段階に表示される受信者の名前とメール情報を追加できる受信者のリスト。 |
| エディター | 送信者と同じ管理権限およびアクセス権を持ち、残りの受信者のエンベロープ、受信者、タブを編集できる受信者のリスト。 |
| 仲介者 | ルーティング順序の同じ段階または後の段階にある受信者の名前とメール情報を任意で追加できる受信者のリスト。 |
| シール | 電子シール受信者のリスト。 電子シールは、個人ではなく組織または政府機関を表します。 |
| 公証人 | Docusign eNotaryを使用して別の受信者の署名を公証する受信者のリスト。 |
受信者フィールド
上記の配列内の各受信者は、Recipient ID、Recipient type、Status、Routing order、Tabsなどの共通フィールドセットを共有するオブジェクトです。 これらは、Get envelopeアクションの受信者フィールドで説明されているものと同じフィールドです。また、各受信者のタブはタブフィールドと同じ構造を使用します。 情報提供用の受信者タイプ（Carbon copies、Certified deliveries、Agents、Editors、Intermediaries、Seals、Notaries）は、これらのフィールドのサブセットを返します。
タイプ固有のフィールド
一部の受信者タイプには、共通セット以外のフィールドが含まれます。 In person signersは、共通のEmailフィールドおよびNameフィールドの代わりに、以下のホストフィールドおよび署名者フィールドを使用します。
| 出力フィールド | 説明 |
|---|---|
| 一括受信者である（署名者） | 受信者が一括送信の一部であるかどうかを示します。 |
| 受信者がタブを指定（署名者） | 受信者が自分のタブを提供するかどうかを示します。 |
| 署名のアップロードを要求（署名者） | 受信者が署名をアップロードする必要があるかどうかを示します。 |
| ホストのメール（対面署名者） | 対面署名セッションをホストするDocusignユーザーのメールアドレス。 |
| ホスト名（対面署名者） | 対面署名セッションをホストするDocusignユーザーの名前。 |
| 署名者のメール（対面署名者） | 対面署名者のメールアドレス。 |
| 署名者名（対面署名者） | 対面署名者の名前。 |
| 証人対象（証人） | 証人が立ち会う対象の受信者の受信者ID。 |
| 証人対象GUID（証人） | 証人が立ち会う対象の受信者のグローバル一意識別子（GUID）。 |
最終更新日: