使用复合模板的 DocuSign API 未提供收件人错误

Question

我正在将一组文档的签名嵌入到 Web 应用程序中。最终，文件将填写在线面试期间提供的答案。信封里需要三四份文件。这些文档是基于服务器的模板。在模板定义中，我将申请人角色（签名者）的姓名和电子邮件字段留空，因为它们是将被许多申请人使用的通用模板。

在测试场景中，我可以在信封中加载单个模板并携带它完成整个过程，但是当我转换为复合模板时，出现错误 "errorCode"："RECIPIENTS_NOT_PROVIDED" , "message": "No recipients were found in the request." 来自信封请求。我已经将代码与许多示例进行了比较，但没有发现任何不同之处。一定有一些基本的东西是我遗漏的——这并不奇怪，因为这是我第一次尝试使用 DocuSign API。有没有人可以赐教一下？

失败代码：

{
    "accountId":"xxxxxxx",
    "emailSubject":"WOTC Certification Documents - Test Dummy",
    "emailBlurb":"Documentation to be submitted by Consultant",
    "status":"sent",
    "compositTemplates":{
        "serverTemplates":[{
            "sequence":"1",
            "templateId":"ca18aba4-49bd-4c28-9dce-fbd2dd3fbb7b",
            "recipients":{
                "signers":{
                    "name":"Test Dummy",
                    "roleName":"Applicant",
                    "recipientId":"1",
                    "clientUserId":"Dummy1234",
                    "email":"dummy@mydomain.com"
                }
            }
        },{
            "sequence":"2",
            "templateId":"5ed3d600-5a57-4fee-931f-53233858dc65",
            "recipients":{
                "signers":{
                    "name":"Test Dummy",
                    "roleName":"Applicant",
                    "clientUserId":"Dummy1234",
                    "email":"dummy@mydomain.com"
                }
            }
        }]
    }
}

谢谢。

Answer 1

您的方向是正确的，但我建议您对发布的 JSON 进行以下更改：

"compositTemplates" 缺少一个 "e" -- 应该是 compositeTemplates
compositeTemplates 需要是一个对象数组
compositeTemplates 数组中的每个对象需要包含一个 serverTemplates 属性（一个指定模板信息的数组）和一个 inlineTemplates 属性（指定收件人信息的数组）
在每个 recipients 对象中，signers 需要是一个对象数组
每个 signer 对象需要一个 recipientId 属性

这又是你的 JSON，经过修改以实现我在上面列出的更改：

{
    "accountId":"xxxxxxx",
    "emailSubject":"WOTC Certification Documents - Test Dummy",
    "emailBlurb":"Documentation to be submitted by Consultant",
    "status":"sent",
    "compositeTemplates":[
    {
        "serverTemplates":[
        {
            "sequence":"1",
            "templateId":"ca18aba4-49bd-4c28-9dce-fbd2dd3fbb7b"
        }],
        "inlineTemplates":[
        {
            "sequence" : 2,
            "recipients":{
                "signers":[{
                    "name":"Test Dummy",
                    "roleName":"Applicant",
                    "recipientId":"1",
                    "clientUserId":"Dummy1234",
                    "email":"dummy@mydomain.com"
                }]
            }
        }],
    },
    {
        "serverTemplates":[
        {
            "sequence" : 3,
            "templateId":"5ed3d600-5a57-4fee-931f-53233858dc65"
        }],
        "inlineTemplates":[
        {
            "sequence" : 4,
            "recipients": {
                "signers" : [{
                    "name":"Test Dummy",
                    "roleName":"Applicant",
                    "recipientId": "1",
                    "clientUserId":"Dummy1234",
                    "email":"dummy@mydomain.com"
                }]
            }
        }]
    }]
}

使用复合模板的 DocuSign API 未提供收件人错误

Recipients Not Provided error from DocuSign API using composite template

docusignapi

docusigncompositetmplts