如何向模板角色添加短信验证?
How to add sms Authentication to template roles?
使用 DocuSign Rest API 我正在从一个模板创建一个信封,该模板具有一个必须签名的收件人角色。在为该收件人角色创建模板时,我启用了身份检查 -> SMS Auth $。当我尝试从 DocuSign 门户发送信封时,它工作正常。但是,当我尝试使用 API 调用发送它时,我收到一条错误消息:RECIPIENT_SMS_AUTH_PHONE_MISSING:SMS 身份验证 phone 号码不能为空。
请求正文包含内部模板角色:
"SmsAuthentication":{
"senderProvidedNumbers":["recipient_number"] },
"IdCheckConfigurationName":"SMS Auth $",
"RequireIdLookup":true
在进行 API 调用时,这是否不起作用?
出于某种原因,我只能通过使用 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"
]
}
}]
}
}]
}]
}
我只用 U.S 测试过。号码,所以不确定国际号码格式,但我包含的上述格式适用于 U.S。以区号开头的号码。
更新
要使其与国际号码一起使用,请将 roleName
属性 添加到签名者对象中,并添加您的国家/地区代码(即在本例中为巴西的“+55”)
国家代码,请按下面的表格设置,+84是VN,phone数字和国家代码之间留一个space,这会花费我很多时间:(
"senderProvidedNumbers": ["+84 945672509"]
使用 DocuSign Rest API 我正在从一个模板创建一个信封,该模板具有一个必须签名的收件人角色。在为该收件人角色创建模板时,我启用了身份检查 -> SMS Auth $。当我尝试从 DocuSign 门户发送信封时,它工作正常。但是,当我尝试使用 API 调用发送它时,我收到一条错误消息:RECIPIENT_SMS_AUTH_PHONE_MISSING:SMS 身份验证 phone 号码不能为空。 请求正文包含内部模板角色:
"SmsAuthentication":{
"senderProvidedNumbers":["recipient_number"] },
"IdCheckConfigurationName":"SMS Auth $",
"RequireIdLookup":true
在进行 API 调用时,这是否不起作用?
出于某种原因,我只能通过使用 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"
]
}
}]
}
}]
}]
}
我只用 U.S 测试过。号码,所以不确定国际号码格式,但我包含的上述格式适用于 U.S。以区号开头的号码。
更新
要使其与国际号码一起使用,请将 roleName
属性 添加到签名者对象中,并添加您的国家/地区代码(即在本例中为巴西的“+55”)
国家代码,请按下面的表格设置,+84是VN,phone数字和国家代码之间留一个space,这会花费我很多时间:(
"senderProvidedNumbers": ["+84 945672509"]