SMS

Retrieve SMS usage for all SIMs

get

Retrieves all usage information for SMS messages sent to and from devices across all SIMs. The response includes delivery status, attempt counts, and other usage metrics to help track SMS communication with your devices.

The response does not contain the actual payload/content of the SMSs, in order to get this information you will have to set up a Webhook endpoint or use the web app, see this article for more information.

Authorizations

bearerAuth

AuthorizationstringRequired

Query parameters

limitinteger · min: 1 · max: 1000Optional

Maximum number of SMS records to return

Default: 1000Example: 100

offsetintegerOptional

Number of records to skip (for pagination)

Default: 0Example: 10

timestampstring · dateOptional

Filter SMS records by ISO date (YYYY-MM-DD format)

Example: 2024-01-15Pattern: ^\d{4}-\d{2}-\d{2}$

orderstring · enumOptional

Temporal sort order for the results

Default: DESCExample: ASCPossible values:

Responses

200

OK

application/json

successbooleanOptionalExample: true

get

/sms/usage/

HTTPcURLJavaScriptPython

GET /sms/usage/ HTTP/1.1
Host: api.onomondo.com
Authorization: Bearer YOUR_API_KEY
Accept: */*

200

OK

{
  "data": [
    {
      "time": "2025-09-15T10:07:04.729Z",
      "sim_id": "000000001",
      "iccid": "89457300000000000011",
      "direction": "incoming",
      "status": "success",
      "retries_left": 9,
      "id": "aa9d092c-123c-4dcb-92eb-b8c10e56f336",
      "session_id": "40846632-46c6-3bdb-a432-83df2bb082d9",
      "network": {
        "mcc": "238",
        "mnc": "20"
      }
    },
    {
      "time": "2025-09-15T10:05:57.221Z",
      "sim_id": "000000002",
      "iccid": "89457300000000000021",
      "direction": "outgoing",
      "status": "success",
      "retries_left": 9,
      "id": "aebd97f8-e12d-4f2d-a497-3b354b37254a",
      "session_id": "505c0ee6-7f0a-43ab-be6b-3454c165e81d",
      "network": {
        "mcc": "238",
        "mnc": "20"
      }
    }
  ],
  "pagination": {
    "count": 2,
    "limit": 50,
    "offset": 0,
    "total": 2
  }
}

Retrieve SMS usage for a specific SIM

get

Retrieve all usage information for SMS messages sent to and from a specific device using its SIM ID. The response includes delivery status, attempt counts, and other usage metrics to help track SMS communication with your devices.

The response does not contain the actual payload/content of the SMSs, in order to get this information you will have to set up a Webhook endpoint or use the web app, see this article for more information.

Authorizations

bearerAuth

AuthorizationstringRequired

Path parameters

sim_idstringRequired

SIM ID

Example: 000000001

Query parameters

limitinteger · min: 1 · max: 1000Optional

Maximum number of SMS records to return

Default: 1000Example: 100

offsetintegerOptional

Number of records to skip (for pagination)

Default: 0Example: 10

timestampstring · dateOptional

Filter SMS records by ISO date (YYYY-MM-DD format)

Example: 2024-01-15Pattern: ^\d{4}-\d{2}-\d{2}$

orderstring · enumOptional

Temporal sort order for the results

Default: DESCExample: ASCPossible values:

Responses

200

OK

application/json

get

/sms/usage/{sim_id}

HTTPcURLJavaScriptPython

GET /sms/usage/{sim_id} HTTP/1.1
Host: api.onomondo.com
Authorization: Bearer YOUR_API_KEY
Accept: */*

200

OK

{
  "data": [
    {
      "time": "2025-09-15T10:07:04.729Z",
      "sim_id": "000000001",
      "iccid": "89457300000000000011",
      "direction": "incoming",
      "status": "success",
      "retries_left": 9,
      "id": "aa9d092c-123c-4dcb-92eb-b8c10e56f336",
      "session_id": "40846632-46c6-3bdb-a432-83df2bb082d9",
      "network": {
        "mcc": "238",
        "mnc": "20"
      }
    }
  ],
  "pagination": {
    "count": 1,
    "limit": 50,
    "offset": 0,
    "total": 1
  }
}

Send SMS to a device

post

Send SMS messages to a device using its SIM ID. Supports both text and binary SMS with different encoding options.

SMS Types:

• Text SMS: Standard text messages (default)

• Binary SMS: Raw binary data with hex or base64 encoding

For more information on the difference read How to send SMS using the Onomondo web app.

The response does not contain the actual payload/content of the SMSs, in order to get this information you will have to set up a Webhook endpoint or use the web app, see this article for more information.

Authorizations

bearerAuth

AuthorizationstringRequired

Path parameters

sim_idstringRequiredExample: 000000001

Body

application/json

fromone ofRequired

Sender identification - either numeric (up to 15 digits) or alphanumeric (up to 10 chars)

Example: devTeam

integer · max: 999999999999999Optional

Numeric sender ID (up to 15 digits)

or

stringOptional

Alphanumeric sender ID (1-10 characters, letters and numbers only)

Pattern: ^[a-zA-Z0-9]{1,10}$

typestring · enumOptional

Type of SMS message

Default: textPossible values:

encodingstring · enumOptional

Encoding format for binary SMS (required when type is 'binary')

Possible values:

textstringRequired

Message content. For text SMS, this is the actual message. For binary SMS, this is the encoded data (hex or base64).

Responses

200

OK

application/json

messagestringRequiredExample: ok

post

/sms/{sim_id}

HTTPcURLJavaScriptPython

POST /sms/{sim_id} HTTP/1.1
Host: api.onomondo.com
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "from": "devTeam",
  "text": "hello world!"
}

Simple text SMSBinary SMS with hexadecimal encodingBinary SMS with base64 encoding

200

OK

{
  "message": "ok"
}