Skip to main content

短信服务 REST API 详解

REST API 可以让任何支持发送 HTTP 请求的设备与 LeanCloud 进行交互。使用我们的短信服务 REST API 可以完成很多事情，比如：

  • 给指定手机号码发送短信验证码
  • 验证手机号和短信验证码是否匹配
  • 使用手机号和验证码进行登录
  • 通过合法的手机号和验证码来重置账户密码
  • 进行重要操作（例如支付）的验证确认等

我们支持国内短信和国际短信，并为每个 LeanCloud 账户提供 100 条国内短信的免费额度进行测试，超过的部分将实时从账户余额中扣除，所以请务必保证账户余额充足。具体的价格请参看官网价格。

快速参考​

所有 API 访问都需要使用 HTTPS 协议。在 API 域名下，相对路径前缀 /1.1/ 代表使用版本号为 1.1 的 API。

文档中 API Base URL 为绑定的 API 自定义域名， 可以在「控制台 > 设置 > 应用凭证 > 服务器地址」查看。

如果暂时没有绑定域名，华北、华东节点可以使用临时的测试域名，具体域名见「控制台 > 设置 > 应用凭证 > 服务器地址」。 该域名仅供测试和原型开发阶段使用，不保证可用性，请在正式发布前为应用绑定 API 自定义域名。

LeanCloud 国际版不要求绑定自定义域名。除了使用自定义域名外，也可以使用如下共享域名：

appid前八位.api.lncldglobal.com

请求和响应格式可参考 LeanCloud REST API 文档的 请求格式 和 响应格式。

通常情况下，如果返回的 HTTP 状态码为 200、结果为 {} 则代表请求成功完成。

在短信验证码发送过程中，一共有三方参与：客户端、LeanCloud 和电信运营商（比如移动、联通、电信），发送、验证短信验证码的过程如下图所示：

sequenceDiagram participant 客户端 participant LeanCloud participant 运营商 客户端->>LeanCloud: 1. 请求向特定手机号码发送验证码 LeanCloud->>运营商: 2. 生成验证码，将手机号码、短信内容发送到运营商通道 运营商->>客户端: 3. 下发短信（或语音） 客户端->>LeanCloud: 4. 提交手机号和收到的验证码

我们的短信服务 REST API 包括：

通用验证 API​

URLHTTP 方法功能
/1.1/requestSmsCodePOST请求发送短信验证码
/1.1/verifySmsCode/<code>POST验证短信验证码

用户验证 API​

URLHTTP　方法功能
/1.1/usersByMobilePhonePOST使用手机号码注册或登录
/1.1/requestMobilePhoneVerifyPOST请求发送用户手机号码验证短信
/1.1/verifyMobilePhone/<code>POST使用「验证码」验证用户手机号码
/1.1/requestChangePhoneNumberPOST请求发送手机短信验证码以绑定或更新手机号
/1.1/changePhoneNumberPOST验证手机短信验证码并绑定或更新手机号
/1.1/requestLoginSmsCodePOST请求发送手机号码短信登录验证码
/1.1/requestPasswordResetBySmsCodePOST请求发送手机短信验证码重置用户密码
/1.1/resetPasswordBySmsCode/<code>PUT验证手机短信验证码并重置密码

配置短信服务​

发送短信前，需要进行一些初始化配置，详见 短信 SMS 服务使用指南 > 开通短信服务。

短信验证 API​

在一些场景下，你可能希望用户在验证手机号码后才能进行一些操作，例如充值。这些操作跟账户系统没有关系，可以通过我们提供的的短信验证 API 来实现。

使用这些 API 需要在 控制台 > 短信 > 设置 中开启 启用通用的短信验证码服务（开放 requestSmsCode 和 verifySmsCode 接口） 选项，并且有一个已审核通过的短信签名。

给某个手机号码发送验证短信：

