Overview

overview of the apis

Path	API Name
Order status push callback hook	Order status push
/cmp-api/sims/{sim_id}/cdr	Query details on single SIM card flow CDRS
/cmp-api/package/syncPackages	Synchronized traffic package information
/cmp-api/package/batchOrderPackages	Bulk order packages
/cmp-api/package/queryOrder	Query package order information
/cmp-api/package/openPackage	Activate the data plan
/cmp-api/package/cancelPackage	Cancel package order
/cmp-api/package/aheadFinishDeviceOrder	The package ends before it expires
/cmp-api/device/queryDevice	Query device information based on device_id
/cmp-api/package/getTrafficPoolInfo	Display the current enterprise’s traffic pool information with pagination

Order status push

When the status of CMP's order changes,CMP will notify via the following interface: The order status push interface is a POST request, and the fixed parameters in the request Body are as follows:

name	Required	Description
assetid	true	Equipment unique identification
imsi	true	Multiple IMSI are separated by commas
operation	true	The type of order action(see diagram below)
orderid	true	Order number
time	true	Order creation time

The operation & effects as follows:

operation	Notes	Start Conditions	Effects
1001	Terminate the order early	The order should be started	Order closed before the expected time and services disabled
1002	Cancel the order	The order is created but not started	Order closed and resource released
1003	Pause the order	The order has been started	Order paused and services disabled
1004	Restart the order	The order paused	Order started and services available
1005	Non-OTA order enabled	Order created and not starded	Order started and services available
1006
1007	OTA order enabled	OTA order created & Location Report occured in the coverage country	Order started and services available
1008	The order expired	The order created and started	The order closed and services disabled
1009	Renewal order period	The order created and not expired	More cycles added on the order
1010	Reduce cycles	The order created and not expired	The order-cycles cut-down

Responses

{
   "assetid": "89852420180910344720",
   "imsi": "204046990912345",
   "operation": "1001",
   "orderid": "L201901290000000533",
   "time": "2019-10-16 12:34:54"
}

Query details on single SIM card flow CDRS

GET /cmp-api/sims/{sim_id}/cdr

Description

Version

1.0

Application scenario

If the SIM card ID is available, you can query the flow CDRS of a specific SIM card within a specified period.

Business rules

When you specify SIM card query, you can query one SIM card at a time. The historical data can be up to 180 days from the current date.

Necessary condition

SDK API call mode

PartnerClient client = new PartnerClient(accessKey,privateKey);
client.v1().cdr().simCdr(SimCdr.builder(1, "8965011909030066336").receivedStartTime("2022-11-16").receivedEndBy("2022-12-16").pageNo(1).pageSize(10).build());
client.v2().cdr().simCdr(SimCdr.builder(1, "8965011909030066336").receivedStartTime("2022-11-16").receivedEndBy("2022-12-16").pageNo(1).pageSize(10).build());

Query parameters

Type	Name	Schema	Required	Description
Path	sim_id	string	true	An AssetId, such as 893107042131441209
Query	received_start_time	string	true	Reception start time,such as 2023-09-16
Query	received_end_by	string	true	Reception end time,such as 2023-09-18
Query	page_no	integer	true	The requested page information of the traffic package. If the value of this node is empty, it defaults to page 1.
Query	page_size	integer	true	The number of traffic package information contained in each page. If the value of this node is empty, the default value is 20.

Responses

{
  "code": "0000",
  "data": {
    "data": [
      {
        "data": 1,
        "imsi": "232010879771943",
        "mcc": "460",
        "mnc": "00",
        "msisdn": "43688877771943",
        "network": "4G",
        "plan_id": "LP14240410004345",
        "session_ended_at": null,
        "session_started_at": "2024-05-09 18:18:56",
        "sim_id": "89430101523088119435"
      },
      {
        "data": 2,
        "imsi": "232010879771943",
        "mcc": "460",
        "mnc": "00",
        "msisdn": "43688877771943",
        "network": "4G",
        "plan_id": "LP14240410004345",
        "session_ended_at": null,
        "session_started_at": "2024-05-08 16:51:39",
        "sim_id": "89430101523088119435"
      },
      {
        "data": 1303552,
        "imsi": "232010879771943",
        "mcc": "460",
        "mnc": "00",
        "msisdn": "43688877771943",
        "network": "4G",
        "plan_id": "LP14240410004345",
        "session_ended_at": null,
        "session_started_at": "2024-05-08 16:49:59",
        "sim_id": "89430101523088119435"
      },
      {
        "data": 1303552,
        "imsi": "232010879771943",
        "mcc": "460",
        "mnc": "00",
        "msisdn": "43688877771943",
        "network": "4G",
        "plan_id": "LP14240410004345",
        "session_ended_at": null,
        "session_started_at": "2024-05-08 16:49:59",
        "sim_id": "89430101523088119435"
      }
    ],
    "status": {
      "code": "CB-00-0000",
      "detail": null,
      "message": "Success"
    },
    "total_count": 4
  },
  "message": "success",
  "success": true
}

