REST API を使用すると、「GET Envelope Recipients」リクエストを実行するだけで、テンプレートの受信者ロール名を取得できます。ここでは、 Envelope Idの代わりにTemplate Idを指定します。例えば:
GET https://demo.docusign.net/restapi/v2/accounts/ {accountId}/envelopes/{templateId}/recipients?include_tabs=false&include_extended=true
このリクエストへの応答には、各受信者タイプ (つまり、署名者、エージェント、編集者、仲介者、carbonCopies、certifiedDeliveries、inPersonSigners) の受信者オブジェクトの配列が含まれます。各受信者オブジェクトには、プロパティroleNameが含まれます。以下は、3 人の受信者 (2 人の署名者と 1 人の CC 受信者) を含むテンプレートの応答の例です。
{
"signers": [
{
"signInEachLocation": "false",
"name": "",
"email": "",
"recipientId": "5741ec70-b056-44eb-b462-eceee88ddf77",
"requireSignerCertificate": "false",
"requireIdLookup": "false",
"routingOrder": "1",
"roleName": "Signer 1",
"status": "created",
"templateLocked": "false",
"templateRequired": "false"
},
{
"signInEachLocation": "false",
"name": "",
"email": "",
"recipientId": "c64d4567-2efd-422d-9b0a-a5427aa2512d",
"requireSignerCertificate": "false",
"requireIdLookup": "false",
"routingOrder": "2",
"roleName": "Signer 2",
"status": "created",
"templateLocked": "false",
"templateRequired": "false"
}
],
"agents": [],
"editors": [],
"intermediaries": [],
"carbonCopies": [
{
"name": "Legal Team",
"email": "email3@outlook.com",
"recipientId": "a63e3714-adc2-4e05-b2c5-b3c3bbf50aa2",
"requireIdLookup": "false",
"routingOrder": "3",
"roleName": "Legal Team",
"status": "created",
"templateLocked": "true",
"templateRequired": "true"
}
],
"certifiedDeliveries": [],
"inPersonSigners": [],
"recipientCount": "3"
}