动态流量
动态流量
查询动态流量订单
GET /open-api/v1/dynamic/traffic/orders 接口参考。
查询动态流量订单
GET /open-api/v1/dynamic/traffic/orders
Base URL:https://api.ipfbs.com/gin。
认证
在请求头传入 X-API-Key。
路径与查询参数
| 字段 | 位置 | 类型 | 必填 | 约束 | 说明 |
|---|---|---|---|---|---|
order_no |
query | string |
否 | — | 动态流量订单号;作为不透明字符串原样使用 |
status |
query | string |
否 | enum: PROCESSING, COMPLETED, FAILED | 订单状态 |
create_time_start |
query | string |
否 | format: date-time | 创建时间下限(含),带时区 ISO-8601 |
create_time_end |
query | string |
否 | format: date-time | 创建时间上限(含),带时区 ISO-8601 |
page_no |
query | integer |
否 | format: int64; minimum: 1 | 页码,从 1 开始 |
page_size |
query | integer |
否 | format: int64; minimum: 1; maximum: 100 | 每页条数,范围 1~100 |
请求示例
curl --request GET \
--url 'https://api.ipfbs.com/gin/open-api/v1/dynamic/traffic/orders' \
--header 'Accept: application/json' \
--header 'X-API-Key: <YOUR_API_KEY>'
成功响应中的 data
接口使用 code、msg、data、next 响应结构。HTTP 200 也可能包含非零业务错误码;先检查 code。
| 字段 | 类型 | 必填 | 约束 | 说明 |
|---|---|---|---|---|
data.list |
object[] |
否 | — | 当前页数据列表 |
data.list[].order_no |
string |
否 | — | 动态流量订单号;作为不透明字符串原样使用 |
data.list[].status |
string |
否 | enum: PROCESSING, COMPLETED, FAILED | 订单状态 |
data.list[].product_code |
string |
否 | — | 动态流量产品编码 |
data.list[].traffic_gb |
string |
否 | — | 采购流量 GB |
data.list[].order_amount |
string |
否 | — | 订单金额,USD 十进制字符串 |
data.list[].currency |
string |
否 | — | 结算币种 |
data.list[].traffic_lot_id |
string |
否 | — | 完成后生成的流量批次 ID;未完成时为空 |
data.list[].finish_time |
string |
否 | format: date-time | 订单完成时间;未完成时为空 |
data.list[].create_time |
string |
否 | format: date-time | 订单创建时间 |
data.total |
integer |
否 | format: int64 | 符合筛选条件的总条数 |
data.page_no |
integer |
否 | format: int64; minimum: 1 | 当前页码,从 1 开始 |
data.page_size |
integer |
否 | format: int64; minimum: 1; maximum: 100 | 每页条数,范围 1~100 |
接口说明
分页查询当前用户的动态流量采购订单,可按订单号、状态和创建时间筛选