AIP接口
Api Interface
API接口是面向有一定技术开发能力的企业用户而单独研 发的短信(sms)接口,可以方便的对接到企业用 户公司内部系 统中。本接口采用了通用的HTTP协议,可以支持各种操作系统和 开发语言,同时我们在接口文档中为 您提供了各种开发语言的例 子代码。在您购买了API版短信平台并通过简单的测试后,即可把 短信接口嵌入到您公司 自己的系统中,快速拥有短信发送应用, 完善您的企业服务。
用户通过HTTP的POST方式提交短信发送请求。编码采用UTF-8编码。
序号 | 参数 | 说明 |
---|---|---|
1 | name | (必填参数)用户账号 |
2 | pwd | (必填参数)web平台:基本资料中的接口密码 |
3 | content | (必填参数)发送内容(1-500 个汉字)UTF-8编码 |
4 | mobile | (必填参数)手机号码。多个以英文逗号隔开 |
5 | stime | (可选参数)发送时间,填写时已填写的时间发送,不填时为当前时间发送 |
6 | sign | (必填参数)用户签名 |
7 | type | (必填参数)固定值pt |
8 | extno | (可选参数)扩展码,用户定义扩展码,只能为数字 |
用户短信通过http请求提交到服务器后,服务器返回响应码,响应码的格式如下:
code,sendid,invalidcount,successcount,blackcount,msg
1.1.1 格式说明
短信提交响应为英文逗号隔开的一行数据,状态,发送编号,无效号码数,成功提交数,黑名单数和消息,无 论发送的 号码是多少,一个发送请求只返回一个sendid,如果响应的状态不是“0”,则只有状态和 消息。
1.1.2 示例
提交成功
0, 20130821110353234137876543,0,500,0,提交成功
20130821110353234137876543为返回的sendid,这个工状态报告匹配时使用。
提交失败
1、含有敏感词汇
本示例表明用户提交失败,返回错误码为1,服务器端并未返回sendid等。
1.1.3 响应状态值说明
代码 | 说明 |
---|---|
0 | 提交成功 |
1 | 含有敏感词汇 |
2 | 余额不足 |
3 | 没有号码 |
4 | 含有spl语句 |
10 | 账户不存在 |
11 | 账号注销 |
12 | 账户停用 |
13 | IP鉴权失败 |
14 | 格式错误 |
-1 | 系统异常 |