AIP接口
Api Interface
API接口是面向有一定技术开发能力的企业用户而单独研 发的短信(sms)接口,可以方便的对接到企业用 户公司内部系 统中。本接口采用了通用的HTTP协议,可以支持各种操作系统和 开发语言。在您购买了API版短信平台并通过简单的测试后,即可把 短信接口嵌入到您公司自己的系统中,快速拥有短信发送应用, 完善您的企业服务。
用户通过HTTP的POST方式提交短信发送请求。编码采用UTF-8编码。
序号 | 参数 | 说明 |
---|---|---|
1 | account | (必填参数)用户账号 |
2 | password | (必填参数)接口密码:web 平台中的接口密码 |
3 | content | (必填参数)发送内容(1-500 个汉字)UTF-8编码 |
4 | mobiles | (必填参数)手机号码。多个以英文逗号隔开 |
5 | sendTime | (可选参数)发送时间,填写时按照此时间发送,不填时为当前时间发送 |
6 | productId | (必填参数)产品编码 |
用户短信通过http请求提交到服务器后,服务器返回响应结果,响应码的格式如下:
result: {
"ok": true,
"message": "ok",
"result": {
"blackCount": 1, // 黑名单号码数
"batchNo": "201908261135000000465", // 批次号
"balance": 2, // 余额
"normalCount": 1, // 正常号码数
"unidentifiedCount": 0, // 不能识别运营商号码数
}}
1.1.1 格式说明
短信提交后的响应结果为JSON串数据,ok为true时表示提交成功,为false时表示提交失败,message为具体原因。接口方式提交建议每次请求提交的号码量不超过两万, 请求成功后服务端成功接收到该批号码和内容信息,并返回一个唯一批次号,当用户提交失败时,ok为false,服务端无批次号信息返回。
1.1.2响应状态值说明
参数 | 说明 |
---|---|
ok | true 表示接收成功;false 表示接收失败 |
message | 服务端接收成功时为OK,接收失败时为具体失败原因 |
blackCount | 黑名单号码数 |
batchNo | 批次号,每次请求成功接口都会返回一 个唯一的批次号 |
balance | 此产品的余额 |
unidentifiedCount | 不能识别运营商号码数 |
normalCount | 正常号码数量 |