文档


中文帮助文档>开发指南

一、 文档概述

1.1格式说明

1.1调用方法:http调用,可以GET也可以POST.提交的数据要求UTF-8编码

 

1.2可以直接使用浏览器打开接口地址进行访问,和测试.,要注意在浏览器高级选项中选中"总是以UTF-8发送 URL"

 

1.3如果要用GET方法调用接口注意要用UTF-8编码URL
     要用: api.jsp?action=getuserinfo&userid=2006&password=%E5%AF%86%E7%A0%81
     而不是: api.jsp?action=getuserinfo&userid=2006&password=中文

二、 功能接口说明

2.1查客户状态


接口地址 : http://traffic.ccell.cn/lcll/xml/api.jsp

1. 查客户状态
参数 : 固定:action:getuserinfo
必填:userid:客户名
password:密码

2. 返回值 :
XML格式,UTF-8编码

3.调用成功时:
					<root return="0" info="成功">
						<name>{帐户名}</name>
						<riches>{帐户余额}</riches>
						<products>
							<product id="{产品ID}" name="{产品名称}" discount="{产品折扣}">
								<package id="{流量包ID}" net="{运营商}" mbytes="{流量数(MB)}" price="{原价}" mytype="{漫游类型}" province="{支持省份}"/>
								<package .... />
							</product>
							<product> ..... </product>
						</products>
					</root>
				

2.2流量充值


接口地址 : http://traffic.ccell.cn/lcll/xml/api.jsp

1. 查客户状态
参数 : 固定:action:charge
必填:userid:客户名
password:密码
phone:充值号码
mbytes:流量数

可选:
product: 产品ID,指定要使用的产品
mytype:漫游类型
linkid:引用ID

2. 返回值 :
XML格式,UTF-8编码
说明:
phone:要充流量的11位手机号码,
mbytes:流量数, 默认单位M, 充1GB流量包可以填 1024,1024M,1024MB,1G,
product:产品ID,不填自动按价格优先
mytype:漫游类型, 0 漫游,1 非漫游,不填自动按价格优先
linkid:引用ID,客户方提供的ID号,在状态中原样返回

3.调用成功时:
					<root return="0" info="成功" taskid="{订单号}"/>
				
4.例如:
                	<root return="0" info="成功" taskid="20150615081233875389650"/>
                

2.3获取状态报告


接口地址 : http://traffic.ccell.cn/lcll/xml/api.jsp

1. 查客户状态
参数 : 固定:action:pullstatus
必填:userid:客户名
password:密码

可选
product: 产品ID
mytype:漫游类型
linkid:引用ID

2. 返回值 :
XML格式,UTF-8编码

3.调用成功时:
	                <root return="0" info="成功">
		                <status taskid="{订单号}" linkid="{引用ID}" code="{状态码}" message="{状态说明}" time="{状态返回时间(yyyy-MM-dd HH:mm:ss)}"/>
		  				<status ..... />
	  				</root>
				
4.说明:
    状态报告成功取出一次后,下一次不可以再收到.
    24小时后未取出的数据会丢弃。
    获取状态报告和推送状态报告不可以同时有效

2.4查询状态报告


接口地址 : http://traffic.ccell.cn/lcll/xml/api.jsp

1. 查客户状态
参数 : 固定:action:querystatus
必填:userid:客户名
password:密码
taskid:订单号

说明:
taskid:订单号。

2. 返回值 :
XML格式,UTF-8编码

3.调用成功时:
					<root return="0" info="成功" taskid="{订单号}" linkid="{引用ID}" code="{状态码}" message="{状态说明}" time="{状态返回时间}">
					</root>
					<!-- 状态返回时间格式:yyyy-MM-dd HH:mm:ss -->
				
4.说明:
    充值中的订单没有 code、message、time这三个属性

2.5推送状态报告


1. 地址:客户提供推送 HTTP地址

2. 推送方式 POST :
XML格式,UTF-8编码

3.推送内容
					<root>
		                <status taskid="{订单号}" linkid="{引用ID}" code="{状态码}" message="{状态说明}" time="2016-01-09 19:00:12"/>
		  				<status ..... />
	  				</root>
			        <!-- 推送成功后,客户成功获取状态后,应响应值:success,推送通过POST BODY的方式推送。 -->
				
4.说明:
    状态报告成功取出一次后,下一次不可以再收到.
    24小时后未取出的数据会丢弃。
    获取状态报告和推送状态报告不可以同时有效

三、 附件

3.1返回错误


1.Xml 格式:
	                <root return="{错误代码}" info="{错误说明}">
	                </root>
                
2.例如:
                 	<root return="3" info="密码不正确">
                 	</root>
                 

3.1错误码说明

状态码说明
0成功
-1系统异常
1001001参数不完整
1001002余额不足
1001003账号已冻结
1001004密码不正确
1001005访问IP受限
1001006并发数超限
1001999接口系统错
1002007手机号不可识别
1002008定时发送时间参数不正确
1002009定时发送时间不能大于365天
1002010定时发送时间不能小于当前时间
1002011没有对应资源可用
1002012包规格参数错误
1002013不支持的充流量模式
1002999参数错误
返回
顶部