curl -X POST \
  -H "X-LC-Id: {{appid}}" \
  -H "X-LC-Key: {{appkey}}" \
  -H "Content-Type: application/json" \
  -d '{"mobilePhoneNumber": "+86186xxxxxxxx"}' \
  https://API_BASE_URL/1.1/requestSmsCode

这里必须使用 POST 方式来发送请求，请求体里支持的参数有：

参数约束描述
mobilePhoneNumber必填目标手机号码
smsType语言播报（voice）或发送短信（sms），默认为发送短信
ttl验证码有效时间。单位分钟（默认为 10 分钟）
name应用名字（默认为 LeanCloud 控制台填写的应用名。）
op操作类型
template短信模板名称，参见下面的自定义短信模板一节
sign短信签名名称，参见下面的自定义短信模板一节
validate_token参见下面的图形验证码 captcha 一节
other_variable短信模板中的变量，other_variable 仅为举例

如果成功，将返回：

{}

假设有如下调用：

curl -X POST \
  -H "X-LC-Id: {{appid}}" \
  -H "X-LC-Key: {{appkey}}" \
  -H "Content-Type: application/json" \
  -d '{"mobilePhoneNumber": "+86186xxxxxxxx","ttl":"5","name":"天东商城","op":"付款"}' \
  https://API_BASE_URL/1.1/requestSmsCode

接收到的短信内容如下：

您正在使用天东商城服务进行付款操作，您的验证码是：123456，请在5分钟内完成验证。

用户收到验证码后，可以在应用中填写验证码。 然后你可以向 verifySmsCode 发送 POST 请求检查验证码是否正确：

curl -X POST \
  -H "X-LC-Id: {{appid}}" \
  -H "X-LC-Key: {{appkey}}" \
  -H "Content-Type: application/json" \
  -d '{"mobilePhoneNumber":"+86186xxxxxxxx"}' \
  "https://API_BASE_URL/1.1/verifySmsCode/123456"

123456 是手机收到的 6 位数字验证码。

如果成功，将返回：

{}
caution

由于运营商和渠道的限制，短信验证码（也包括语音验证码）向同一手机号码发送要求间隔至少一分钟，并且 24 小时内向同一手机号码发送次数不能超过 10 次，因此建议采用 图形验证码、倒数计时等措施来控制频率并提示用户，防止短信轰炸等恶劣情况发生。

另外，请了解有关短信的 其他限制，以及如何设置 测试手机号和固定验证码。

语音验证码​

语音验证码，是通过电话直接呼叫用户的电话号码来播报验证码。它是一个 6 位的数字组合，语音只播报数字内容，不能添加其他任何内容。它可以作为一种备选方案，来解决因各种原因导致短信无法及时到达的问题。发送方式如下：

curl -X POST \
  -H "X-LC-Id: {{appid}}" \
  -H "X-LC-Key: {{appkey}}" \
  -H "Content-Type: application/json" \
  -d '{"mobilePhoneNumber": "+86186xxxxxxxx", "smsType":"voice"}' \
  https://API_BASE_URL/1.1/requestSmsCode

与上面的普通短信验证码相比，请求发送语音验证码的时候，要加上 smsType 这个请求参数，其值为 voice。

此接口与之前的 验证短信 API 完全兼容，如果你不需要此服务，完全不需要修改之前的发送短信代码。它的 发送限制 与短信验证码相同。

国际短信​

LeanCloud 支持发送国际短信，手机号码格式遵循 E.123 （语音验证码在海外还不可用）。例如向美国的一个手机号码（+17646xxxxx）发送一条短信验证码：

curl -X POST \
  -H "X-LC-Id: {{appid}}" \
  -H "X-LC-Key: {{appkey}}" \
  -H "Content-Type: application/json" \
  -d '{"mobilePhoneNumber": "+17646xxxxx"}' \
  https://API_BASE_URL/1.1/requestSmsCode

如手机号码不带国家码，那么将视作国内手机号（+86）。

