短信api接口文档

测试时，请使用正式内容进行测试，请勿给同一手机号连续发送相同内容，运营商已进行规则调整以应对短信炸弹问题。

所有短信均有监控，请勿发送以下内容（营销广告、不合法，要挟、虚假、私人信息、滥发、邀请类）。

网页应用用于手机验证 ，请务必增加图形验证（以防止被人利用，被用于短信轰炸用途），否则不予以接入。

发送之前请务必仔细阅读内容审核的相关规则     点此查看

接口列表

批量接口专门用于大量号码的内容群发，不建议发送验证码等有时效性要求的内容。

编码

统一使用 UTF-8 编码,请确保您的文件编码及传入参数的格式

接口通用信息

验证方式

Luosimao使用 HTTP Basic Auth 方式进行身份验证，使用api作为验证用户名,API key是验证密码，在管理中心->短信服务->触发发送下查看。

(请注意验证密码需在后台提取的API key之前加上 key-  请仔细查看下列示例)

验证示例

curl --user api:key-3ax6xnjp29jd6fds4gc373sgvjxteol0

返回格式

luosimao api 支持xml、json格式的返回结果，请求时使用不同后缀名即可

不同返回格式请求url示例

json返回：
http://sms-api.luosimao.com/v1/send.json

xml返回：
http://sms-api.luosimao.com/v1/send.xml

短信签名

短信签名指附加在短信内容末尾的署名信息，使用发送者的公司名或产品名，格式为:【XXXXX】，签名体正文部分为3-8个汉字，请勿使用纯英文或中英文签名

例如一条完整的短信请求内容：您的验证码是123456，请尽快完成验证。【铁壳网络】
【铁壳网络】即为短信签名

应运营商要求，接收到的短信签名自动前置，接收到的实际短信为：
【铁壳网络】您的验证码是123456，请尽快完成验证。

短信签名可在管理中心 - 短信 - 签名管理 下面进行添加可查看

短信模板

短信模板指一个短信内容的范式，符合这个模板的内容免审核，否则将走审核流程，建议将常规事务性短信提前添加短信模板。

模板请登录管理中心 - 短信 - 短信模板处进行添加并管理，审核通过后即可使用。

一条完整的短信模板内容：
您的验证码是###，请尽快完成验证。【铁壳网络】
 

API key的获取

登录后进入管理中心，在短信服务 -> 触发短信 下可查看自己的短信API KEY，并可进行更换

IP白名单

{"error":-50,"msg":"Ip denied:222.72.169.63"}

发送短信接口详细

接口地址

http://sms-api.luosimao.com/v1/send.[json|xml]

HTTP请求方式

POST

content-type: application/x-www-form-urlencoded

请求参数

返回结果

返回示例

json格式：

{"error":0,"msg":"ok"}

xml格式:

<response>
<error>-10</error>
<msg>Auth failed.</msg>
</response>

错误码

状态回执（短信接收状态）

在后台可查看短信的接收状态，也可在推送设置中设置回执的推送地址

短信的接收状态将以GET请求的形式推送到指定的接口地址上，具体推送的参数如下

接收回执说明：

批量发送接口详细

接口地址

http://sms-api.luosimao.com/v1/send_batch.[json|xml]

HTTP请求方式

POST

content-type: application/x-www-form-urlencoded

请求参数

返回结果

返回示例

json格式：

{"error":0,"msg":"ok"}

xml格式:

<response>
<error>-10</error>
<msg>Auth failed.</msg>
</response>

错误码

查询账户余额

接口地址

http://sms-api.luosimao.com/v1/status.[json|xml]

HTTP请求方式

GET

请求参数

无

返回结果

错误码

短信验证业务流程