跳转至

接口指南

获取图片验证码

开发者后台开通图片验证功能后,才能获取图片验证码。

示例

HTTP 请求方式: GET

http://api.sms.ronghub.com/getImgCode.json?appKey=uwd1c0sxdlx2

表单参数

名称 类型 说明
appKey String 应用 AppKey。(必传)

返回值

名称 类型 说明
code int 返回码,200 为正常。
url String 返回的图片验证码 URL 地址。
verifyId String 返回图片验证标识 Id。

json格式:

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

发送短信验证码

方法名:/sendCode

签名方法:请参考 通用 API 接口签名规则

URL:http://api.sms.ronghub.com/sendCode.json

HTTP 方法:POST

示例

HTTP 请求:

POST /sendCode.json HTTP/1.1
Host: api.sms.ronghub.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

表单参数

名称 类型 说明
mobile String 接收短信验证码的目标手机号,每分钟同一手机号只能发送一次短信验证码。(必传)
verifyId String 图片验证标识 Id ,开启图片验证功能后此参数必传,否则可以不传。在获取图片验证码方法返回值中获取。
verifyCode String 图片验证码,开启图片验证功能后此参数必传,否则可以不传。
templateId String 短信模板 Id,在开发者后台短信服务设置,短信模版中获取。(必传)
region String 手机号码所属国家区号,目前只支持中国区号 86(必传)

返回值

名称 类型 说明
code int 返回码,200 为正常。
sessionId String 短信验证码唯一标识。

json格式:

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

!!! info"提示"

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

返回值请参考 API 方法返回值说明

验证短信验证码

方法名:/verifyCode

签名方法:请参考 通用 API 接口签名规则

URL:http://api.sms.ronghub.com/verifyCode.json

HTTP 方法:POST

示例

HTTP 请求:

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

sessionId=2312312&code=3122

表单参数

名称 类型 说明
sessionId String 短信验证码唯一标识,在发送短信验证码方法,返回值中获取。(必传)
code String 短信验证码内容。(必传)

返回值

名称 类型 说明
code int 返回码,200 为正常。
success Boolean true 验证成功,false 验证失败。

json格式:

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

返回值请参考 API 方法返回值说明

发送通知类短信

方法名:/sendNotify

签名方法:请参考 通用 API 接口签名规则

URL:http://api.sms.ronghub.com/sendNotify.json

HTTP 方法:POST

示例

HTTP 请求:

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

mobile=13500000000&templateId=dsfdsfd&region=86&p1=aa&p2=bb&p3=cc

表单参数

名称 类型 说明
mobile String 接收通知短信的目标手机号。(必传)
templateId String 短信模板 Id,在开发者后台短信服务设置,短信模版中获取。(必传)
region String 手机号码所属国家区号,目前只支持中国区号 86(必传)
p1 String 短信模板中,自定义变量值,如果在通知短信模板中定义了 {p1} 则在发送通知短信时必须传入此参数,替换模板中的 {p1},否则此参数可以不传。
p2 String 短信模板中,自定义变量值,如果在通知短信模板中定义了 {p2} 则在发送通知短信时必须传入此参数,替换模板中的 {p2},否则此参数可以不传。
p3 String 短信模板中,自定义变量值,如果在通知短信模板中定义了 {p3} 则在发送通知短信时必须传入此参数,替换模板中的 {p3},否则此参数可以不传。

!!! info"提示"

注:发送的所有短信内容(包括短信通知和短信验证码)不能超过 210 个字。

返回值

名称 类型 说明
code int 返回码,200 为正常。
sessionId String 短信唯一标识。

json格式:

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

返回值请参考 API 方法返回值说明

状态码

code 描述 HTTP 状态码
1009 没有开启图验功能 400
1010 未使用已开启的图验功能 400
1000 内部逻辑错误 500
1003 参数错误 400
1005 参数长度超出限制 400
1008 调用超过频率上限 429
1002 缺少参数 400
1004 验证签名错误 401
1050 内部服务响应超时 504
1012 图片验证码不正确 430
1011 剩余条数不足,需要充值 430
1013 短信通道不可用 430
1014 短信验证码已验证过,再次验证失效 430
1015 短信验证码过期无效 430