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

List all SMS by SIM ID (MO)

Developing

Cube UAT

https://api-uat.io.linksfield.net/cube/v4

GET

/sms/mo/{sim_id}

Last modified:2023-08-04 07:59:59

Description

Retrieve list of SMS(MO P2A) sent from the SIM

Version：

v1.0
Sign2.0

Notes:

SMS records are kept for 180 days at most

SIM IDs provided must belong to the organisation of the request

By default ( if not present), the query time period is 7 days prior to the request

Request

Path Params

sim_id

string

required

SIM ICCID

Example:

89852123456789012345

Query Params

begin_from

string

optional

Long, Epoch timestamp UTC 0 in millisecond, default value is 7 days from the current time

Example:

1677116671000

end_by

string

optional

Long, Epoch timestamp UTC 0 in millisecond, default current time

Example:

1677116890000

page_no

integer

optional

default 1

Example:

page_size

integer

optional

1-100, default 100

Example:

100

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

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/sms/mo/89852123456789012345?begin_from=1677116671000&end_by=1677116890000&page_no=1&page_size=100' \
--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

array[object (MO) {5}]

required

org_id

string

required

sim_id

string

required

SIM ICCID

msisdn

string

optional

received_at

integer

required

Long, Epoch time UTC0 in millisecond

message

object

required

status

object

required

code

string

required

message

string

required

detail

string | null

required

total_count

integer

required

Examples

SuccessSuccess - No Data

{
    "data": [
        {
            "org_id": "P001234",
            "sim_id": "89852123456789012345",
            "msisdn": "877676774564564",
            "received_at": 1640917845984,
            "message": {
                "type": 1,
                "content": "test"
            }
        }
    ],
    "status": {
        "code": "CB-00-0000",
        "message": "Success",
        "detail": null
    },
    "total_count": 111
}

🟢200success

Modified at 2023-08-04 07:59:59

List all SMS by Job ID (MT)

CDR

List all SMS by SIM ID (MO)

Description#

Version：#

Notes:#

Request

Request samples

Responses

Description

Version：

Notes: