1. 简介
云信通流量平台是为用户提供购买手机流量的接口平台，平台为用户提供了诸如订购流量、订购结果查询、用户余额查询等接口。
2. 接口概述
接口采用HTTP POST方式提交请求参数；平台接收到数据后会验证用户的服务器IP及接口中提交的用户编号和密码参数，验证成功后再进行请求处理；处理完成后给用户返回JSON格式数据。
本接口协议的字符集编码格式（包括请求参数和返回参数）统一使用UTF-8格式编码。
该接口版本为1.0。
接口调用
3. 接口详述
3.1. 订购全网通用流量产品
接口说明：用户订购流量产品。
调用地址：请联系销售提供
3.1.1. 输入参数
|
参数名称 |
长度 |
是否必填 |
说明 |
|
timeStamp |
14 |
是 |
当前时间戳，格式为yyyyMMddHHmmss，如： 20101010101010 |
|
userId |
30 |
是 |
用户编号，由平台提供。 |
|
securityKey |
30 |
是 |
安全密码，安全密码使用系统分配的密码进行MD5加密，下同。 |
|
mobilePhone |
12*200 |
是 |
订购流量的手机号码。 如果是多个号码请以英文半角逗号分隔， 多可提交200个手机号。如果是多个号码需是同一运营商且订购同一流量产品大小的一批号码。 |
|
orderSize |
是 |
订购流量产品的大小，单位：M。 |
|
|
orderLength |
否 |
订购时长，单位：月。 现阶段仅能订购1个月，故仅可提交1。 |
|
|
effectiveType |
否 |
订购生效方式。 0：立即生效；1：下月生效。参数名可为空。参数名为空时，默认为0。 |
3.1.2. 输出参数
|
参数名称 |
说明 |
|
code |
返回码。 如果手机号全部提交成功，则code值为0000，result值为空。 如果提交手机号码部分成功，部分失败，则code值为0000，result值为全部失败手机号码。 如果手机号全部提交失败，则code值为对应返回码，result值为对应返回码说明。 |
|
msgId |
订单编号 |
|
result |
结果信息 |
{"code":"返回码", " msgId ":"订单编号","result":"多个手机号以逗号分隔"}
3.2. 按产品编号进行流量订购
接口说明：用户订购流量产品。
调用地址：请联系销售提供
3.2.1. 输入参数
|
参数名称 |
长度 |
是否必填 |
说明 |
|
timeStamp |
14 |
是 |
当前时间戳，格式为yyyyMMddHHmmss，如： 20101010101010 |
|
userId |
30 |
是 |
用户编号，由平台提供。 |
|
securityKey |
30 |
是 |
安全密码，安全密码使用系统分配的密码进行MD5加密，下同。 |
|
mobilePhone |
12*200 |
是 |
订购流量的手机号码。 如果是多个号码请以英文半角逗号分隔， 多可提交200个手机号。如果是多个号码需是同一运营商且订购同一流量产品大小的一批号码。 |
|
productId |
是 |
运营商编号。1：移动，2：联通，3：电信。 |
|
|
orderLength |
否 |
订购时长，单位：月。 现阶段仅能订购1个月，故仅可提交1。 |
|
|
effectiveType |
否 |
订购生效方式。 0：立即生效；1：下月生效。参数名可为空。参数名为空时，默认为0。 |
3.2.2. 输出参数
|
参数名称 |
说明 |
|
code |
返回码。 如果手机号全部提交成功，则code值为0000，result值为空。 如果提交手机号码部分成功，部分失败，则code值为0000，result值为全部失败手机号码。 如果手机号全部提交失败，则code值为对应返回码，result值为对应返回码说明。 |
|
msgId |
订单编号 |
|
result |
结果信息 |
3.2.3. 返回数据样例
{"code":"返回码", " msgId ":"订单编号","result":"多个手机号以逗号分隔"}
3.3. 查询订购状态报告
接口说明：用户获取已订购的流量产品的订购结果。
调用地址：请联系销售提供
3.3.1. 输入参数
|
参数名称 |
长度 |
是否必填 |
说明 |
|
timeStamp |
14 |
是 |
当前时间戳，格式为yyyyMMddHHmmss，如： 20101010101010 |
|
userId |
30 |
是 |
用户编号 |
|
securityKey |
30 |
是 |
安全密码 |
|
msgId |
30 |
是 |
需查询的订单编号。 |
3.3.2. 输出参数
|
参数名称 |
说明 |
|
code |
返回码。 |
|
result |
结果信息。查询成功则会将结果记录在result字段中，result为空说明无记录。如果返回码不是0000时，则result的值为对应返回码说明。方便客户实时准确知道失败原因。 |
3.3.3. 返回数据样例
{"code":"0000","result":[{"mobile":"15101034188","userId":"1","msgId":"111","err":"0","fail_describe":"订购成功","report_time":"2015-02-09 15:46:54"}]}
3.4. 批量查询订购状态报告（暂不提供）
接口说明：用户批量获取已订购的流量产品的订购结果。
调用地址：请联系销售提供
3.4.1. 输入参数
|
参数名称 |
长度 |
是否必填 |
说明 |
|
timeStamp |
14 |
是 |
当前时间戳，格式为yyyyMMddHHmmss，如： 20101010101010 |
|
userId |
30 |
是 |
用户编号 |
|
securityKey |
30 |
是 |
安全密码 |
3.4.2. 输出参数
|
参数名称 |
说明 |
|
code |
返回码。 |
|
result |
结果信息。查询成功则会将结果记录在result字段中，result为空说明无记录，一次性 多获取100条记录。如果返回码不是0000时，则result的值为对应返回码说明。方便客户实时准确知道失败原因。 |
3.4.3. 返回数据样例
{"code":"0000","result":[{"mobile":"15101034188","userId":"1","msgId":"111","err":"0","fail_describe":"订购成功","report_time":"2015-02-09 15:46:54"}]}
3.5. 用户余额查询
接口说明：用户获取账户余额。
调用地址：请联系销售提供
3.5.1. 输入参数
|
参数名称 |
长度 |
是否必填 |
说明 |
|
timeStamp |
14 |
是 |
当前时间戳，格式为yyyyMMddHHmmss，如： 20101010101010 |
|
userId |
30 |
是 |
用户编号 |
|
securityKey |
30 |
是 |
安全密码 |
3.5.2. 输出参数
|
参数名称 |
说明 |
|
code |
返回码。 |
|
result |
如果查询成功则将余额记录在result字段中。如果返回码不是0000时，则result的值为对应返回码说明。方便客户实时准确知道失败原因。 |
3.5.3. 返回数据样例
{"code" : "返回码","result" : "实际余额或者返回码说明"}
4. 返回码说明
|
返回码值 |
说明 |
|
0000 |
订购数据提交成功 |
|
0001 |
时间戳：格式或内容不正确。 |
|
0002 |
用户编号：格式或内容不正确。 |
|
0003 |
用户未开通。 |
|
0004 |
安全密码：格式或内容不正确。 |
|
0005 |
手机号：格式或内容不正确。 |
|
0006 |
手机号与业务不匹配 |
|
0007 |
订购产品大小：格式或内容不正确。 |
|
0008 |
订购时长：格式或内容不正确。 |
|
0009 |
业务代码：格式或内容不正确。 |
|
0010 |
业务已关闭 |
|
0011 |
订单编号：格式或内容不正确。 |
|
0012 |
用户提交的服务器IP地址错误 |
|
0013 |
用户余额不足 |
|
0014 |
生效方式：格式或内容不正确。 |
|
0015 |
不支持用户主动获取状态报告 |
|
1111 |
系统错误 |
京公网安备 11010502032939号