有没有办法在连接事件中包含模板角色名称

Question

对于DocuSign，我们有一个集成的帐户，我们使用连接事件将有关信封的信息存储在数据库中，然后存储到我们的报告存储库中。对于我们发送的每个信封，我们都会应用一个匹配的模板。有没有办法将模板角色名称包含在推送给我们的连接事件中？

Answer 1

Connect 事件有效负载没有角色名称作为选项。

但是，您可以使用事件有效负载中的 envelopeId 调用 EnvelopeRecipients：：list API 方法。

您将收到所有信封收件人的回馈数据，包括其角色名称。示例响应：

{
   agents: [],
   carbonCopies: [
      {
         email: "[e-mail]",
         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: "[e-mail]",
         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"
      }
   ]
}

Answer 2

正如 Larry 提到的，我们不会在连接响应中发送 roleName，但如果使用 API 发送信封，则有一个差异解决方法可以完成此操作。创建信封时，您可以在信封创建调用中传递收件人级别自定义字段，在此收件人级别自定义字段中，您可以将角色名称作为字符串传递。在连接响应中，您将收到每个收件人的此自定义字段，这可用于解释用于创建信封的角色名称。

如果 API 调用的收件人部分如下所示，其中Signer1是您使用但将其作为收件人级别自定义字段传递的角色名称：

"recipients": {
                  "signers": [
                     {
                        "email": "[e-mail]",
                        "name": "John Doe",
                        "recipientId": "1",
                        "roleName": "Signer1",
                        "routingOrder": "1",
                        "customFields":[
                            "Signer1"
                        ]
                     }
                  ]
               }

则连接响应将如下所示：

<RecipientStatus>
        <Type>Signer</Type>
        <Email>[e-mail]</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>