Name	Description
data[1].mcc	Mobile Country Code
data[1].mnc	Mobile Network Code
data[1].data	The usage of traffic for each part after CDR statistics, measured in bytes.
data[1].plan_id	Package ID, same as bundle id
data[1].session_started_at	The starting time of each portion of traffic after CDR statistics.
data[1].session_ended_at	The end time of each portion of traffic after CDR statistics, which may be null.
data[1].duration	The time interval between session_started_at and session_ended_at, in seconds

Synchronized traffic package

POST /cmp-api/package/syncPackages

Body parameters

Considering that there may be many traffic packages used by this access party, each time synchronization is performed, a paging method is used, and only one page of traffic package information is synchronized to the access party each time, and the number of traffic package information contained in each page Defined by the access party. If the access party wants to get all the traffic package information and there are multiple pages of package information, the access party needs to call the synchronous traffic package interface multiple times.The information is defined as follows:

{
    "page_no": 1,
    "page_size": 2,
    "version": 1.0
}

Name	Schema	Required	Description
page_no	integer	true	The requested page information of the traffic package. If the value of this node is empty, it defaults to page 1.
page_size	integer	true	The number of traffic package information contained in each page. If the value of this node is empty, the default value is 20.
version	string	false	The version of traffic package information.

Responses

Normal data:

{
    "code": "0000",
    "data": {
        "page": {
            "cur_page_no": 1,
            "page_size": 2,
            "total_count": 87,
            "total_pages": 44
        },
        "sign": "mtu8eRc2AaBhBvG8ZJkIT1kKY0w=",
        "package_num": 87,
        "package": [
            {
                "flow": "1000",
                "status": "1",
                "serviceCycleCount": "1",
                "buy_type": "2",
                "cover_country_mcc": "404;405;406",
                "cover_countrys": "India",
                "max_order_period": "-1",
                "min_order_period": "1",
                "package_code": "DP20181122000201",
                "package_desc": "",
                "package_name": "testPackageForTATA",
                "package_type": "2",
                "package_usage_attribute": "1",
                "price_type": "",
                "whole_price": "",
                "package_imsi_type": "2"
            },
            {
                "flow": "100",
                "status": "1",
                "serviceCycleCount": "1",
                "buy_type": "2",
                "cover_country_mcc": "460;461",
                "cover_countrys": "China",
                "max_order_period": "-1",
                "min_order_period": "1",
                "package_code": "DP20190924001683",
                "package_desc": "",
                "package_name": "CN-100MB-Speed-Down-256K-Daily",
                "package_type": "1",
                "package_usage_attribute": "1",
                "price_type": "",
                "whole_price": "",
                "package_imsi_type": "2"
            }
        ]
    },
    "message": "success",
    "success": true
}

In addition to the code and message nodes, it also contains the business parameter section (that is, the data node), which is defined as follows:

Name	Description
package_num	Number of traffic packages; If ret_info = 0000, the node information exists,
package	Each package node contains a traffic package information; The number of package nodes in the response message must be the same as the value of package_num.If ret_info = 0000, the node information exists;
page	The pagination information of the traffic package, so that the access system can determine whether all traffic packages have been obtained. If ret_info = 0000, the node information exists

• The page node is defined as follows:

Name	Description
total_pages	total pages
cur_page_no	Current page number
total_count	Total number of traffic packages
page_size	Number of traffic packages included per page

• The package node is defined as follows:

