SMSCommand Resource

Exchange machine-to-machine (M2M) messages via SMS

Super SIM's SMS Commands API is currently in Public Beta. Some features are not yet implemented and others may be changed before the product is declared as Generally Available.

To avoid ambiguity throughout this page, Sim (initial cap) refers to the Sim API resource. SIM (all caps) refers to the physical Subscriber Identity Module (that is, a SIM card) represented by a Sim resource.

SMS Commands enable you to exchange machine-to-machine (M2M) messages with devices over SMS. In order to use SMS Commands, devices must be capable of receiving and sending SMS messages. The SIM does not require an addressable phone number to send or receive a SMS Command. SMS Commands have a maximum length of 160 single-byte characters.

If you'd like to try SMS Commands out straight away, check out our Get Started guide. Or read on for the full API documentation.

SMS Commands to SIM (Mobile Terminated)

SMS Commands sent to your device, also known as Mobile Terminated (MT) SMS Commands, are initiated by making a POST request to the SMS Commands API endpoint:

https://supersim.api.korewireless.com/v1/SmsCommands

The SMS will be sent to your SIM asynchronously. When the SMS Command API is invoked to send an SMS Command to your device, a SMS Command resource will be created with status queued. Learn more about the SMS Command states in the Status section below.

The SMS received by your device will always come from the number 000. There is no publicly addressable phone number for your Super SIM meaning that you cannot send an SMS to it from another device. The only way to reach it via SMS is by using the SMS Commands API.

The SMS Commands API will continue to attempt to send an SMS to your Super SIM-connected device for up to 24 hours. This is to account for cases where your device has not yet come online when your request to send an SMS Command was submitted. The status of the SMS Command resource will remain as queued until the first attempt to send it, after which its status will become sent. The command's status will change to delivered once there its delivery has been confirmed. If there is no delivery confirmation within the 24-hour period, the status will stay sent.

You can receive status change notifications by providing a callback URL and method in your POST request. You will receive an HTTP request to that callback URL each time the command's status changes.

SMS Commands from SIM (Mobile Originated)

All SMS sent from your device to 000 will be treated as SMS Commands. The status for all Mobile Originated (MO) SMS Commands will always be received.

You can be automatically notified when an SMS is received from your Super SIM connected device by configuring the sms_commands_url and sms_commands_method properties of the Fleet resource to which the Sim resource has been assigned. When your Super SIM-connected device sends an SMS message to the reserved number 000, an SMS Command resource will be created and your Fleet resource's sms_commands_url will be sent a notification. The request made to your URL will include the same parameters as the SMS Commands Status Callback.

Currently all SMS, regardless of the number to which they were sent, are treated as SMS Commands, not just those sent to 000. This may change in the future. To ensure that there is no interruption to your services if this changes, all SMS you wish to be treated as Commands should be sent to 000.

Asynchronous resource

The SMS Command resource performs asynchronous operations. To receive an asynchronous notification when a SMS Command resource has finished updating, provide a callback URL, and optionally a callback method parameter, when you create the SMS Command.

API Authorization

Before you can make requests to this resource, you must have a valid bearer token. Review our API authorization guide to learn how to generate a token. Here's a curl example on how to define your access token in a header:

curl -X GET \
-H "Authorization: Bearer <YOUR_ACCESS_TOKEN>" \
'https://supersim.api.korewireless.com/v1/Sims'

The examples below do not show the required Authorization header due to a bug. We're working on fixing that. In the meantime, be sure to include that in all of your requests.

Create an SmsCommand Resource

Send SMS Command to a Sim.

POSThttps://supersim.api.korewireless.com/v1/SmsCommands

Authorization

Body

Sim*string

The sid or unique_name of the SIM to send the SMS Command to.

Payload*string

The message body of the SMS Command.

CallbackMethodenum

The HTTP method we should use to call callback_url. Can be: GET or POST and the default is POST.

GETPOST

CallbackUrlstring (uri)

The URL we should call using the callback_method after we have sent the command.

Response

Created

Headers

Body

sidnullable string

The unique string that we created to identify the SMS Command resource.

Pattern: ^HC[0-9a-fA-F]{32}$

account_sidnullable string

The SID of the Account that created the SMS Command resource.

Pattern: ^AC[0-9a-fA-F]{32}$

sim_sidnullable string

The SID of the SIM that this SMS Command was sent to or from.

Pattern: ^HS[0-9a-fA-F]{32}$

payloadnullable string

The message body of the SMS Command sent to or from the SIM. For text mode messages, this can be up to 160 characters.

statussms_command_enum_status (enum)

queuedsentdeliveredreceivedfailed

directionsms_command_enum_direction (enum)

to_simfrom_sim

date_creatednullable string (date-time)

The date and time in GMT when the resource was created specified in ISO 8601 format.

date_updatednullable string (date-time)

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

urlnullable string (uri)

The absolute URL of the SMS Command resource.

Request

const response = await fetch('https://supersim.api.korewireless.com/v1/SmsCommands', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "Payload": "checkin: firmware update",
      "Sim": "SimSidOrUniqueName"
    }),
});
const data = await response.json();

Response

{
  "sid": "text",
  "account_sid": "text",
  "sim_sid": "text",
  "payload": "text",
  "status": "queued",
  "direction": "to_sim",
  "date_created": "2024-11-21T08:53:00.110Z",
  "date_updated": "2024-11-21T08:53:00.110Z",
  "url": "https://example.com"
}

Fetch an SmsCommand Resource

Fetch SMS Command instance from your account.

GEThttps://supersim.api.korewireless.com/v1/SmsCommands/{Sid}

