如何将sms身份验证添加到模板角色?

时间:2016-01-12 17:18:41

标签: docusignapi

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

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

在进行API调用时,有什么理由不起作用吗?

2 个答案:

答案 0 :(得分:3)

出于某种原因,我只能通过使用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属性添加到签名者对象,并添加您的国家/地区代码(例如&#34; + 55&#34;在这种情况下为巴西)

答案 1 :(得分:0)

对于国家代码,请设置如下表格,+84是VN,电话号码和国家代码之间留一个空格,我要花很多时间:(

"senderProvidedNumbers": ["+84 945672509"]