Name	Description
package_type	Package product types.The values are defined as follows: 1-day traffic package; 2-month data plan; 3-quarter traffic package; 4-half year traffic package; 5-year traffic package;
package_code	Package Product Code
Package_name	Package Product Name
package_desc	Package Product Description
cover_country_mcc	The package covers the country code, and different country codes are separated by English semicolons;
cover_countrys	The package covers country names, and different names are separated by semicolons in English;
price_type	If the package type is 0, this field must have a value, which can include two types: 1- single-day pricing; 2-package pricing;
flow	Package product traffic, unit is MB; If packageType is not 0, this field cannot be empty;
buy_type	The ordering method of the data package products is defined as follows: 1- prepaid; 2-post payment; If packageType is not 0, this field cannot be empty;
min_order_period	Package product minimum order period;
max_order_period	The maximum order period for package products. If there is no maximum order period limit, fill in -1 here;
whole_price	price
status	1: available, 2: obsolete
package_usage_attribute	1 resident package, 2 temporary package

Bulk Order Package

The access party can call this interface, and the access party can order packages in bulk for the devices it owns. The ordering rules are as follows:

• Through this interface, you can order data packages in batches or schedule packages in batches.

• If you order a data plan and you also need to activate the plan immediately, the newly ordered plan will be

activated immediately. The secondary data plan ordered by the ota device does not support the immediate activation operation.

• If the data package is not ordered immediately, the iot system will not activate the package.

• For sheb traffic package orders ordered for equipment in the inventory period, if support for test traffic is required, it will be processed as the first order.

POST /cmp-api/package/batchOrderPackages

Body parameters

{
    "deviceList": [
        "89852022018041800192",
        "89852022018041800193"
    ],
    "is_open": "0",
    "package_code": "DP20190726001274",
    "subscribed_count": 10
}

Name	Schema	Required	Description
deviceList	list	true	Device identification node
package_code	string	true	Traffic Package Code
is_open	string	true	Whether to open this package immediately. For successful payment, allow it immediately; For unpaid orders, opening is not allowed, so be sure to judge the opening sign. Schedule package orders are not allowed to open; the secondary data package of ota equipment is not allowed to open immediately The values are as follows: 1-Open immediately; 0-disabled;
subscribed_count	Integer	false	If subscribed_count exceeds the allowed traffic pool limit, return: Traffic pool order count exceeds the allowable limit.

• The deviceList node is defined as follows:

Name	Schema	Required	Description
device_id	String	true	Device identification

Responses

{
  "code": "0000",
  "data": {
    "device_order": [
      {
        "error": "0000",
        "errorMsg": "success",
        "order_id": "ORDER_47454030993031168",
        "device_id": "89852022018041800192",
        "order_start_date": null,
        "order_expire_date": null
      },
      {
        "error": "0000",
        "errorMsg": "success",
        "order_id": "ORDER_47453927590854656",
        "device_id": "89852022018041800193",
        "order_start_date": null,
        "order_expire_date": null
      }
    ]
  },
  "message": "success",
  "success": true
}

Except for the code and message nodes, the business parameter part (that is, the data node) is specifically defined as follows:

Name	Description
Device_order	Each deviceResp node contains a batch ordering information;

• The Device_order node is defined as follows

Name	Description
order_id	The order id of the package. When the order is successful, that is, when red_code = 0000, change the field to take care
order_start_date	Package activation time, the format is:YYYYMMDD This field exists when requested to activate this package immediately when requested;
order_expire_date	The package is expected to expire in the format: YYYYMMDD This field exists when requested to activate this package immediately when requested;
Error	Response result
ErrorMsg	Response message
Device_id	Equipment Identity

Query package order

The access party can call this interface to query the equipment package order information of a certain enterprise. The query conditions are: order type (schedule package order, traffic package order), order status, order code, equipment type, equipment identification;

POST /cmp-api/package/queryOrder

Body parameters

{
    "device_id":null,
    "order_id":null,
    "order_status":null,
    "page_no":1,
    "page_size":3
}

