Overview #

Request ID (Only for MP API) #

Update September 25, 2023

Description #

Request
All MP API requests support log traces.
Add the parameter requestId to the Query params of the GET request or to the Body of the POST request to indicate the uniqueness of the request.
The call log generated by the interface will be automatically stored in the database for relevant personnel to query.
At the same time, the interface also can be used normally without the parameter requestId.However, the generated call log has no unique identifier and can only be filtered by call time.
Response
If you use requestId in your request, the same requestId will be included in the return response to your request. Otherwise, the requestId return value is null.

Specification for generating requestId #

A requestId can be a string of any format, up to 500 bytes in length, and must be unique to the caller.

For example:

This is a string of the current time and random numbers generated by the snowflake algorithm.

requestId: 202309251611-1683713932415610880

Note:
If the requestId parameter is added to the GET request, the requestId also participates in the signature calculation.

overview of the apis #

Alarm callback #

Specifies the callback interface #

You need to write a request interface (It must be a POST interface) in your service, and then call /mp-api/api/esim/saveAlarmCallbackInterface to save the full URL of your interface into the Links Field configuration.

POST /mp-api/api/esim/saveAlarmCallbackInterface

Body parameters

Responses

{
    "code": 200,
    "msg": "Success",
    "data": "httpUrl",
    "requestId": null
}

Alarm callback #

When the usage reaches the specified threshold, callback push is triggered, and the alarm information is sent to the specified server by querying the callback interface configured with the Reseller.

Callback interface params

Order status query #

GET /mp-api/api/esim/queryOrderStatus

Query parameters #

Responses #

Note: Multiple pieces of data may be returned

Normal Data:

{
  "code": 200,
  "msg": "Success",
  "data": [
    {
      "eid": "89491202308310000235",
      "packageCode": "LP14230831004073",
      "status": "0",
      "actualStartTime": null,
      "plannedEndTime": null
    }
  ],
  "requestId": null
}

Null data:

{
    "code": 200,
    "msg": "Success",
    "data": [{
        "eid": null,
        "packageCode": null,
        "status": null,
        "actualStartTime": null,
        "plannedEndTime": null
    }],
    "requestId": null
}

Traffic query #

GET /mp-api/api/esim/queryTraffic

Query parameters #

Responses #

Note: Multiple pieces of data may be returned

Normal data:

{
  "code": 200,
  "msg": "Success",
  "data": [
    {
      "eid": null,
      "packageCode": "LP14230831004073",
      "packageFlow": null,
      "packageUsedFlow": null,
      "actualStartTime": null,
      "plannedEndTime": null,
      "cycle": "1"
    }
  ],
  "requestId": null
}

Null data:

{
    "code": 200,
    "msg": "Success",
    "data": [{
        "eid": null,
        "packageCode": null,
        "packageFlow": null,
        "packageUsedFlow": null,
        "actualStartTime": null,
        "plannedEndTime": null,
        "cycle": null
    }],
   "requestId": null
}

Switch order #

POST /mp-api/api/esim/switchOrder

Body parameters #

Note:
OrderCode can determine an order separately

Update:
Update September 25, 2023
switchButton added pause and re-enable operations. Set the correct values based on the switchButton example value

Responses #

{
    "code": 200,
    "msg": "Success",
    "data": null,
    "requestId": null
}

Package List #

GET /mp-api/api/esim/packageList

Query parameters #

Responses #

{
  "code": 200,
  "msg": "Success",
  "data": [
    {
      "packageCode": "LP14230423003990",
      "packageName": "C_M_000981_P_S_越南30天不限量不限速日套餐（弗兰威尔TB100）",
      "coverCountry": "452",
      "coverCountryName": "Vietnam"
    },
    {
      "packageCode": "LP14230423003990",
      "packageName": "C_M_000981_P_S_越南30天不限量不限速日套餐（弗兰威尔TB100）",
      "coverCountry": "452",
      "coverCountryName": "Vietnam"
    },
    {
      "packageCode": "LP14230423003991",
      "packageName": "C_M_000981_P_S_TB60越南6GB1天限速128kbps日套餐（弗兰威尔）",
      "coverCountry": "452",
      "coverCountryName": "Vietnam"
    },
    {
      "packageCode": "LP14230423003992",
      "packageName": "C_M_000981_P_S_TB100越南30天不限量不限速日套餐（弗兰威尔）",
      "coverCountry": "452",
      "coverCountryName": "Vietnam"
    },
    {
      "packageCode": "LP14230424003995",
      "packageName": "C_M_000981_P_S_TB100越南6GB1天限速128kbps日套餐（弗兰威尔）",
      "coverCountry": "452",
      "coverCountryName": "Vietnam"
    }
  ],
  "requestId": null
}

Activation Code #

POST /mp-api/api/esim/activationCode

Body parameters #

Note: activationCode is String of the QR which will be scanned by the end-user to download/instal the profile.

orderCode is an unique ID in the MP system. The access party should bind an unique ID in their own system to manage the relations later for the traffic query,service(disable/enable) etc.

Responses #

{
    "code": 200,
    "msg": "Success",
    "data": {
        "orderCode": "ORDER_1697180313207705600",
        "iccid": "8943108169999542001",
        "qrCode": "LPA:1$rsp-0001.linksfield.net$I8ZC9-JIPOM-XUZOP-X1FEO"
    },
    "requestId": null
}