Description

Version

v1.0

Basic Bundle

Basic bundle rules

Add bundle will not change the current SIM status.

One SIM can have multiple basic bundles.

Only one basic bundle can be used at a time.

If multiple basic bundles are added to the SIM, the earlier bundle will be used by default (FIFO) ( when being activated).

When SIM is suspended, the service will be temporarily stopped and the service validity will still decrease with time.

When SIM status is Terminated, this API will not work.

Add-on Bundle - `Pending`

If the data of the SIM is insufficient in current cycle, add-on bundle will increase the data volume before the cycle ends. It dose not replace the basic bundle in use.

Add on bundle rules

SIM status must be Active.

The basic bundle must support add on bundle.

The add on bundle start immediately after being added.

When SIM is suspended, the add-on bundle will be removed.

When SIM is resumed, the add-on cannot be restored.

Request

Path Params

sim_id

string

required

Header Params

nonce

integer

required

random integer

Default:

timestamp

string

required

Long; Epoch timestamp ms; timestamp needs to be within 10 minutes from time of request!

Accept-Language

string

optional

Default:

en-US

Content-Type

string

optional

Default:

application/json

Authorization

string

required

LF {lfAccessKeyId}/{sign}

Default:

X-LF-Api-Version

string

optional

X-LF-Signature-Type

string

optional

1.0 or 2.0

Default:

2.0

Body Params application/json

timestamp

string

required

nonce

integer

required

random

bundle_id

string

optional

Bundle ID

bundle_type

integer

required

bundle type：10 - Basic、11 - Add on

cycles

integer

optional

Number of add cycles. This value does not take effect when the type is 11- add on. If the type is 10 - basic, the value is mandatory. If it is empty, the value is 1 by default

Example


{
    "timestamp": "16740122699896",
    "nonce": 22,
    "bundle_id": "LP09823222320",
    "bundle_type": 10,
    "cycles": 3
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

data

string

required

status

object

required

code

string

required

message

string

required

detail

string

optional

Examples

成功示例异常示例

{
    "data": null,
    "status": {
        "code": "CB-00-0000",
        "message": "Success",
        "detail": null
    }
}

🟢200success

Add Bundle

Description#

Version#

Basic Bundle#

Basic bundle rules#

Add-on Bundle - Pending#

Add on bundle rules#

Request

Request samples

Responses

Description

Version

Basic Bundle

Basic bundle rules

Add-on Bundle - `Pending`

Add on bundle rules