ShortMessageService SMS API Description

API Description

The SMS (Short Message Service) API enables enterprises and applications to send SMS messages to designated recipients via a mobile network operator. This API supports three categories of SMS: Service, promotional, and transactional messages. It facilitates the delivery of SMS messages while ensuring compliance with network requirements.

Key Features

• Send SMS: Enables the transmission of SMS messages to a specified destination address.

• Support for Multiple SMS Types: Allows sending of service, promotional, and transactional SMS.

• Enterprise Onboarding: Requires enterprises or applications to onboard with the access provider before using the API.

• Future Extension for Delivery Receipts: The API consumer must implement a separate callback API to receive SMS delivery receipts.

Use Cases

Use Case 1: Send text SMS from an application

Summary: As an application developer, I want to send text SMS from my application to designated recipients via a mobile network operator.

Roles, Actors, and Scope:

• Roles: Application server (developer’s backend system)

• Actors:

  • SMS API Consumer: Application server, mobile app, machine

  • SMS API Provider: Mobile Network Operator (MNO), hyperscalers

  • SMS Destination: Mobile device, machine

• Scope: Sending text SMS to one or multiple recipients.

Pre-conditions:

• The SMS sender (enterprise or application) must be onboarded with the access provider.

• The SMS sender must have valid API credentials.

Activities/Steps:

• The customer application server makes an API request to send an SMS.

• The request is processed, and the SMS is sent to the specified recipient.

• The recipient receives the SMS.

Post-conditions:

• The SMS is successfully delivered to the recipient.

Use Case 2: Send Binary SMS Message to a Communication Module

Summary: As an application developer, I want to send binary SMS messages containing control commands to a remote (IoT) device.

Roles, Actors, and Scope:

• Roles: Application developer

• Actors:

  • Mobile Network Operators (MNOs)

  • Hyperscalers

  • Application developers

  • Enterprises

• Scope: Sending binary SMS to a communication module in a remote device.

Pre-conditions:

• The application developer must be onboarded with the MNO API.

• The application developer must have valid API credentials.

• MNO has enabled sending SMS to a remote device.

Activities/Steps:

• The customer application server sends a request to the SMS API with a binary SMS message.

• The request is processed, and the binary SMS is sent to the remote device.

Post-conditions

• Binary SMS is delivered successfully to the remote device.

Benefits

• Seamless Integration: The API enables enterprises and applications to easily integrate SMS services into their systems.

• Flexible Message Categories: Supports various SMS types (service, promotional, and transactional), making it adaptable to different business needs.

• Enterprise-Ready: Ensures secure onboarding and authentication, enhancing reliability.

• Support for IoT and Machine Communication: Facilitates sending binary SMS for remote device control.

API Portfolio: Communication Services

SubProject Wiki: N/a, Independent Sandbox, See API Wiki
(incl. how to meet the team)

API Wiki: Short Message Service

API Repository: Short Message Service

API Repository Status: Sandbox

API Status: In progress

API Version(s) and Release Date(s):

• In progress

API availability: Information which APIs are available in which country and network, and how to get access can be found on the GSMA public launch status page.