要了解短信可送达的所有国家或地区以及费率，请参考官网价格方案。

自定义短信模板​

我们还支持通过 requestSmsCode 发送自定义模板的短信。短信模板可以在 控制台 > 短信 > 签名与模板 里创建。

要使用已创建好的短信模板来发送短信验证，可以通过 template 参数指定模板名称，sign 参数来指定签名名称，并且可以传入变量渲染模板，比如下面例子中的 date：

curl -X POST \
  -H "X-LC-Id: {{appid}}" \
  -H "X-LC-Key: {{appkey}}" \
  -H "Content-Type: application/json" \
  -d '{"mobilePhoneNumber": "+86186xxxxxxxx", "template":"activity","sign":"sign","date":"2014 年 10 月 31 号"}' \
  https://API_BASE_URL/1.1/requestSmsCode

短信模板审核​

模板的创建和修改都需要审核，并且在创建或修改模板之时，短信账户至少有 200 元的非赠送余额。创建后的模板会被自动提交进行审核，审核结果将通过邮件的形式发送到你的账号邮箱。

目前我们仅允许两类自定义短信：

  • 验证类短信
  • 通知类短信

即内容中不允许包含任何下载链接，以及推广营销类信息，否则，模板将无法通过审核。

每个模板都需要经过审核才可以使用（审核在工作时间内通常在 1 个小时内）。模板一经审核，就可以马上使用。后续你可以创建同名模板来替换当前使用的模板，新模板也同样需要审核。审核通过，即可替换旧模板。

用户账户与手机号码验证​

LeanCloud 提供了内建的账户系统，方便开发者快速接入。我们也支持账户系统与手机号码绑定的一系列功能，譬如：

使用手机号码注册或登录​

用户直接输入手机号码来注册账户，如果手机号码已存在则自动登录。POST /usersByMobilePhone 既用于注册也用于登录：

curl -X POST \
  -H "X-LC-Id: {{appid}}" \
  -H "X-LC-Key: {{appkey}}" \
  -H "Content-Type: application/json" \
  -d '{"mobilePhoneNumber":"+86186xxxxxxxx","smsCode":"123456"}' \
  https://API_BASE_URL/1.1/usersByMobilePhone

其中 mobilePhoneNumber 是手机号码，smsCode 是使用 短信验证 API 发送到手机上的 6 位验证码字符串。

注册或者登录成功后，返回的应答与登录接口相似：

{
  "username":     "+86186xxxxxxxx",
  "mobilePhone":  "+86186xxxxxxxx",
  "createdAt":    "2014-11-07T20:58:34.448Z",
  "updatedAt":    "2014-11-07T20:58:34.448Z",
  "objectId":     "51c3ba66e4b0f0e851c1621b",
  "sessionToken": "pnktnjyb996sj4p156gjtp4im",
  "mobilePhoneVerified": true,
  // ... 其他属性
}

如果是第一次注册，将默认设置 mobilePhoneVerified 属性为 true，默认设置用户名为手机号。 如果希望设置其他用户名，可以额外传入 username　参数。

使用手机验证码注册时，并不需要传入密码 password，云端也会默认使用空密码，代表不可以用密码来登录。如果需要在注册的同时设置一个密码，则增加传入 password 参数即可：

curl -X POST \
  -H "X-LC-Id: {{appid}}" \
  -H "X-LC-Key: {{appkey}}" \
  -H "Content-Type: application/json" \
  -d '{"mobilePhoneNumber":"+86186xxxxxxxx","smsCode":"123456", "password": "密码"}' \
  https://API_BASE_URL/1.1/usersByMobilePhone

password 这个参数只在注册时起作用，如果是登录则会被忽略。

手机号码验证​

如上所述，通过手机号码注册新用户时，LeanCloud 会将用户的 mobilePhoneNumberVerified 属性设置为 true。 如果用户是通过其他途径注册的，开发者可以主动要求发送短信验证用户手机：

