SMS API introduction

The SMS API enables you to send and receive text and short messages to and from SMS-capable devices over internet and cellular networks. The SMS API ensures the message is compatible for network delivery. It also notifies the sender about the message status, so that you can track if the message was delivered or not.

You can route either or both of the following types of SMS API messages:

  • Mobile Terminated (MT) SMS messages from your server to a SIM, which can receive a delivery receipt in response.

  • Mobile Originated (MO) messages from a SIM to your server, which can also receive a delivery receipt in response.

You can exchange SMS messages with both AnyNet SIMs and third party SIMs. However, SMS messages sent to and received from third party SIMs will incur extra costs. For information about SMS API billing, see Understanding SMS charges on the CSV invoice.

Before you begin

Eseye will onboard you when you subscribe to SMS API.

You will need:

  • A SIAM account, with all your AnyNet SIMs linked to this account.
  • SMS whitelist – contains a list of permissible MSISDNs for mobile originated (MO) and mobile terminated (MT) messages. Messages sent to or received from these MSISDNs are processed.
  • SMS blacklist – contains a list of banned MSISDNs for MO and MT messages. Messages sent to or received from these MSISDNs are blocked.
  • Optional server IP address whitelist – contains a list of permissible IP addresses that can make incoming requests.
  • Mobile Originated (MO) URL – where the SMS API will post incoming MO messages.
  • Receipt URL – where the SMS API will post delivery receipts.

Eseye will provide you with the following:

  • SMS API account username.
  • SMS API account password.
  • SMS API destination MSISDN that is routed to SMS API.

Eseye does not supply historic data. You must store any data you want to retain.

Accessing the API

Use the following URL to access the latest version of the SMS API:

  • https://messaging.eseye.com/<request>/index/post

    where <request> is the SMS API request.