Docusign - エンベロープ受信者の取得アクション ​

このページは機械翻訳により提供されています。翻訳内容と英語版に相違がある場合は、英語版が優先されます。

エンベロープ受信者の取得アクションは、指定したエンベロープについて、署名者、カーボンコピー受信者などを含む、Docusign内の受信者のリストを取得します。詳細については、Docusign EnvelopeRecipients: list APIリファレンスを参照してください。

入力 ​

入力フィールド説明
エンベロープIDDocusign エンベロープのIDを入力します。
タブを含める有効にすると、レスポンスに各受信者のタブデータを含めます。各タブに含まれるフィールドについては、Tab fields を参照してください。
拡張情報を含める有効にすると、レスポンスに拡張された受信者プロパティが含まれます。詳細については、Additional recipient output を参照してください。
メタデータを含める有効にすると、レスポンスに各受信者のメタデータが含まれます。詳細については、Additional recipient output を参照してください。

出力 ​

Docusignは受信者を受信者タイプ別にグループ化します。各タイプには共通のフィールドセットに加え、タイプ固有のフィールドがあります。各受信者タイプの完全なフィールドリファレンスについては、DocusignのEnvelopeRecipientsリソースドキュメントを参照してください。

出力フィールド説明
現在のルーティング順序現在の受信者のルーティング順序値です。エンベロープがこの受信者に送信されたものの、受信者がまだアクションを完了していないことを示します。
受信者数エンベロープ上の受信者の数。
署名者ドキュメントに署名、イニシャルの記入、日付の入力、または情報の追加を行う必要がある受信者のリスト。
対面署名者署名者と同じ物理的な場所で、Docusignユーザーが署名ホストとして機能する対面署名を行う受信者のリスト。
証人別の受信者の署名に立ち会う受信者のリスト。
カーボンコピーエンベロープのコピーを受信するものの、ドキュメントに署名、イニシャルの記入、日付の入力、または情報の追加を行う必要がない受信者のリスト。
認証配信エンベロープを完了するために完了済みドキュメントを受信する必要があるものの、ドキュメントに署名、イニシャルの記入、日付の入力、または情報の追加を行う必要がない受信者のリスト。
エージェントルーティング順序の後の段階に表示される受信者の名前とメール情報を追加できる受信者のリスト。
エディター送信者と同じ管理権限およびアクセス権を持ち、残りの受信者のエンベロープ、受信者、タブを編集できる受信者のリスト。
仲介者ルーティング順序の同じ段階または後の段階にある受信者の名前とメール情報を任意で追加できる受信者のリスト。
シール電子シール受信者のリスト。電子シールは、個人ではなく組織または政府機関を表します。
公証人Docusign eNotaryを使用して別の受信者の署名を公証する受信者のリスト。
公証人証人封筒内の公証人証人受信者の一覧。各受信者には、Witnesses と同じフィールドが含まれ、Witness for も含まれます。
検証用署名者封筒内の検証用署名者受信者の一覧。各受信者には、Signers と同じフィールドが含まれます。
検証者封筒内の検証者受信者の一覧。各受信者には、Signers と同じフィールドが含まれます。

受信者フィールド ​

前述の配列内の各受信者はオブジェクトであり、Recipient ID、Recipient type、Status、Routing order など共通のフィールドセットを共有します。これらは、Get envelope アクションの Recipient fields で説明されているものと同じフィールドです。 Tabs フィールドと Total tab count フィールドは、Include tabs を有効にした場合にのみ利用できます。各受信者のタブは、Tab fields と同じ構造を使用します。情報提供用の受信者タイプ(Carbon copies、Certified deliveries、Agents、Editors、Intermediaries、Seals、Notaries)は、これらのフィールドのサブセットを返します。

タイプ固有のフィールド ​

一部の受信者タイプには、共通セット以外のフィールドが含まれます。 In person signersは、共通のEmailフィールドおよびNameフィールドの代わりに、以下のホストフィールドおよび署名者フィールドを使用します。

出力フィールド説明
一括受信者である(署名者)受信者が一括送信の一部であるかどうかを示します。
受信者がタブを指定(署名者)受信者が自分のタブを提供するかどうかを示します。
署名のアップロードを要求(署名者)受信者が署名をアップロードする必要があるかどうかを示します。
ホストのメール(対面署名者)対面署名セッションをホストするDocusignユーザーのメールアドレス。
ホスト名(対面署名者)対面署名セッションをホストするDocusignユーザーの名前。
署名者のメール(対面署名者)対面署名者のメールアドレス。
署名者名(対面署名者)対面署名者の名前。
Witness for(Witnesses、Notary witnesses)証人が立ち会う対象の受信者の受信者ID。
Witness for GUID(Witnesses、Notary witnesses)証人が立ち会う対象の受信者のグローバル一意識別子(GUID)。

追加の受信者出力 ​

有効にした各オプションによって、各受信者にフィールドが追加されます。出力には、有効にしたオプションに対応するフィールドのみが含まれます。

入力フィールド追加される出力フィールド説明
タブを含めるTabs、Total tab count受信者に割り当てられているタブと、そのタブ数。
拡張情報を含めるメール通知受信者向けのカスタムメール設定。 Email subject、Email body、Supported language を含みます。
拡張情報を含める本人確認受信者に適用される本人確認ワークフロー。 Workflow ID と Workflow label を含みます。
拡張情報を含める電話認証受信者に対する電話認証設定。 Recip may provide number と Sender provided numbers を含みます。
拡張情報を含めるSms認証受信者がSMS認証に使用できる電話番号。 Sender provided numbers を含みます。
拡張情報を含めるその他の受信者プロパティAccess code、Declined reason、Declined date time、Fax number、ID check configuration name、Suppress emails、Sign in each location、Agent can edit email、Agent can edit name、Signing group ID フィールド。
メタデータを含める各受信者フィールドのメタデータフィールドを編集できるかどうかを示します。各メタデータオブジェクトには Rights が含まれ、対象のフィールドの横に表示されます。例えば、Email metadata は Email の横に表示されます。 Workflow ID metadata や Sender provided numbers metadata など、前の行にあるフィールドに適用されます。

各フィールドは、受信者に対応する値がある場合にのみ表示されます。

最終更新日: