问:使用REST API创建和发送带有模板的信封

时间:2019-11-20 16:30:12

标签: docusignapi

我正在尝试将新的见证功能添加到我的API调用中。这是我现在发送的json:

POST https://demo.docusign.net/restapi/v2/accounts/[my id]/envelopes

{
"emailSubject":"test",
"status":"sent",
"templateId":"[Valid template id]",
"templateRoles":[
{
  "roleName":"sign1",
  "email":"valid@email.com",
  "name":"John",
  "recipientId":"1",
  "routingOrder":"1",
  "tabs":{}
},
{
  "roleName":"Witness for sign1",
  "witnessFor":"sign1",
  "witnessForGuid":"1",
  "recipientId":"2",
  "routingOrder":"2",
  "recipientType":"witness"
}
]
}

我已经在DocuSign中配置了模板,并通过DocuSign网站发送了信封来验证了功能。但是,从我的API调用创建的信封不会触发见证程序功能。我不确定自己缺少什么,非常感谢您的帮助/反馈。

欢呼

2 个答案:

答案 0 :(得分:0)

这是一个成功的Envelopes :: create调用,其中包含witness收件人类型:

"recipients": {
  "witnesses": [
    {
      "name": "Witness Name",
      "email": "witness@example.com",
      "recipientId": "2",
      "witnessFor": "1"
    }
  ],
  "signers": [
    {
      "email": "someone@example.com",
      "name": "Signer name",
      "recipientId": "1",
      "clientUserId": "1000",
      "tabs": {
        "signHereTabs": [
          {
            "anchorString": "/sig1/",
            "anchorXOffset": "20",
            "anchorUnits": "pixels"
          }
        ]
      }
    }
  ]
},

templateRoles属性中的建议更改:

(未经测试)

我假设您在模板中设置了见证人角色。 如果您不这样做,那么我认为您需要通过复合模板将额外的witness收件人添加到信封中。

您还可以尝试添加"recipientType":"witness"

在API级别,见证人是信封的唯一收件人。 DocuSign Web工具也可能为见证人创建隐藏的收件人(和收件人角色)。要确定是否是这种情况,请使用API logging来查看DocuSign网络工具的实际作用。

"templateRoles":[
{
  "roleName":"sign1",
  "email":"valid@email.com",
  "name":"John",
  "recipientId":"1",
  "routingOrder":"1",
  "tabs":{}
},
{
  "roleName":"Witness for sign1",
  "witnessFor":"1",
  OMIT THIS: "witnessForGuid":"1",
  "recipientId":"2",
  OMIT THIS: "routingOrder":"2",
  OMIT THIS: "recipientType":"witness"
}
]

注意

较旧的开发人员沙箱帐户不包括见证功能。如果您收到没有见证人功能的错误消息,请联系go-live-at-- docusign.com,以将该功能添加到您的开发人员帐户中。

答案 1 :(得分:0)

原来是DocuSign中的一个错误,我不得不将创建步骤分为2个。

第一个POST /信封:

{
  "emailSubject":"Template Action Test",
  "status":"created",
  "templateId":"866fcb03-1342-4678-9dc3-107772c59e89",
  "templateRoles":[
    {"roleName":"sign1","email":"email@test.com","name":"JK","tabs":{}}
]
}

第二个PUT /信封/信封ID:

{
"status":"sent"
}