Есть ли способ включить имя роли шаблона в события Connect

Question

Для DocuSign у нас есть интегрированная учетная запись, и мы используем события connect для хранения информации о конверте в БД, а затем в нашем репозитарии отчетов. Для каждого отправляемого нами конверта мы применяем соответствующий шаблон. Есть ли способ добавить имя роли шаблона в события подключения, которые нам отправляют?

Answer 1

Как упомянул Ларри, мы не отправляем roleName в ответе Connect, но для достижения этой цели есть обходной путь, если вы используете API для отправки конверта.При создании конверта вы можете передать пользовательские поля уровня получателя в вызове создания конверта, в этом пользовательском поле уровня получателя вы можете передать roleName в виде строки.В Connect Response вы получите это настраиваемое поле для каждого получателя, его можно использовать для интерпретации roleName, которое использовалось для создания конверта.

Если часть получателя вызова API выглядит ниже, где Signer1 - этоимя-роли, которое вы использовали, но передало его в качестве настраиваемого поля уровня получателя:

"recipients": {
                  "signers": [
                     {
                        "email": "docusign.sso+internal22@gmail.com",
                        "name": "John Doe",
                        "recipientId": "1",
                        "roleName": "Signer1",
                        "routingOrder": "1",
                        "customFields":[
                            "Signer1"
                        ]
                     }
                  ]
               }

, тогда ответ Connect будет выглядеть следующим образом:

<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>

Answer 2

Полезная нагрузка события 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"
      }
   ]
}