欣欣云短信接口(Https协议)
一,短信发送:(黑名单等拦截错误实时返回,一次最多提交五万条)
地址:https://sms.shxinxinyun.com/api/send-sms-batch
请求头:Content-Type:application/x-www-form-urlencoded
请求方式:POST 编码格式:UTF-8 返回值:JSON
参数
参数名 | 参数介绍 | 示例 | 是否必填 |
---|---|---|---|
sp_id | 产品sp_id | 666666 | 是 |
mobiles | 手机号 | 176xxxxxxxxx,171xxxxxxxxx | 是 |
content | 短信内容 | 【短信签名】验证码123 | 是 |
password | 密码,需要md5处理 | d41d8cd98f00b204e9800998ecf8427e | 否 |
ext | 扩展号 | 123 | 否 |
返回值
参数名 | 参数介绍 | 示例 |
---|---|---|
code | 详情见错误表 | 0 |
msg | 成功-success 错误-其他提示 | success |
msg_id | 成功返回 | 17 |
failed_data | 发送号码中失败的号码对应的错误码 | ["13764517999":"WL:CWHM"] |
二,状态报告(每条短信状态仅可获取一次)
地址:https://sms.shxinxinyun.com/api/report
请求方式:GET 返回值:JSON
运营商返回某条短信状态后,此接口就能拉取到,之后调用此接口将不会返回此条短信的状态,所以调用者拉到数据后需要根据 手机号+msg_id 将状态存在本地
参数
参数名 | 参数介绍 | 示例 |
---|---|---|
sp_id | 产品sp_id | 666666 |
password | 密码,需要md5处理 | d41d8cd98f00b204e9800998ecf8427e |
返回值
参数名 | 参数介绍 | 示例 |
---|---|---|
code | 详情见错误表 | 0 |
msg | 成功-success 错误-其他提示 | success |
data | 扩展号,该批次消息id(即msg_id),手机号,状态,时间 字段以,分隔多条记录以|分隔 | 123,2,1762532xxxx,DELIVRD,2021-12-23 01:02:03|123,2,17862532xxxx,DELIVRD,2021-12-23 01:02:03 |
三,用户上行回复
地址:https://sms.shxinxinyun.com/api/get-reply
请求方式:GET 返回值:JSON
手机回复上行后,此接口就能拉取到上行数据,每个上行数据只能拉取到一次,所以调用者拉到上行后,需要将上行的内容存在本地,然后自行根据 msg_id,手机号 等信息匹配具体哪条短信产生的上行回复
参数
参数名 | 参数介绍 | 示例 |
---|---|---|
sp_id | 产品sp_id | 666666 |
password | 密码,需要md5处理 | d41d8cd98f00b204e9800998ecf8427e |
返回值
参数名 | 参数介绍 | 示例 |
---|---|---|
code | 详情见错误表 | 0 |
msg | 成功-success 错误-其他提示 | success |
data | 扩展号,调用发送接口返回的msg_id,手机号,状态,时间,字段以,分隔 多条记录以|分隔 | TD,158114xxxx,100000006,048842426601,20220325123304|退订,1891456xxxx,100000007,0615,20211115173903 |
四,余额查询
地址:https://sms.shxinxinyun.com/api/balance
请求方式:GET 返回值:JSON
参数
参数名 | 参数介绍 | 示例 |
---|---|---|
sp_id | 产品sp_id | 666666 |
password | 密码,需要md5处理 | d41d8cd98f00b204e9800998ecf8427e |
返回值
参数名 | 参数介绍 | 示例 |
---|---|---|
code | 详情见错误表 | 0 |
msg | 成功-success 错误-其他提示 | success |
data | 余额 | {"balance": "99999"} |
五,账号产品sp_id查询地址:
密码需要MD5加密:
六,错误码(code)
错误码 | 说明 |
---|---|
403 | 403错误(SSL后端接口校验,请求必须要加User-Agent:application/x-www-form-urlencoded) |
404 | 接口返回404错误(主机头请添加User-Agent:application/x-www-form-urlencoded) |
10000 | 服务出错,请稍后再试 |
10001 | 参数错误,请确认 |
10008 | 账号被锁定,请联系管理员确认 |
10011 | 余额不足,请尽快充值 |
10100 | 签名校验失败 |
10101 | 您的ip不在白名单内,请确认 |
10102 | 密码错误,请确认 |
10200 | 产品sp_id必须填写 |
10201 | 手机号必须填写 |
10202 | 短信内容必须填写 |
10203 | 发送时间格式必须为UNIX时间戳 |
10208 | 短信进拦截,具体原因参考data字段 |
10209 | 触发防刷,请调整配置 |
七,错误码(data)
错误码 | 说明 |
---|---|
WL:MBLJ | 短信内容匹配到了模板,并且此模板类型是拦截 |
WL:MBSH | 命中审核模板 |
WL:NMLJ | 短信内容没有匹配到模板,并且用户的模板审核方式是未匹配到就进拦截 |
WL:NMSH | 短信内容没有匹配到模板,并且用户的模板审核方式是未匹配到就进审核 |
WL:KHLJ | 命中空号,进拦截 |
WL:QHLJ | 命中用户签名黑名单,进拦截 |
WL:SHLJ | 命中用户SPID黑名单,进拦截 |
WL:CHLJ | 命中系统产品黑名单,进拦截 |
WL:CWHM | 错误号码 |
WL:QWBB | 短信签名未报备,进拦截 |
WL:MQM | 需要短信签名但没有,进拦截 |
WL:CS | 超过限速了 |
WL:ZJLJ | 不匹配任何模板,直接拦截 |
WL:CMT | 产品未配置相应通道,进拦截 |
WL:CDQC | 通道不支持该地区发送,进拦截 |
WL:CGMT | 产品通道池中没有相应通道,进拦截 |
WL:CNH | 所选的通道不健康,进拦截 |
WL:TCLJ | 不在发送时间段,进拦截 |
WL:TCSH | 不在发送时间段,进审核 |
WL:CPL | 超频限制 |
WL:BHC | 触发关键词。 |
八,开发者必读
1,绑定图型校验码——将图形校验码和手机验证码进行绑定,这样能比较有效的防止软件恶意注册。
2,短信发送间隔设置—设置同一号码重复发送的时间间隔,一般设置为60-120秒
3,IP限定——根据自己的业务特点,设置每个IP每天的最大发送量
4,手机号码限定——根据业务特点,设置每个手机号码每天的最大发送量
5,流程限定——将手机短信验证和用户名密码设置分成两个步骤,用户在设置成功用户名密码后,下一步才进行手机短信验证,并且需要在获取第一步成功的回执之后才可进行校验。
九,第三方短信接口请联系欣欣云客服确认
主账号:php demo
主账号:java demo
欣欣云客服中心
Q Q: 2307110111
电话:021-68909108