Query Available Data Plans

Last Updated on : 2021-08-27 03:28:11download

Query the list of data plans available to the IoT SIM card currently, and query the information about the plan, such as the plan number, plan name, and card type.

API address

GET: /v1.0/iot-01/sim/{iccid}/package/usable

Request parameter

Parameter name Type IN Required Description
iccid String uri true The ID of a specified IoT SIM card.

Return parameter

Parameter name Type Description
result List

Description of result

Parameter name Type Description
package_id Long The ID of a specified plan.
package_name String The name of a specific plan.
resource_type String Indicates the data type. Valid values:
  • NB: the IoT SIM card that is billed by the number of times the card is used, such as the IoT card produced by SIMSKY.
  • TRAFFIC: the cellular card (4G) that is billed by the consumed data volume.
date_type String Indicates the plan type. Valid values:
  • NATURE_MONTH: calendar month.
  • DAY_MONTH: non-calendar month, consisting of natural days.
date_unit String Indicates the plan unit. Valid values:
  • MONTH: The plan is billed by month.
  • DAY: The plan is billed by day.
  • HOUR: The plan is billed by hour.
period Integer The consecutive periods of a specified plan.
unit String Indicates the plan data unit. Valid values:
  • MB: megabyte.
  • COUNT: the number of usage.
capacity Long The capacity of a specified plan.
operator_name String Indicates the plan carrier. Valid values:
  • CMCC: China Mobile.
  • CUCC: China Unicom.
  • CTCC: China Telecom.
  • 1NCE: Deutsche Telekom.

Request example

GET: /v1.0/iot-01/sim/898828066600005****/package/usable

Return example

{ "result": [ { "period": 1, "unit": "MB", "date_unit": "MONTH ", "date_type": "DAY_MONTH ", "package_id": 17, "operator_name": "CTCC", "package_name": "4G Telecom 500 MB/Month" "resource_type": "TRAFFIC", "capacity": 500 } ], "success": true, "t": 1626400573773 }

Error code

For more information, see error code.