跳到主要内容

自定义短信服务商配置指南

功能概述​

云开发身份认证支持手机号短信验证码登录方式。使用短信验证码登录前，需要接入短信服务商来发送验证码短信。

支持接入腾讯云短信服务商（TENCENT_CN 国内、TENCENT_INTL 国际/港澳台），也可以通过云函数接入其他短信服务商。

配置完成后，用户在注册/登录时触发的验证码短信，将通过您配置的短信服务商发出，您可自主控制签名、模板及每日发送上限。

前提条件​

在调用配置接口前，您需要在腾讯云完成以下准备工作：

第一步：开通腾讯云短信服务​

  1. 登录 腾讯云短信控制台，同意服务协议后开通短信服务。
  2. 进入应用管理 > 应用列表，点击创建应用，填写应用名称，创建完成后记录 SdkAppId。
提示

如果短信服务与云开发环境使用同一腾讯云账号，可通过 CAM 授权方式接入，无需提供 SecretId 和 SecretKey。

如果使用跨账号的短信服务，需前往 API 密钥管理，创建或查看 SecretId 和 SecretKey。

注意

SecretKey 属于敏感凭证，请妥善保管，避免泄露。

第二步：申请短信签名​

短信签名将显示在发送给用户的短信开头，例如【腾讯云】。请前往腾讯云短信控制台申请短信签名，审核通过后记录签名内容备用。

第三步：申请短信模板​

短信模板定义了验证码短信的正文内容，变量部分使用占位符 {1}、{2} 表示。请前往腾讯云短信控制台申请短信模板，审核通过后记录**模板 ID（TemplateId）**备用。

短信模板示例：

您的验证码为：{1}，{2} 分钟内有效，请勿泄露给他人。

模板申请及审核标准请参考：短信正文模板审核标准

完成准备后，您应已获取以下信息​

参数说明获取路径
SdkAppId短信应用 ID短信控制台 > 应用管理
SecretIdAPI 密钥 ID（跨账号场景需要）API 密钥管理
SecretKeyAPI 密钥（跨账号场景需要）API 密钥管理
SignName短信签名内容短信控制台 > 签名管理（审核通过后）
TemplateId短信模板 ID短信控制台 > 正文模板管理（审核通过后）

API 接口说明​

接口信息​

项目说明
接口名称ModifyLoginConfig（修改登录策略）
请求域名tcb.tencentcloudapi.com
API 版本2018-06-08
HTTP 方法POST
频率限制20 次/秒
提示

接口文档：ModifyLoginConfig - 修改登录策略

输入参数​

顶层参数​

参数名类型是否必填说明
EnvIdString是云开发环境 ID
PhoneNumberLoginBoolean是手机号短信登录开关
EmailLoginBoolean是邮箱登录开关
UserNameLoginBoolean是用户名密码登录开关
AnonymousLoginBoolean是匿名登录开关
SmsVerificationConfigObject否短信验证码发送通道配置，见下方详细说明

SmsVerificationConfig（短信通道配置）​

参数名类型是否必填说明
TypeString否短信发送通道类型。template：使用自定义短信服务商模板（腾讯云短信使用此值）
SmsDayLimitInteger否单个手机号每日发送上限，默认 30 次，-1 表示不限制
TemplateProviderObjectType 为 template 时必填服务商短信模板配置，见下方 SMSProviderTemplateConfig 说明

SMSProviderTemplateConfig（服务商模板配置）​

参数名类型是否必填说明
VendorString是短信服务商。TENCENT_CN：腾讯云短信（国内）；TENCENT_INTL：腾讯云短信（国际/港澳台）
TemplateIdString是短信模板 ID（审核通过的模板）
SdkAppIdString否腾讯云短信应用 ID
SignNameString否短信签名内容（审核通过的签名）
SecretIdString否腾讯云 API 密钥 ID（跨账号场景需要，同账号可使用 CAM 授权）
SecretKeyString否腾讯云 API 密钥（跨账号场景需要，同账号可使用 CAM 授权）
SenderIdString否发送方 ID，国际短信部分场景需填写
TemplateExtendParamArray of Object否模板自定义扩展参数，见下方 SMSTemplateParams 说明

SMSTemplateParams（模板扩展参数）​

参数名类型说明
KeyString参数键（使用命名占位符时填写）
ValueString参数值

请求示例​

配置腾讯云国内短信（TENCENT_CN）​

{
  "EnvId": "your-env-id",
  "PhoneNumberLogin": true,
  "EmailLogin": false,
  "UserNameLogin": false,
  "AnonymousLogin": false,
  "SmsVerificationConfig": {
    "Type": "template",
    "SmsDayLimit": 100,
    "TemplateProvider": {
      "Vendor": "TENCENT_CN",
      "SdkAppId": "1400000000",
      "SecretId": "AKIDxxxxxxxx",
      "SecretKey": "xxxxxxxxxxxxxxxx",
      "SignName": "云开发",
      "TemplateId": "123456"
    }
  }
}

配置腾讯云国际/港澳台短信（TENCENT_INTL）​

{
  "EnvId": "your-env-id",
  "PhoneNumberLogin": true,
  "EmailLogin": false,
  "UserNameLogin": false,
  "AnonymousLogin": false,
  "SmsVerificationConfig": {
    "Type": "template",
    "SmsDayLimit": 100,
    "TemplateProvider": {
      "Vendor": "TENCENT_INTL",
      "SdkAppId": "1400000000",
      "SecretId": "AKIDxxxxxxxx",
      "SecretKey": "xxxxxxxxxxxxxxxx",
      "SignName": "CloudBase",
      "TemplateId": "789012"
    }
  }
}

输出参数​

参数名类型说明
RequestIdString唯一请求 ID，用于问题定位

响应示例​

{
  "Response": {
    "RequestId": "70b8908d-5c99-4a20-be23-f84aff0bfd37"
  }
}

注意事项​

  1. 签名和模板需提前审核通过：调用接口前，请确保腾讯云短信的签名和模板均已通过审核，否则短信发送将失败。

  2. 国内与国际场景分开配置：国内短信和国际/港澳台短信的 SignName、TemplateId 分别管理，请根据您的用户群体选择对应的配置。

  3. SmsDayLimit 合理设置：建议根据业务量设置每日上限，防止异常刷量，同时避免设置过低影响正常用户登录。

  4. SecretKey 安全存储：请勿将 SecretKey 硬编码在前端代码中，建议通过后端服务调用接口。

  5. 配置即时生效：接口调用成功后，配置立即生效，所有使用该云开发环境的用户登录时均将使用新的短信通道。

参考链接​