SMS CONFIG API(短信推送相关的一些设置):
写在前面的话
请求 POST所带数据都是JSON结构
返回的都是
{ code:"0表示成功,其他的都是失败" # 主要靠这个判断 message:"一些提示信息" data:{ #这个有是有数据,有时没 看你需要 我返回 }}
获取某个人的短信账户
请求参数 无
调用样例
http://127.0.0.1:8080/accounts/1
返回结果
正确时返回
{ "code": 0, "message": "success", "data": { "amount": 11111111111, "dev_id": 1 }}
错误时返回
{ "code": 5002, "message": "没有此用户", "data": null}
获取短信账户列表
请求参数 无
调用样例
http://127.0.0.1:8080/accounts
返回结果
* 正确时返回 *
{ "code": 0, "message": "success", "data": [ { "amount": 11111111111, "dev_id": 1 }, { "amount": 0, "dev_id": 0 } ]}
3设置或者给账户增加余额 给开发者账户加钱,如果之前没有账户,则是直接设置开发者余额
请求参数
| 参数名 |
必选 |
类型 |
说明 |
| money |
true |
long |
单位:元,大于1小于9000万 |
调用样例
POST http://127.0.0.1:8080/accounts/1{ "money":10000}
返回结果
{ "code": 0, "message": "success", "data": null}
错误结果
http://127.0.0.1:8080/smsset/apps/sdasda/price
{ "code": 4006, "message": "Parameter invalid"}
4获取某个APP的短信发送价格配置
请求参数 无
调用样例
http://127.0.0.1:8080/smsset/apps/13345/price
返回结果
正确时返回
{ "code": 0, "message": "success", "data": { "app_id": 133453, "price": "{\"0-100000\":49,\"100000-500000\":46,\"500000-1000000\":43,\"1000000-\":40}" }}
错误时候的返回
{ "code": 5002, "message": "fail", "data": { "app_id": 13345, "price": null }}
5 设置APP的价格配置 设置 某个app在不同的发送量下的每条短信的价格
4删除某个APP的短信发送价格配置
DELETE /apps/{appkey}/price
请求参数
{"0-100000":49,"100000-500000":46,"500000-1000000":43,"1000000-":40}
0-100000 代表 短信每月发送量在 0-100000是 4分9
"1000000-":40 代表 发送量大于 1000000 时 每条短信 4分钱
发送量的范围可以自己定义
40 代表 4分钱,为了方便计算 使用的单位是 厘
调用样例
POST http://127.0.0.1:8080/accounts/1{ "money":10000}
返回结果
{ "code": 0, "message": "success", "data": null}
6 某个用户的某个APP的短信专享通道 相当于在 为它单独设定一个 app短信的发送账户; ??看这个地方设置成 用户级的 还是app级的,看以后的需要
请求参数 不同的平台也不知道是具体的哪些参数,就先定义了下面4个
| 参数名 |
必选 |
类型 |
说明 |
| id |
true |
string |
在短信平台的唯一标示,特服号之类的 |
| key |
true |
string |
在短信平台的key或序列号之类的鬼 |
| passwd |
true |
string |
在短信平台的key的密码 |
| type |
true |
string |
是哪个短信平台的,目前只有"EMAY" |
请求实例
{ "id":231231, "key":"DNMSJDHKSJDHKJ", "passwd":"11231", "type":"EMAY"}
9.删除短信签名
DELETE /apps/{appKey}/signature
7.设置短信签名
为短信设置签名,即是 每条短信前面的 固定的内容 一般是公司名
请求参数
| 参数 |
说明 |
| signature |
汉字长度3-8,signature格式为"【激光推送】" |
curl --request POST \ --url http://*****/apps/asdasdas/signature \ --header 'content-type: application/json' \ --data '{\n"signature":"【激光推送】"\n}'
请求结果
{ "code": 0, "message": "success", "data": null}
8.获取短信签名
GET /apps/{appKey}/signature
API举例
curl --request GET \ --url http://127.0.0.1:8080/apps/asdasdas/signature \ --header 'content-type: application/json' \
请求结果
{ "code": 0, "message": "success", "data": { "signature": "【激光推送】", "app_key": "asdasdas" }}