DocuSign 如何指定 Envelope Connect 的消息格式？答案

【问题标题】：How does DocuSign specify the message format for Envelope Connect?DocuSign 如何指定 Envelope Connect 的消息格式？
【发布时间】：2023-02-04 06:44:17
【问题描述】：

我们正在探索使用 Envelope Connect 接收我们通过 DocuSign API 创建的信封的状态更新。我们希望消息以 JSON 格式发送给我们，但似乎无论我们提供什么，消息都以 XML 格式发送。

下面是我们的信封中包含的 eventNotification 示例：

{
"envelopeEvents": [
    {
        "envelopeEventStatusCode": "Completed",
        "includeDocuments": false
    },
    {
        "envelopeEventStatusCode": "Declined",
        "includeDocuments": false
    },
    {
        "envelopeEventStatusCode": "Voided",
        "includeDocuments": false
    }
],
"eventData": {
    "format": "json",
    "includeData": [
        "custom_fields"
    ],
    "version": "restv2.1"
},
"loggingEnabled": true,
"recipientEvents": [
    {
        "includeDocuments": false,
        "recipientEventStatusCode": "Completed"
    }
],
"requireAcknowledgment": true,
"url": "https://webhook.site/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

DocuSign Developer API Reference 说在使用 JSON SIM 事件模型时使用 eventNotification 对象的“events”属性，但是当我们使用它而不是 envelopeEvents 或 recipientEvents 时，我们不会收到任何状态更新。

我遵循了这个 youtube 视频中的消息格式，它显示返回的消息是 JSON，但是当我这样做时，我们得到的是 XML。 https://www.youtube.com/watch?v=bcTaBKf_c50

DocuSign 管理中心的连接日志证实了这一点： Connect log

我们帐户中是否存在某些配置阻止消息格式为 JSON？

我们确实有一些帐户级别的连接配置，这些会干扰吗？

【问题讨论】：

标签： docusignapi docusignconnect

【解决方案1】：

是的，您必须在“设置”页面（DocuSign 管理）中执行此操作，然后转到“连接”部分并配置帐户范围的连接配置。

在那里，您可以选择要使用的格式，如下所示：

通过选择 REST v2.1，您将获得 JSON 而不是 XML。

【讨论】：

我们正在尝试使用信封连接，而不是帐户范围的连接配置。我还尝试从我们的帐户中删除所有帐户范围的连接配置，并且在我们的帐户中也有一个 REST v2.1 连接配置；数据仍以 XML 格式返回。
"version": "restv2.1" 应该可以解决问题，如果它不起作用，您需要联系支持人员，因为我不知道您的帐户有什么问题

【解决方案2】：

DocuSign 支持人员能够识别问题。

我们的 API 调用通过 REST API 的 /v2/ 进行： https://demo.docusign.net/restapi/v2/

但 JSON 状态更新仅通过 v2.1 发送。 https://demo.docusign.net/restapi/v2.1/

【讨论】：