如何将短信身份验证添加到模板角色？答案

【问题标题】：How to add sms Authentication to template roles?如何将短信身份验证添加到模板角色？
【发布时间】：2023-03-09 12:46:01
【问题描述】：

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

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

在进行 API 调用时，这是否不起作用？

【问题讨论】：

标签： docusignapi

【解决方案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”）

【讨论】：

补充答案：我也可以让它在巴西工作，但我必须在签名者对象中添加“roleName”，并将国家代码（在我的情况下为 +55）添加到手机号码.
感谢 jfneis 与社区分享！我已经更新了国际#s 的答案。

【解决方案2】：

国家代码，请如下表，+84是VN，电话号码和国家代码之间留一个空格，我很费时间:(

"senderProvidedNumbers": ["+84 945672509"]

【讨论】：

请务必使用可用的文本格式化工具。