Name	Schema	Required	Description
device_id	string	false	Device identification, the background performs fuzzy query according to the device identification
order_id	string	false	Order code. If the value is not empty, the query is performed in the background.
order_status	string	false	Order Status: 1- not enabled; 2- get started; 3- has ended or canceled; 5- suspended;
page_no	Integer	true	The requested page of the traffic package order information. If the value of this node is empty, it defaults to page 1.
page_size	Integer	true	The number of traffic package orders included on each page.If the value of this node is empty, the default is 20,the maximum value is 100.

Responses

{
    "code": "0000",
    "data": {
        "page": {
            "cur_page_no": 1,
            "page_size": 3,
            "total_count": 191,
            "total_pages": 64
        },
        "sign": "WJItqR1f5bXvHC2jyvysnS24MfI=",
        "package_order": [
            {
                "buyType": "2",
                "expireDate": "",
                "flow": "10",
                "orderCode": "ORDER_1595320587633311744",
                "orderStatus": "1",
                "orderDate": "20221123153722",
                "orderPeriod": "30",
                "packageCode": "DP20210322004206",
                "packageName": "10M-unlimited-speed-2years",
                "packageType": null,
                "usedFlow": "0",
                "flowUseRate": null,
                "orderUsedFlow": "0",
                "supplierCode": null,
                "refuelingPackageList": [],
                "hasTestFlow": "0",
                "profileList": null,
                "isFlowPlus": null,
                "deviceId": "89852202110293091394",
                "device_id": "89852202110293091394",
                "activeDate": "",
                "main_iccid": null
            }
        ],
        "package_order_num": 1
    },
    "message": "success",
    "success": true
}

In addition to the code and message nodes, it also contains the business node part (that is, the data node), as defined below:

Name	Description
package_order_num	The number of traffic package orders;If ret_info = 0000, the node information exists,
package_order	Each package_order node contains a traffic package order information; The number of package_order nodes in the response message must be the same as the value of package_order_num . If ret_info = 0000, the node information exists;
page	Pagination information for traffic package orders, so that the access system can determine whether all traffic package orders have been obtained. If ret_info = 0000, the node information exists

• The page node is defined as follows:

Name	Description
total_pages	total pages
cur_page_no	Current page number
total_count	Total traffic package orders
page_size	Number of traffic package orders included per page

• The package_order node is defined as follows:

parameter	Description	Is required	Types of
order_code	Package order code	required	String
device_id	Device identification code	required	String
package_name	Traffic package name	required	String
package_code	Traffic Package Code	required	String
package_type	1-day traffic package;2-month data plan;3-quarter traffic package;4-half year traffic package;5-year traffic package;	required	String
order_status	Order Status: 1- not enabled; 2- get started; 3- has ended or canceled; 5- suspended;	required
buy_type	Schedule package, this node is empty, purchase method:1- Prepaid Package: Refueling packages are allowed, the order period is fixed, and renewal is not allowed;2-Post-paid package: Refueling packages are not allowed, but you can order iteratively, for example: if it is a month, the selected subscription period can be n months. Renewal is allowed.	Optional	String
order_period	Subscription cycle of the package;	required
flow	Package traffic, unit: m bytes; schedule package, this node can be empty;	Optional
used_flow	The package uses traffic, which is defined as follows: If the package is a pre-paidpackage, it is the currently used traffic, the unit is kb; If the package is a postpaidpackage, it is the cumulative traffic used in the current subscription cycle unit. For example, if the package is a monthly package, it is the traffic used in the current month; if the package is a quarterly package, it is the traffic used in the current quarter; The value of this node in theschedule package is empty; Unit is kb	Optional	String
flow_use_rate	Traffic usage, the values are: used_flow / flow, as a percentage; The value of this node in the schedule package is empty;	Optional	String
order_used_flow	The order uses a total of total traffic; the unit is kb; the value of this node for the schedule package is empty;	Optional	String
order_date	Package order date, format is:YYYYMMDDhhmiss	required
active_date	Package activation date in the format: yyyymmdd This field is blank if the package has not been activated	required
expire_date	Package Expiry Date, format is:YYYYMMDD	required
	Whether the equipment is ordered with a fuel pack, the values are as follows:0- no refueling package ordered;1- order the refueling package;当 buy_type=1 时，即设备当前订购的是 预付费流量套餐，此字段存在，其他情况，不存在；	Optional
refueling_package_list	Refueling package information exists when is_order_ refueling_package = 1.	Optional	Xml

