如何向模板角色添加短信身份验证？ [英] How to add sms Authentication to template roles?

问题描述

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

Using the DocuSign Rest API I'm creating an envelope from a template that has one recipient role that has to sign. On the template creation for that recipient role I have enabled Identity Check -> SMS Auth $. It works fine when I try to sent the envelope from DocuSign portal. However when I try to sent it using the API call I get an error saying: RECIPIENT_SMS_AUTH_PHONE_MISSING: SMS authentication phone number cannot be empty. The request body has included inside template roles:

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

进行API调用时，为什么没有任何作用？

Is there any reason why this won't work when making the API call?

推荐答案

由于某些原因，我只能通过使用 compositeTemplates 请求属性来使它起作用（即，我无法仅使用简单的模板就可以使它起作用）。请注意，您需要在用于测试的帐户中启用SMS身份验证，如果要使用开发人员沙箱帐户进行测试，则应启用该功能；如果您正在生产中，则可以与客户经理联系。

For some reason I can only get this to work by using the compositeTemplates request property (i.e. I'm unable to get it to work with just a simple Template). Note that you need to have SMS authentication enabled in the account you are testing with, if you're testing with a developer sandbox account it should be enabled, if you're in production you can reach out to your account manager.

要使其正常工作，我使用了以下使用复合模板的JSON：

To get this to work I used the following JSON that uses a composite template:

{
    "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"
                        ]
                    }
                }]
            }
        }]
    }]
}

我仅使用美国号码进行了测试，因此不确定国际号码格式，但是我所包含的上述格式适用于以区号开头的美国号码。

I only tested with a U.S. number so not sure about the international number formats, but the above format I've included works for U.S. numbers starting with the area code.

更新

到将其与国际号码配合使用，将 roleName 属性添加到签署者对象，并添加您的国家代码（在这种情况下，巴西为 +55）

To get this to work with international numbers add the roleName property to the signers object and also add your country code (ie "+55" in this case for Brazil)

这篇关于如何向模板角色添加短信身份验证？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！