Поскольку Larry упомянул, что мы не отправляем roleName в ответе Подключения, но существует различное обходное решение для выполнения этого при использовании API для отправки конверта. При создании конверта можно передать Уровень Получателя Пользовательские Поля в вызове создания конверта на этом Уровне Получателя Пользовательское Поле, можно передать roleName как Строку. В Ответе Подключения Вы получите это Пользовательское Поле для каждого получателя, это может использоваться для интерпретации roleName, который использовался для создания конверта.
, Если часть получателя вызова API похожа ниже, где Signer1
roleName, который Вы использовали, но передали его как уровень получателя пользовательское поле:
"recipients": {
"signers": [
{
"email": "docusign.sso+internal22@gmail.com",
"name": "John Doe",
"recipientId": "1",
"roleName": "Signer1",
"routingOrder": "1",
"customFields":[
"Signer1"
]
}
]
}
тогда Ответ Подключения будет похож:
<RecipientStatus>
<Type>Signer</Type>
<Email>johndoeemail@gmail.com</Email>
<UserName>John Doe</UserName>
<RoutingOrder>1</RoutingOrder>
<Sent>2019-03-07T12:14:48.38</Sent>
<Status>Sent</Status>
<CustomFields>
<CustomField>Signer1</CustomField>
</CustomFields>
</RecipientStatus>
Полезная нагрузка события Connect не имеет имени роли в качестве опции.
Но вы можете вызвать API-метод EnvelopeRecipients :: list с envelopeId из полезной нагрузки события.
Вы получите обратно данные для всех получателей конверта, включая их роль. Пример ответа:
{
agents: [],
carbonCopies: [
{
email: "larry@example.com",
name: "Larry Kluger",
note: "",
recipientId: "2",
recipientIdGuid: "a31eaf15-48bb-4a40-a8a7-cf28325f1d78",
requireIdLookup: "false",
roleName: "cc", // <<===
routingOrder: "2",
status: "created",
userId: "00db048f-1dbc-489f-935a-c2d7bc178ca1"
}
],
certifiedDeliveries: [],
currentRoutingOrder: "1",
editors: [],
inPersonSigners: [],
intermediaries: [],
recipientCount: "2",
seals: [],
signers: [
{
creationReason: "sender",
deliveryMethod: "email",
email: "Pat.Edwards@example.com",
isBulkRecipient: "false",
name: "Pat Edwards",
note: "",
recipientId: "1",
recipientIdGuid: "f21e3531-277a-4ee1-912b-1d359d342fa7",
requireIdLookup: "false",
roleName: "signer", // <<===
routingOrder: "1",
status: "sent",
userId: "69e573ac-d2e2-41d0-9ad3-b5e64317942f"
}
]
}