docusignapi - 如何向模板角色添加短信验证？

Question

我正在使用 DocuSign Rest API 从模板创建一个信封，该模板具有一个必须签名的收件人角色。在为该收件人角色创建模板时，我启用了身份检查 -> SMS Auth $。当我尝试从 DocuSign 门户发送信封时，它工作正常。但是，当我尝试使用 API 调用发送它时，我收到一条错误消息:RECIPIENT_SMS_AUTH_PHONE_MISSING:SMS 身份验证电话号码不能为空。请求正文包含内部模板角色:

"SmsAuthentication":{
"senderProvidedNumbers":["recipient_number"] },
"IdCheckConfigurationName":"SMS Auth $",
"RequireIdLookup":true

在进行 API 调用时，是否有任何原因导致它不起作用？

Answer 1

出于某种原因，我只能通过使用 compositeTemplates 请求属性来让它工作(即我无法让它与一个简单的模板一起工作)。请注意，您需要在您正在测试的帐户中启用 SMS 身份验证，如果您正在使用开发人员沙盒帐户进行测试，则应该启用它，如果您正在生产中，您可以联系您的客户经理。

为了让它工作，我使用了以下使用复合模板的 JSON:

{
    "status": "sent",
    "emailSubject": "Please sign this for me",
    "compositeTemplates": [{
        "serverTemplates": [{
            "sequence": "1",
            "templateId": "[TEMPLATE_ID]"
        }],
        "inlineTemplates": [{
            "sequence": "1",
            "recipients": {
                "signers": [{
                    "name": "[SIGNER_NAME]",                
                    "email": "[SIGNER_EMAIL]",              
                    "routingOrder": "1",
                    "requireIdLookup": true,
                    "recipientId": "1",
                    "idCheckConfigurationName": "SMS Auth $",
                    "smsAuthentication": {
                        "senderProvidedNumbers": [
                            "1234567890"
                        ]
                    }
                }]
            }
        }]
    }]
}

我只测试了美国号码，因此不确定国际号码格式，但我提供的上述格式适用于以区号开头的美国号码。

---

更新

要让它与国际号码一起使用，请将 roleName 属性添加到 signers 对象，并添加您的国家/地区代码(即在本例中为巴西的“+55”)