订购流量套餐/ Order data plan

请求参数

Header 参数

Accept-Language

string

可选

默认，当header中无语言要求时，默认返回简体中文。当前支持zh-CN（简体中文）、en-US（英文）。/ Support : zh-CN 、 en-US

默认值:

zh-CN

Content-Type

string

可选

默认值:

application/json

Body 参数application/json

access_code

string

必需

device_id

string

必需

设备标识，通常为SIM卡ICCID。
// SIM card ICCID.

global_order

string

必需

是否为主号订购的套餐； 1-是； 0-否；
// Is it a host number package,1- yes;0-no. Usually 0

is_open

string

必需

是否立即开通此套餐，对于支付成功，则允许立即开通；对于未支付订单，不允许开通，所以一定要判断开通标识。日程套餐订单不允许开通；OTA设备的副号流量套餐不允许立即开通取值如下： 1-立即开通； 0-不开通；
// Whether to Enable immediately ; 1- enable ;0- no. OTA support SIM should be 0.

order_period

string

必需

订购周期//order period

package_code

string

必需

package_name

string

必需

package_type

string

必需

套餐产品类型，取值定义如下： 0-日程套餐； 1-日流量套餐； 2-月流量套餐； 3-季度流量套餐； 4-半年流量套餐； 5-年流量套餐；
// Plan type: 0-Unlimited daily plan ; 1- daily plan ; 2- monthly plan; 3- 3 months plan ; 4- 6 months plan; 5 yearly plan

pay_amount

string

必需

此笔订单的支付金额，单位元，支持小数点后两位；
// Amount, two decimal places.

pay_rst

string

必需

支付结果，取值如下： 1-未支付； 2-支付成功；
// Payment status : 1- unpaid ;2-paid

pay_type

string

可选

支付方式，取值如下： 0-ipay88 1-微信 2-支付宝
// mode of payment: 0- ipay88 ; 1- wechat pay ;2-alipay

test_flow

string

必需

测试流量大小当test_flow_flag为1时，此字段不能为空
// test data volume

test_flow_flag

string

必需

是否有测试流量 1有0无，仅限首单可设置为1
// test data ,1- yes ;0- no. usually 0

timestamp

string

必需

version

string

必需

sign

string

必需

示例

{
  "access_code": "P000270",
  "device_id": "89852022018041800192",
  "global_order": "0",
  "is_open": "0",
  "order_period": "1",
  "package_code": "DP20190726001274",
  "package_name": "C_M_0_P_中国20M不限速月套餐",
  "package_type": "2",
  "pay_amount": "0",
  "pay_rst": "1",
  "pay_type": "2",
  "test_flow": "0",
  "test_flow_flag": "0",
  "timestamp": "1643253530",
  "version": "2.0",
  "sign": "zOoyHBVtE/pOeA7nOuzCLvAg8d8="
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api-uat.io.linksfield.net/cube/v4/package/orderPackage' \
--header 'Accept-Language: zh-CN' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_code": "P000270",
    "device_id": "89852022018041800192",
    "global_order": "0",
    "is_open": "0",
    "order_period": "1",
    "package_code": "DP20190726001274",
    "package_name": "C_M_0_P_中国20M不限速月套餐",
    "package_type": "2",
    "pay_amount": "0",
    "pay_rst": "1",
    "pay_type": "2",
    "test_flow": "0",
    "test_flow_flag": "0",
    "timestamp": "1643253530",
    "version": "2.0",
    "sign":"zOoyHBVtE/pOeA7nOuzCLvAg8d8="
}'

返回响应

🟢200Success

application/json

Body

code

string

必需

data

object

必需

sign

null

必需

order_id

string

必需

套餐的订购ID；订购成功时，即ret_code=0000时，该字段存在。
// Plan order ID.

order_start_date

null

必需

套餐激活启用时间，格式为： YYYYMMDD；当请求时，要求立即开通此套餐时，本字段存在；
// Plan active time, YYYYMMDD, UTC 8

order_expire_date

null

必需

套餐预计过期时间，格式为： YYYYMMDD；当请求时，要求立即开通此套餐时，本字段存在；
// Data plan estimated expiration time, YYYYMMDD , UTC 8

message

string

必需

success

boolean

必需

示例

{
  "code": "0000",
  "data": {
    "sign": null,
    "order_id": "ORDER_47452122261749760",
    "order_start_date": null,
    "order_expire_date": null
  },
  "message": "成功",
  "success": true
}