curl -X POST \
  -H "X-LC-Id: {{appid}}" \
  -H "X-LC-Key: {{appkey}}" \
  -H "Content-Type: application/json" \
  -d '{"mobilePhoneNumber": "+86186xxxxxxxx"}' \
  https://API_BASE_URL/1.1/requestMobilePhoneVerify

如果成功，LeanCloud 将返回状态码 200 OK，并向用户发送验证码。

开发者可以提供一个输入框让用户输入这个验证短信中附带的验证码，之后调用下列 API 来确认验证码的有效性：

curl -X POST \
  -H "X-LC-Id: {{appid}}" \
  -H "X-LC-Key: {{appkey}}" \
  -H "Content-Type: application/json" \
  -d '{"mobilePhoneNumber":"+86186xxxxxxxx"}' \
  https://API_BASE_URL/1.1/verifyMobilePhone/<code>

其中 URL 中最后的 <code> 要替换成 6 位验证数字。

验证成功后，用户的 mobilePhoneNumberVerified 将变为 true，并会触发调用云引擎的 AV.Cloud.onVerified(type, function) 方法，type 被设置为 sms。

成功则返回：

{
  "updatedAt":"2017-03-30T08:20:25.452Z",
  "objectId":"587a0f0661ff4b0065f1dff8"
}

调用 /requestMobilePhoneVerify 接口时，如果相应用户的 mobilePhoneNumberVerified 为 true，那么将不会向相应手机发送验证短信。

以上选项会在用户绑定或修改手机号之后进行验证，如果希望用户绑定或修改手机号之前先通过短信验证，可以使用 requestChangePhoneNumber 和 changePhoneNumber 这两个接口。

requestChangePhoneNumber 接受以下请求参数：

参数说明
mobilePhoneNumber必填 接受手机验证码短信的手机号，同时也是绑定或更新的新手机号
ttl可选 验证码有效时间（默认为 6 分钟）

changePhoneNumber 接受以下请求参数：

参数说明
mobilePhoneNumber必填 绑定或更新的新手机号
code必填 用户手机接收到的短信验证码

绑定手机号或修改手机号时请求发送验证码：

curl -X POST \
  -H "X-LC-Id: {{appid}}" \
  -H "X-LC-Key: {{appkey}}" \
  -H "X-LC-Session: <sessionToken>" \
  -H "Content-Type: application/json" \
  -d '{"mobilePhoneNumber":"+86186xxxxxxxx","ttl":10}' \
  https://API_BASE_URL/1.1/requestChangePhoneNumber

如果成功，将返回：

{}

验证后绑定或更新手机号：

curl -X POST \
  -H "X-LC-Id: {{appid}}" \
  -H "X-LC-Key: {{appkey}}" \
  -H "Content-Type: application/json" \
  -d '{"mobilePhoneNumber":"+86186xxxxxxxx","code":"123456"}' \
  https://API_BASE_URL/1.1/changePhoneNumber

requestChangePhoneNumber 和 changePhoneNumber 的请求参数 mobilePhoneNumber 需保持一致，否则 changePhoneNumber 会报错。

手机号码＋验证码登录​

在验证过手机号码后，用户可以采用短信验证码登录，来避免繁琐的输入密码的过程，请求发送登录验证码：

curl -X POST \
  -H "X-LC-Id: {{appid}}" \
  -H "X-LC-Key: {{appkey}}" \
  -H "Content-Type: application/json" \
  -d '{"mobilePhoneNumber": "+86186xxxxxxxx"}' \
  https://API_BASE_URL/1.1/requestLoginSmsCode

如果成功，将返回：

{}

用户收到验证码短信后，输入手机号码和该验证码来登录应用：

curl -X POST \
-H "Content-Type: application/json" \
-H "X-LC-Id: {{appid}}" \
-H "X-LC-Key: {{appkey}}" \
-d '{"mobilePhoneNumber":"+86186xxxxxxxx","smsCode":"123456"}' \
https://API_BASE_URL/1.1/login

