Send SMS & SMS API (FT-1011.002)
About this document
Scope
This document provides background information as well as a functional description of the FT-1011.002 Send SMS & SMS API standard feature. The described feature is supported from the release version 4.0 onwards.
Note
Send SMS & SMS API is a standard feature and does not require a special license.
This feature is part of the functionality Account Self-Administration with the number FN-2001.
Feature Availability
Feature Version | Available from | Summary of changes |
---|---|---|
v1 | CMP Release 4.0 | Initial release |
v2 | CMP Release 5.0 | Send SMS via SMPP |
Feature overview
Goals
The aim of the Send SMS & SMS API feature is to allow sending SMS from the CMP to SIM Cards managed in the CMP.
The feature also provides the capability to send SMS via SMPP so that the existing CMP SendSMS API and/or Send SMS via Enterprise Portal can be used to send SMS to a subscriber.
Additionally, the feature allows to retrieve MO-AT (i.e., SMS sent from the device to CMP short code(s) from the SMSC) and to present them in the Enterprise Portal.
Out of scope
Changes to existing CMP SendSMS API
Changes to CMP SMS handling
Throttle mechanism for sending SMS
Queueing and retry mechanism to send SMS if there are connectivity issues
Retrieve of messages and delivery reports are not supported
Account level short codes for AO/AT SMS
Preconditions & Assumptions
The customer needs to provide appropriate SMPP Accounts, connectivity, etc. in order to do the SMPP integration
Existing SendSMS API will be used with no modification
CMP SendSMS API to be called by a 3rd party system or via Enterprise Portal
No additional functionality is required from CMP (i.e., no charging, filtering, etc. of SMS)
CMP will do a simple check that the SMS is allowed to be sent and no further validation of the request
Shortcode will be provided in the SendSMS API - CMP will not need to determine the correct shortcode to use
The feature requires SMPP integration into the operator SMSC
Functionality of the feature
Send SMS
CMP allows Enterprise Users to send SMS to one or more SIM Cards, that are managed in the CMP.
SMS can only be sent if the intended SIM has SMS MT services enabled via its assigned Service Profile and there is no Security Profile that would block the CMP as an SMS source
Sending an SMS can fail if the intended SIM doesn’t have SMS MT services enabled or there is a Security Profile that blocks the CMP as an SMS source.
Send SMS via SMPP
The SMS interface to be used by CMP to send an SMS is determined by the Network Interface and hence the Platform associated with the SIM. By using the Platform mechanism, CMP can be integrated into multiple SMSC via one or more REST API and/or SMPP integration, whilst being able to utilize the correct interface from the Network Interface associated with the SIM. In all instances, the SMSC or SMS Application Gateway will have allocated a shortcode for the originating party of the AO SMS.
For the SMSC integration, the NAL determines the behavior and rules required for SendSMS, and the NIL implements the network connectivity.
The SMPP connector implemented in CMP operates in client mode, i.e. sending only and it establishes and maintains the bind with the SMSC. As part of the retry mechanism, the connector will periodically try to establish a session and make a bind. In case the SMPP bind is down, SendSMS requests will be rejected.
SMS Content Encryption
The CMP configuration item, SMS-CONTENT-ENCRYPTION, controls the behavior of SMS content encryption. This configuration defines whether received and sent SMS messages have to be stored encrypted or as plain text. This also includes the transfer of the SMS content on CMP internal channels. By default, it is set to false.
When SMS-CONTENT-ENCRYPTION is set to true, all received SMS content will be encrypted when received via the SMPP interface or through the sendSMS API. Further, all SMS sent via CMP will be encrypted as well.
Account Users will see SMS content in clear text in the EP, while Operator Users will see the SMS content displayed as encrypted.
Note that CSP Users in Account context are not Account Users.