Order OTA Plan - Linksfield Developer

Request

Header Params

Accept-Language

string

optional

By default, if there is no language requirement in header, simplified Chinese is returned by default. Currently, zh-CN (simplified Chinese) and EN-US (English) are supported.

Default:

zh-CN

Content-Type

string

optional

Default:

application/json

Body Params application/json

access_code

string

required

device_id

string

required

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

global_order

string

required

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

is_open

string

required

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

order_period

string

required

订购周期必须为1//order period，must be 1

package_code

string

required

package_name

string

required

package_type

string

required

套餐产品类型，取值定义如下： 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

required

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

pay_rst

string

required

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

pay_type

string

required

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

test_flow

string

required

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

test_flow_flag

string

required

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

mcc

string

optional

使用地mcc list，选填。支持多个。必须包含在套餐支持的覆盖地mcc范围内。 // The MCC list of place to use , optional fields, support multiple MCC. The MCC must be covered by the package supported MCC list

days

integer

required

天数，必填。正整数，1~n，n必须小于plan_id的服务控制周期。// Number of days, required fields. The number shall be positive interger,

timing_type

string

required

计时类型：1-24小时日；2-UTC 8 时区自然日（0-24点）；//Timer type: 1- 24hours natural time 2-UTC 8 timezone natural day (0-24 o'clock) ；

timestamp

string

required

version

string

required

sign

string

required

Example

{
    "access_code":"QY-000001",
    "device_id":"89852202101130001670",
    "global_order":"0",
    "is_open":"0",
    "order_period":"1",
    "package_code":"DP20201218003915",
    "package_name":"T_T_T_0_P_S_\u4e2d\u56fd100G/365\u5929\u5957\u9910",
    "package_type":"1",
    "pay_amount":"0",
    "pay_rst":"1",
    "pay_type":"2",
    "test_flow":"0",
    "test_flow_flag":"0",
    "mcc":"",
    "days":364,
    "timing_type":"1",
    "timestamp":"1662628450",
    "version":"2.0",
    "sign":"xoiCacRJ6XYAsv2lCpAw7NEhmQM="
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'http://127.0.0.1/package/createOtaOrder' \
--header 'Accept-Language: zh-CN' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_code":"QY-000001",
    "device_id":"89852202101130001670",
    "global_order":"0",
    "is_open":"0",
    "order_period":"1",
    "package_code":"DP20201218003915",
    "package_name":"T_T_T_0_P_S_\u4e2d\u56fd100G/365\u5929\u5957\u9910",
    "package_type":"1",
    "pay_amount":"0",
    "pay_rst":"1",
    "pay_type":"2",
    "test_flow":"0",
    "test_flow_flag":"0",
    "mcc":"",
    "days":364,
    "timing_type":"1",
    "timestamp":"1662628450",
    "version":"2.0",
    "sign":"xoiCacRJ6XYAsv2lCpAw7NEhmQM="
}'

Responses

🟢200Success

application/json

Body

code

string

required

data

object

required

sim_id

string

required

SIM Card ICCID

order_id

string

required

order_time

string

required

order time utc 8

message

string

required

success

boolean

required

Example

{
    "code": "string",
    "data": {
        "sim_id": "string",
        "order_id": "string",
        "order_time": "string"
    },
    "message": "string",
    "success": true
}