手机号码＋验证码重置用户密码​

已验证手机号的用户可以通过手机短信重置密码：

curl -X POST \
  -H "X-LC-Id: {{appid}}" \
  -H "X-LC-Key: {{appkey}}" \
  -H "Content-Type: application/json" \
  -d '{"mobilePhoneNumber": "+86186xxxxxxxx"}' \
  https://API_BASE_URL/1.1/requestPasswordResetBySmsCode

发送一条重置密码的短信验证码到注册用户的手机上，需要传入注册时候的 mobilePhoneNumber。

如果成功，将返回：

{}

用户收到验证码后，调用 PUT /1.1/resetPasswordBySmsCode/<code> 来设置新的密码（其中 URL 中的 <code> 就是 6 位验证数字）：

curl -X PUT \
  -H "X-LC-Id: {{appid}}" \
  -H "X-LC-Key: {{appkey}}" \
  -H "Content-Type: application/json" \
  -d '{"password": "<新密码>", "mobilePhoneNumber": "+86186xxxxxxxx"}' \
  https://API_BASE_URL/1.1/resetPasswordBySmsCode/收到的6位验证码

修改成功后，用户就可以用新密码登录了。

图形验证码 captcha​

图形验证码是防范 短信轰炸 最有效的手段。LeanCloud 提供的图形验证码含有两个接口：

URLHTTP 方法功能
/1.1/requestCaptchaGET获取图形验证码
/1.1/verifyCaptchaPOST校验图形验证码并返回二次凭证

要使用图形验证码来防止用户短信接口遭到轰炸，需要首先在控制台启用启用短信图形验证码（详见短信 SMS 服务使用指南），然后通过上述接口获取图形验证码：

curl -X GET \
  -H "X-LC-Id: {{appid}}" \
  -H "X-LC-Key: {{appkey}}" \
   -G \
  --data-urlencode 'size=4' \
  https://API_BASE_URL/1.1/requestCaptcha
参数名参数类型默认说明
widthnumber85图形验证码展示区域的宽度，单位：像素，有效值范围：60-200。
heightnumber30图形验证码展示区域的高度，单位：像素，有效值范围：30-100。
sizenumber4验证码的字符长度，有效值范围：3-6（需要使用 masterKey）。
ttlnumber60验证码有效期，单位：秒，有效值范围：10-180（需要使用 masterKey）。

返回结果：

{
   "captcha_token":"R2cxkqSz",
   "captcha_url":"https:\/\/leancloud.cn\/1.1\/captchaImage?appId=PXnN5AqVpgEI4esrTLhoxUkd-gzGzoHsz&token=R2cxkqSz"
}
参数名称说明
captcha_token供 verifyCaptcha 校验使用
captcha_url图形验证码的图片地址

获取了图形验证码后，需要使用对应的验证接口来校验：

curl -X POST \
  -H "X-LC-Id: {{appid}}" \
  -H "X-LC-Key: {{appkey}}" \
  -H "Content-Type: application/json" \
  -d '{
        "captcha_code": "0000",
        "captcha_token": "R2cxkqSz"
      }' \
  https://API_BASE_URL/1.1/verifyCaptcha

参数名称说明
captcha_code用户输入的图形验证码
captcha_tokenrequestCaptcha 返回的 captcha_token

验证成功会返回：

{ "validate_token": "发送短信的二次凭证"}

获取到的 validate_token 需要添加在 requestSmsCode 的请求内容当中：

curl -X POST \
  -H "X-LC-Id: {{appid}}" \
  -H "X-LC-Key: {{appkey}}" \
  -H "Content-Type: application/json" \
  -d '{"mobilePhoneNumber": "+86186xxxxxxxx","validate_token":"token"}' \
  https://API_BASE_URL/1.1/requestSmsCode