流量网关平台接口
- 格式：pdf
- 大小：294.55 KB
- 文档页数：16
流量网关平台接口文档 第 1 页 共 16 页 流量网关平台 接口规范 流量网关平台接口文档
第 2 页 共 16 页 1. 概述 本文档提供了通过接口订购和退订流量包的规范。通过http传输，数据采用xml格式，编码采用UTF-8。
1.1. 接口列表 序号 接口名称 调用方向 实现方 1 订购/订购接口 第三方平台->流量网关平台 流量网关平台 流量网关平台接口文档 第 3 页 共 16 页 2 通知订购状态接口 流量网关平台->第三方平台 第三方平台
3 账户余额查询接口 第三方平台->流量网关平台 流量网关平台
1.2. 类型说明 V：表示不定长字符串。 C：表示定长字符串。 N：表示数字。
1.3. 约束说明 N：表示有N次。 1..N：表示至少1次，至多N次。
2. 接口详细说明 2.1. 订购/退订接口 2.1.1. 接入URL http://ip:port/custinte/order.do 2.1.2. 接入方式 post方式 2.1.3. 协议参数
2.1.3.1. 请求参数 通过xml发送请求。 流量网关平台接口文档 第 4 页 共 16 页 父元素 元素 描述 类型 长度 约束 说明 request head 报文头 —— —— 1 head custInteId 客户接入代码 字符 C8 1 平台分配。
head orderId 订单号 字符 V50 1 客户侧定单号，客户侧保证唯一。
head orderType 订单类型 字符 C1 1 1 订购 2 退购
head echo 随机串 字符 V20 1 客户侧产生，生成签名使用。
head timestamp 时间戳 字符 C14 1 格式：YYYYMMDDHHMMSS
head version 版本 数字 N 1 head chargeSign 签名 字符 C32 1 MD5((custInteId + orderId + secretKey(密钥) +
echo + timestamp)的utf-8字节流)取摘要字节，然后对字节进行base64编码。 request body 报文体 —— —— 1 body item 订购信息 —— —— 1..20 item packCode 流量包编码 字符 V10 1 item mobile 手机号 字符 V2000 1 注：手机号重复时，表示手机号充多次，最多30
个手机号。 item effectType 生效方式 字符 C1 1 1 立即生效
2 下半月生效 3 下月生效
请求样例： 流量网关平台接口文档 第 5 页 共 16 页
第 6 页 共 16 页 2.1.3.2. 返回结果 父元素 元素 描述 类型 长度 约束 说明 response result 执行结果 字符 C4 1 执行结果代码，0000 表示成功。
其他表示失败 response desc 结果描述 字符 V500 1 失败时的错误描述。
样例： 0000
2.1.4. 约束说明
2.2. 通知订购状态接口 2.2.1. 接入URL 第三方平台提供通知地址。 流量网关平台接口文档
第 7 页 共 16 页 2.2.2. 接入方式 采用POS方式提交数据 2.2.3. 协议格式
2.2.3.1. 请求参数 父元素 元素 描述 类型 长度 约束 说明 request head 报文头 —— —— 1 head custInteId 客户接入代码 字符 V10 1 head echo 随机串 字符 V20 1 head timestamp 时间戳 字符 C14 1 格式：YYYYMMDDHHMMSS
head chargeSign 签名 字符 C32 1 MD5((custInteId + echo+ secretKey(密钥) +
timestamp)的utf-8字节流)取摘要字节，然后对字节进行base64编码。 request body 报文体 —— —— 1 body item 状态报告信息 —— —— 1..100 item orderId 订单号 字符 V50 1 item orderType 订单类型 字符 C1 1 1 订购 2 退购
item packCode 流量包编码 字符 V10 1 item mobile 手机号 字符 V2000 1 多个手机号采用英文逗号分隔。
item result 结果 字符 C4 1 0000 成功 流量网关平台接口文档 第 8 页 共 16 页 其他是错误编码 item desc 错误描述 字符 V500 1 失败时的错误描述
item gateErrorCode 运营商的错误编码 字符 V10 当result等于1003时，才会有这个节点，并且这个
节点的值是运营商返回的错误编码
样例： 0000 //说明：当result等于1003时，才会有这个节点，并且这个节点的值是运营商返回的错误编码 流量网关平台接口文档 第 9 页 共 16 页 1001 //说明：当result等于1003时，才会有这个节点，并且这个节点的值是运营商返回的错误编码
2.2.3.2. 返回结果 父元素 元素 描述 类型 长度 约束 说明 response result 执行结果 字符 C4 1 执行结果代码，0000 表示成功。
其他表示失败 response desc 结果描述 字符 V500 1 失败时的错误描述。
样例： 0000 流量网关平台接口文档
第 10 页 共 16 页 2.3. 账户余额查询接口 说明： 1、 因订购接口和失败返还账户处理是异步处理，此查询结果仅供参考和实际余额可能有小的差异。 2、 客户有多个接入时，任意一个接入参数均可查询余额。
2.3.1. 接入URL http://ip:port/custinte/query/balance.do 2.3.2. 接入方式 post方式 2.3.3. 协议格式
2.3.3.1. 请求参数 父元素 元素 描述 类型 长度 约束 说明 request head 报文头 —— —— 1 head custInteId 客户接入代码 字符 C8 1 平台分配。
head echo 随机串 字符 V20 1 客户侧产生，生成签名使用。
