如何将短信验证添加到模板角色？

Question

使用 DocuSign Rest API，我正在从一个模板创建一个信封，该模板具有一个必须签名的收件人角色。在为该收件人角色创建模板时，我启用了 Identity Check -> 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属性添加到签名者对象并添加您的国家/地区代码（即“+55”在这种情况下为巴西）