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
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
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/
200

OK

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
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
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}
200

OK

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
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
sim_idstringRequiredExample: 000000001
Body
anyOptional
Responses
200

OK

application/json
post
/sms/{sim_id}
200

OK

Last updated