跳到主要内容

验证码短信

在使用短信服务 API 前,请确保已阅读短信服务概述,完成以下前提条件:

  • 已完成企业开发者认证。
  • 已添加短信签名。
  • 已配置普通短信模板。
  • 如需使用图片验证码功能,必须已提前启用该功能。

局限

向同一个手机号每分钟最多可发送一次验证码短信。

API 域名

融云短信服务的 API 域名如下所示:

http(s)://sms.rong-api.com

获取图片验证码

使用图验功能后,可通过此接口获取最新的图片验证码,用于进行图片验证,图验功能请在控制台短信服务中开通。

请求方法

GET/getImgCode.json

调用频率:无限制

签名规则: 所有请求融云服务端 API 接口的请求均需要进行规则校验,详见 API 请求签名

路径参数

参数类型必传说明
appKeyString应用 App Key。

请求示例

GET https://sms.rong-api.com/getImgCode.json?appKey=uwd1c0sxdlx2  HTTP/1.1

返回结果

HTTP 响应正文包含具有以下结构的 JSON 对象:

名称类型说明
codeint返回码,200 为正常。
urlString返回的图片验证码 URL 地址。
verifyIdString返回图片验证标识 ID。开通图片验证功能后,调用发送验证码短信(/sendCode.json)时必须传入该字段值。

返回结果示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"code": 200,
"url": "xxxxxxxxxxxxx",
"verifyId": "xxxxxxxx"
}

发送验证码短信

向目标用户发送短信验证码,每分钟同一手机号只能发送一次,有效期为 15 分钟,短信验证成功后验证码失效。开通图片验证功能后,如果此条图片验证不成功则用户不会收到验证短信。

请求方法

POST/sendCode.json

调用频率:无限制

签名规则: 所有请求融云服务端 API 接口的请求均需要进行规则校验,详见 API 请求签名

正文参数

HTTP 请求正文数据格式为 application/x-www-form-urlencoded,支持以下 HTTP 表单参数:

参数类型必传说明
mobileString接收短信验证码的目标手机号,每分钟同一手机号只能发送一次短信验证码。
verifyIdString图片验证标识 ID。开启图片验证功能后此参数必传,否则可以不传。在获取图片验证码(/getImgCode.json)的返回值中获取。
verifyCodeString图片验证码,开启图片验证功能后此参数必传,否则可以不传。
templateIdString短信模板 Id,在控制台短信服务设置,短信模版中获取。
regionString手机号码所属国家区号,目前只支持中国区号 86

请求示例

POST /sendCode.json HTTP/1.1
Host: sms.rong-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408706337
Signature: 890b422b75c1c5cb706e4f7921df1d94e69c17f4
Content-Type: application/x-www-form-urlencoded

mobile=13500000000&verifyId=1408706337&verifyCode=890b422b&templateId=dsfdsfd&region=86

返回结果

HTTP 响应正文包含具有以下结构的 JSON 对象:

名称类型说明
codeint返回码,200 为正常。
sessionIdString短信验证码唯一标识。调用验证短信验证码(/verifyCode.json)接口时,传入该 Session ID,对用户输入的短信验证码有效性性进行验证。

返回结果示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"code": 200,
"sessionId": "xxxxxxx"
}

验证短信验证码

对用户输入的短信验证码有效性性进行验证。

请求方法

POST/verifyCode.json

调用频率:无限制

签名规则: 所有请求融云服务端 API 接口的请求均需要进行规则校验,详见 API 请求签名

正文参数

HTTP 请求正文数据格式为 application/x-www-form-urlencoded,支持以下 HTTP 表单参数:

参数类型必传说明
sessionIdString短信验证码唯一标识。该 Session ID 可在发送验证码短信(/sendCode.json)的返回结果中获取。
codeString短信验证码内容。

请求示例

POST /verifyCode.json HTTP/1.1
Host: sms.rong-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408706337
Signature: 890b422b75c1c5cb706e4f7921df1d94e69c17f4
Content-Type: application/x-www-form-urlencoded

sessionId=2312312&code=3122

返回结果

HTTP 响应正文包含具有以下结构的 JSON 对象:

名称类型说明
codeint返回码,200 为正常;验证码是否有效通过success字段判断。
successBooleantrue 验证成功,false 验证失败。

返回结果示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"code":200,"success":true}