• The information contained in the refueling_package node is defined as follows:

parameter	Description	Is required	Types of
ref_orderId	Refueling Kit Order Code	required	String
refpackage_flow	Fuel package flow, unit: m bytes	required
refpackage_order_date	Order date, format: YYYY-MM-DD hh: mi: ss	required
refpackage_status	Refueling bag status, the values are as follows: 1: Not enabled; 2: Start to use; 3: Used up; 4: Canceled	required	String

Open data plan

The access party can call the interface to open the data package that was previously ordered.

POST /cmp-api/package/openPackage

Body parameters

{
    "order_id": "202107061625560742397"
}

parameter	Description	Is required	Types of
order_id	When ordering a data plan, the id of the data plan returned by the iot system;	required	String

Responses

{
    "code": "0000",
    "data": {
        "sign": "ZFfUancP56BywWwPu8BKlJFJOyo=",
        "order_id": "202107061625560742397",
        "order_start_date": "2022-01-27 11:23:43",
        "order_expire_date": "2023-11-27 23:59:59"
    },
    "message": "success",
    "success": true
}

In addition to the code and message nodes, it also contains the business node part (that is, the data node), as defined below:

parameter	Description	Is required	Types of
order_id	Subscription id of the data plan; When the activation is successful, that is, when ret_code = 0000, this field exists.	required	String
order_start _date	Data package activation time, the format is:YYYYMMDD；When the activation is successful, that is, when ret_code = 0000, this field exists.	Optional	String
order_expire_date	Data package is expected to expire in the format:YYYYMMDD；When the activation is successful, that is, when ret_code = 0000, this field exists.	Optional	String

Cancel package order

An access party can call this interface to cancel a previously ordered order. The prerequisite for cancellation is that the order has not been activated or has not been paid.

POST /cmp-api/package/cancelPackage

Body parameters

{
    "order_id": "202108011627816741391"
}

parameter	Description	Is required	Types of
order_id	When ordering a package, the iot system returns the package order id	required	String

Responses

In addition to the code and message nodes, it also contains the business node part (that is, the data node). Example response message:

{
    "code": "0000",
    "data": null,
    "message": "Success",
    "success": true
}

End package orders early

The access party can call the interface to end the subscription package in advance. The condition for early termination is that the order is enabled.

POST /cmp-api/package/aheadFinishDeviceOrder

Body parameters

{
    "ahead_finish_cause": "test",
    "device_type": "",
    "order_id": "202107061625560742397"
}

parameter	Description	Is required	Types of
device_type	Device type: 1-mifi; 2-module; 3- tour card; 4-IoT card; 5-soc	Optional	String
order_id	Order number to close early	required	String
ahead_finish_cause	Order end reason	required	String

Responses

{
    "code": "0000",
    "data": null,
    "message": "Success",
    "success": true
}

Query device information

Query device information based on the device ID, including lifecycle data and data related to active or paused orders.

POST /cmp-api/device/queryDevice

Body parameters

{
  "device_id": "89852202310161621656"
}

Name	Schema	Required	Description
device_id	string	true	Device identification code

Responses

{
  "code": "0000",
  "data": {
    "device_id": "89852202310161621656",
    "ota_flag": "2",
    "bip_flag": "2",
    "multiImsi_flag": "0",
    "lifecycle": "2",
    "lifecycle_start_time": "20231124",
    "lifecycle_end_time": "20240531",
    "lifecycle_slient_period": "6",
    "lifecycle_shutdown_period": "2",
    "package_order": {
      "orderCode": "ORDER_1727992973356523520",
      "packageName": "JP-UnLimited-Speed-30GB-Monthly",
      "packageCode": "LP14231124004197",
      "packageType": "2",
      "buyType": "2",
      "orderPeriod": "6",
      "flow": "30720",
      "usedFlow": "0",
      "flowUseRate": "0.00%",
      "orderUsedFlow": "19397607",
      "orderDate": "2023-11-24 18:10:04",
      "activeDate": "20231124",
      "expireDate": "20240531",
      "orderStatus": "2",
      "profileList": [
        {
          "iccid": "89852202310161621656",
          "imsi": "440039980621656",
          "msisdn": "FFFFFFFFFF"
        }
      ]
    }
  },
  "message": "success",
  "success": true
}