Authorization

Path parameters

Sid*string

The SID of the SMS Command resource to fetch.

Pattern: ^HC[0-9a-fA-F]{32}$

Response

Headers

Body

sidnullable string

The unique string that we created to identify the SMS Command resource.

Pattern: ^HC[0-9a-fA-F]{32}$

account_sidnullable string

The SID of the Account that created the SMS Command resource.

Pattern: ^AC[0-9a-fA-F]{32}$

sim_sidnullable string

The SID of the SIM that this SMS Command was sent to or from.

Pattern: ^HS[0-9a-fA-F]{32}$

payloadnullable string

The message body of the SMS Command sent to or from the SIM. For text mode messages, this can be up to 160 characters.

statussms_command_enum_status (enum)

queuedsentdeliveredreceivedfailed

directionsms_command_enum_direction (enum)

to_simfrom_sim

date_creatednullable string (date-time)

The date and time in GMT when the resource was created specified in ISO 8601 format.

date_updatednullable string (date-time)

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

urlnullable string (uri)

The absolute URL of the SMS Command resource.

Request

const response = await fetch('https://supersim.api.korewireless.com/v1/SmsCommands/{Sid}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "sid": "text",
  "account_sid": "text",
  "sim_sid": "text",
  "payload": "text",
  "status": "queued",
  "direction": "to_sim",
  "date_created": "2024-11-21T08:53:00.110Z",
  "date_updated": "2024-11-21T08:53:00.110Z",
  "url": "https://example.com"
}

Read multiple SmsCommand Resources

Retrieve a list of SMS Commands from your account.

GEThttps://supersim.api.korewireless.com/v1/SmsCommands

Authorization

Query parameters

Response

Headers

Body

sms_commandsarray of supersim.v1.sms_command (object)

metaobject

Request

const response = await fetch('https://supersim.api.korewireless.com/v1/SmsCommands', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "sms_commands": [
    {
      "sid": "text",
      "account_sid": "text",
      "sim_sid": "text",
      "payload": "text",
      "status": "queued",
      "direction": "to_sim",
      "date_created": "2024-11-21T08:53:00.110Z",
      "date_updated": "2024-11-21T08:53:00.110Z",
      "url": "https://example.com"
    }
  ],
  "meta": {
    "first_page_url": "https://example.com",
    "key": "text",
    "next_page_url": "https://example.com",
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  }
}

Status Values

When the API is used to send an SMS to your device, the SMS Command resource status will be set to the statues queued. The Status property will be updated to sent when an SMS is sent from KORE to the cellular network to which your device is connected (the 'visited' network). If a delivery receipt (DLR) is received from your device, the status will be updated to delivered. If at any point this process fails and the Command is no longer deliverable, the status will be updated to failed and an error code will be indicated on the resource.

queued

The SMS Command is queued in our network waiting to be sent.

sent

The SMS Command has been sent to the SIM.

delivered

The SMS Command has been delivered to the SIM and there was a delivery confirmation from the device.

received

The SMS Command has been received from the SIM.

failed

The SMS Command could not be sent.

SMS Command resource status callbacks

You can provide a callback method and callback URL to receive updates each time a SMS Command to your device's status changes. The request should look similar to the following using curl:

curl -L -X POST "https://supersim.api.korewireless.com/v1/SmsCommands" \
--header "Authorization: Bearer <YOUR_AUTH_TOKEN>" \
--data-urlencode "Payload={\"enable\":\"True\", \"reset\":\"False\",\"when\":\"Immediate\"}" \
--data-urlencode "Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
--data-urlencode "CallbackUrl=<YOUR_CALLBACK_URL>" \
--data-urlencode "CallbackMethod=GET"

{
"account_sid":"ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"sid":"HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"payload":"{\"enable\":\"True\", \"reset\":\"False\",\"when\":\"Immediate\"}",
"sim_sid":"HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"direction":"to_sim",
"status":"queued",
"date_created":"2024-10-24T20:12:17Z",
"date_updated":"2024-10-24T20:12:17Z",
"url":"https://supersim.api.korewireless.com/v1/SmsCommands/HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

Status sent
ApiVersion v1
Payload {"enable":"True", "reset":"False","when":"Immediate"}
SimUniqueName Parking-Meter-Lot-Area-001
SimSid HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
CommandSid HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
Direction to_sim
AccountSid ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
PayloadType text

The request sent to the callback URL contains the following properties:

AccountSid

The SID of the Account that the SMS Command resource belongs to. For example: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa See: What are SIDs and their prefixes?

CommandSid

The unique string that we created to identify the SMS Command resource. For example: HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa

SimSid

The receiving Super SIM's SID. For example: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa

SimUniqueName

The receiving Super SIM's UniqueName. For example: Parking-Meter-Lot-Area-001

Payload

The body of the SMS Command message. This value can be up to 160 characters of text. Binary mode is not supported. For example: {"enable":"True", "reset":"False","When":"Immediate"}

PayloadType

text mode by default. Binary mode is not supported.

Direction

Indicates whether the Command is MT or MO. It has two possible values: to_sim or from_sim.

Status

The delivery status of the SMS Command. See: Status Values

ErrorCode

The error code (if any) associated with a failed SMS Command. Unless the status is failed, ErrorCode will not be present.

ErrorMessage

A description of the error (if any) associated with a failed SMS Command. Unless the status is failed, ErrorMessage will not be present.

Retention Period

SMS Commands are retained for 30 days from the time they are created. SMS Commands older than 30 days will no longer be readable from this resource.

PreviousUsage Record Resource NextIPCommand Resource

Last updated 8 days ago