Restful接口规则完整解读文档格式.docx
《Restful接口规则完整解读文档格式.docx》由会员分享，可在线阅读，更多相关《Restful接口规则完整解读文档格式.docx（33页珍藏版）》请在冰豆网上搜索。
命名规则：
现有接口方法去第一个单词后，全小写命名，如：
用户余额信息实时查询能力，原接口名：
queryBalanceRealSingle（Stringmsisdn）
Restful接口:
端口/v2/balancerealsingle
2.参数规则
参数提交方式：
application/
参数命名：
单词采取小写，复合词采取下划线分开的全小写命名。
参数规则：
批量查询需有page_size以及page_num参数，避免一次性查询，部分参数需有默认值设定。
附录：
运管平台部分API规则
用户状态查询：
服务地址：
端口/v2/userstatusrealsingle
提供用户状态信息实时查询
请求参数说明:
参数
是否必须
默认值
格式举例
含义
appid
是
无
‘100001’
第三方应用唯一标示，由全网管理员在运营管理平台应用上线时分配
transid
‘’
事务ID，每次加1，用于判断是否是重放攻击
ebid
23001
能力id，运管平台生成
token
E4805d16520de693a3fe707cdc962045
加密
msisdn
11
所查询专网号码
output
否
json
json或xml
请求返回格式
示例：
端口/v2/userstatus?
appid=100001&
ebid=23001&
transid=20141016
&
token=E4805d16520de693a3fe707cdc962045&
msisdn=11
返回值：
{
status:
0,
message:
"
ok"
result:
{
status:
’00’
}
短信失败记录历史查询：
有LIST传递待定
端口/v2/smsfaulthistory1
返回短信失败记录相应数据
begin_time
查询开始时间
查询时间范围：
3个月内的记录
end_time
查询结束时间
page_size
10
返回记录数量，默认为10条记录，最大可设置为20条
page_num
0、1、2
分页页码，默认为0。
0代表第一页，1代表第二页，以此类推。
如果设置了此字段，则输出结果中含有total字段。
端口/v2/smsfaulthistory1?
transid=20141016&
begintime=20141010&
endtime=20141111
[
]
用户实时位置信息查询
端口/v2/locationinforealsingle
返回用户的位置信息（经纬度）
端口/v2/locationinforealingles?
lat:
"
39.920411"
lng:
116.418224"
集团用户数查询
返回该集团指定日期的用户总数
query_date
端口/v2/locationinforealsingle?
ebid=23001
query_date=20141016&
token=E4805d16520de693a3fe707cdc962045
totla:
20000
流量池信息查询
端口/v2/gprspoolinfo
查询集团流量池的用户数和大小
端口/v2/gprspoolinfo?
usersCount:
10000,
size:
10240
流量池使用量查询
端口/v2/gprspoolusedinfo
查询集团流量池指定月份的流量使用情况
端口/v2/gprspoolusedinfo?
gprsUserd:
2000
Balance:
10000
短信白名单管理
端口/v2/whitelist
根据指定短信接入号和手机号列表进行短信白名单数据的添加或删除
opr_code
01
oprCode--操作类型01增加02删除
serv_code
10648000001
短信接入号
现网手机号
Post:
端口/v2/whitelist?
opr_code=01&
serv_code=10648000001&
msisdn=
msisdn:
’xxxxxxxxxxx’,
servCode:
’xxxxxxx’,
优先级类型:
’’
优先级:
’’,
oprCode:
’01’,
errCode:
用户余额信息实时查询能力
提供单个MSISDN号卡的用户余额实时查询功能
端口/v2/balancerealsingle?
msisdn=&
banlance:
10000.00
根据IP地址查询GPRS信息
端口/v2/gprsinfo
Ip
192.168.1.1
IP地址
端口/v2/gprsinfo?
ip=192.168.1.1&
ip:
’192.168.1.1’,
apn:
’’,
rat:
’’,
......等信息
码号信息查询能力
端口/v2/cardinfo
card_info
msisdn/imsi/iccid
type
0--msisdn1--imsi2--iccid
端口/v2/cardinfo?
card_info=xxx&
type=0&
’xxxxxx’,
imsi:
iccid:
’xxxxxx’
用户GPRS使用查询:
端口/v2/gprsusedinfosingle
返回日期的GPRS使用量，单位KB
所查询日期
msisdn=11&
query_date=20141016
gprs:
100000
用户短信使用查询
端口/v2/smsusedinfosingle
返回指定日期的短信使用条数
Appid
Transid
Token
Msisdn
Output
sms:
100
批量用户GPRS使用查询
端口/v2/gprsusedInfo
集团下每个用户的GPRS使用量
端口/v2/gprsusedInfo?
query_date=&
page_size=10&
page_num=0
Msisdn:
12,
},
13,
14,
30000
批量用户短信使用查询
端口/v2/smsusedinfo
端口/v2/smsusedinfo?
用户当月GPRS查询
端口/v2/gprsuusedinfosingle
返回指定号码截止到目前时刻为止本月所有的GPRS使用量，单位KB
含
升级会员 