• The page node is defined as follows:

Name	Description
device_id	Device identification code
ota_flag	OTA feature flag: 1 - Has OTA functionality, 2 - Does not have OTA functionality.
bip_flag	BIP feature flag: 1 - Has BIP functionality, 2 - Does not have BIP functionality.
multiImsi_flag	Multiple IMSI feature flag : 1 - is a multi-IMSI device. 0 - is not a multi-IMSI device.
lifecycle	The current lifecycle stage of the device: 0 - Inventory period; 1 - Silent period; 2 - Usage period; 3 - Suspended service period; 4 - Disposal and recycling period; 5 - Internal inventory period.
lifecycle_start_time	Start date of the current lifecycle.
lifecycle_end_time	End date of the current lifecycle.
lifecycle_slient_period	The length of the silent period, typically 6 months.
lifecycle_shutdown_period	The length of the suspended service period, typically 2 months.
package_order	Each package_order node contains a traffic package order information（Only includes activated orders）

• The package_order node is defined as follows:

parameter	Description	Is required	Types of
order_code	Package order code	required	String
device_id	Device identification code	required	String
package_name	Traffic package name	required	String
package_code	Traffic Package Code	required	String
package_type	1-day traffic package;2-month data plan;3-quarter traffic package;4-half year traffic package;5-year traffic package;	required	String
order_status	Order Status: 1- not enabled; 2- get started; 3- has ended or canceled; 5- suspended;	required
buy_type	Schedule package, this node is empty, purchase method:1- Prepaid Package: Refueling packages are allowed, the order period is fixed, and renewal is not allowed;2-Post-paid package: Refueling packages are not allowed, but you can order iteratively, for example: if it is a month, the selected subscription period can be n months. Renewal is allowed.	Optional	String
order_period	Subscription cycle of the package;	required
flow	Package traffic, unit: m bytes; schedule package, this node can be empty;	Optional
used_flow	The package uses traffic, which is defined as follows: If the package is a pre-paidpackage, it is the currently used traffic, the unit is kb; If the package is a postpaidpackage, it is the cumulative traffic used in the current subscription cycle unit. For example, if the package is a monthly package, it is the traffic used in the current month; if the package is a quarterly package, it is the traffic used in the current quarter; The value of this node in theschedule package is empty; Unit is kb	Optional	String
flow_use_rate	Traffic usage, the values are: used_flow / flow, as a percentage; The value of this node in the schedule package is empty;	Optional	String
order_used_flow	The order uses a total of total traffic; the unit is kb; the value of this node for the schedule package is empty;	Optional	String
order_date	Package order date, format is:YYYYMMDDhhmiss	required
active_date	Package activation date in the format: yyyymmdd This field is blank if the package has not been activated	required
expire_date	Package Expiry Date, format is:YYYYMMDD	required

• The profileList node is defined as follows:

parameter	Description	Is required	Types of
iccid	The iccid associated with the order.	required	String
imsi	The imsi associated with the order.	required	String
msisdn	The msisdn associated with the order.	required	String

Get traffic pool info

POST /cmp-api/package/getTrafficPoolInfo

parameter	Description	Is required	Types of
page_no	default is 1	true	Integer
page_size	default is 20	false	Integer

Body parameters

{
  "page_no": 1,
  "page_size": 1
}

Responses

{
  "code": "0000",
  "data": {
    "rows": [
      {
        "totalQuotaByte": "107374182400",
        "usedByte": "0",
        "trafficPoolStartTime": "2025-10-30 00:00:00",
        "trafficPoolEndTime": "2025-11-10 23:59:59",
        "trafficPoolId": "CTP20251030APY9JB",
        "trafficPoolName": "pt客户流量池（Te）"
      }
    ],
    "total": 1
  },
  "message": "成功",
  "success": true
}

• The data node is defined as follows:

parameter	Description	Is required	Types of
totalQuotaByte	Total traffic quota	true	String
usedByte	Used traffic (unit: Byte)	true	String
trafficPoolStartTime	Customer traffic pool start time	true	String
trafficPoolStartTime	Customer traffic pool end time	true	String
trafficPoolId	Customer traffic pool ID	true	String
trafficPoolName	Customer traffic pool name	true	String