Use new Signature v2 for APIs that have Sign2.0 tag

Get SIM Usage

Cube UAT

GET

https://api-uat.io.linksfield.net/cube/v4/sims/{sim_id}/usage

v1.0Usage

Last modified:2023-07-21 01:40:30

Description

Query the daily or monthly service usage of SIM within a specified period.

Version

v1.0

Notes

category :currently support: data.

period_type: daily/monthly

Daily: back track up to 60 days

Monthly: back track up to 6 months including current month

The CDRs may experience latency - the usage may change.

Only usage after 2023-01-01 is available.

Example

1：Query daily usage of 10/1/22.

2：Query monthly usage form 10/22 to 11/22.

Request

Path Params

sim_id

string

required

SIM ICCID

Example:

89852123456789012345

Query Params

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api-uat.io.linksfield.net/cube/v4/sims/89852123456789012345/usage?category=data&period_type=1&begin_from=2022-10-01&end_by=2022-10-01' \
--header 'nonce;' \
--header 'timestamp;' \
--header 'Accept-Language: en-US' \
--header 'Authorization;' \
--header 'X-LF-Api-Version;' \
--header 'X-LF-Signature-Type: 2.0' \
--header 'Content-Type: application/json'

Responses

🟢200Success

application/json

Body

data

object

required

sim_id

string

required

SIM card ICCID

usage

array [object {3}]

required

usage

status

object

required

code

string

required

message

string

required

detail

string | null

required

Example

{
  "data": {
    "sim_id": "89852123456789012345",
    "usage": [
      {
        "period": "2022-10-10",
        "updated_at": "2022-10-10 12:12:12",
        "data": {
          "all": "2222"
        }
      },
      {
        "period": "2022-10-9",
        "updated_at": "2022-10-10 12:12:12",
        "data": {
          "all": "2222"
        }
      }
    ]
  },
  "status": {
    "code": "CB-00-0000",
    "message": "Success",
    "detail": null
  }
}

Modified at 2023-07-21 01:40:30

Get SIM Usage

SMS

Get SIM Usage

Description#

Version#

Notes#

Example#

Request

Request samples

Responses

Description

Version

Notes

Example