5.15 MsisdnLessMoSms API

29.1223GPPRelease 18T8 reference point for Northbound APIsTS

5.15.1 Overview

The MsisdnLessMoSms API allows the delivery of MSISDN-less mobile originated SMSs from the SCEF to the SCS/AS. The corresponding JSON schema for the representation of the resources and operations defined by the MsisdnLessMoSms API is provided in its complete form in Annex A.15.

5.15.2 Data model

5.15.2.1 Notification data types

5.15.2.1.1 Introduction

This clause defines data structures to be used in notifications.

Table 5.15.2.1.1-1 specifies data types re-used by the MsisdnLessMoSms API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the MsisdnLessMoSms API.

Table 5.15.2.1.1-1: MsisdnLessMoSms API re-used Data Types

Data type	Reference	Comments
SupportedFeatures	3GPP TS 29.571 [45]	Used to negotiate the applicability of the optional features defined in table 5.15.4-1.

Table 5.15.2.1.1-2 specifies the data types defined for the MsisdnLessMoSms API.

Table 5.15.2.1.1-2: MsisdnLessMoSms API specific Data Types

Data type	Clause defined	Description	Applicability
MsisdnLessMoSmsNotification	5.15.2.1.2	Represents a MSISDN-less MO SMS notification.
MsisdnLessMoSmsNotificationReply	5.15.2.1.3	Represents a reply to a MSISDN-less MO SMS notification.

5.15.2.1.2 Type: MsisdnLessMoSmsNotification

This data type represents a MSISDN-less MO SMS, which is sent from the SCEF to the SCS/AS.

Table 5.15.2.1.2-1: Definition of type MsisdnLessMoSmsNotification

Attribute name	Data type	Cardinality	Description	Applicability (NOTE)
supportedFeatures	SupportedFeatures	1	Used to negotiate the supported optional features of the API as described in clause 5.2.7.
sms	Bytes	1	The MSISDN-less MO SMS containing a short message transfer protocol data unit (TPDU) which is defined in 3GPP TS 23.040 [43] and represents the user data field carried by the short message service relay sub-layer protocol.
externalId	string	1	External identifier has the form username@realm.
applicationPort	Port	1	Unsigned integer used to uniquely identify the triggering application addressed in the device, see clause 9.2.3.24.4 in TS 23.040 [43] for further details.
NOTE: Properties marked with a feature as defined in clause 5.15.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features.

5.15.2.1.3 Type: MsisdnLessMoSmsNotificationReply

This data type represents a reply to an MSISDN-less MO SMS notification and is sent from the SCS/AS to the SCEF.

Table 5.15.2.1.3-1: Definition of type MsisdnLessMoSmsNotificationReply

Attribute name	Data type	Cardinality	Description	Applicability (NOTE)
supportedFeatures	SupportedFeatures	1	Used to negotiate the supported optional features of the API as described in clause 5.2.7.
NOTE: Properties marked with a feature as defined in clause 5.3.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features.

5.15.3 Resource structure

5.15.3.1 General

All resource URIs of this API should have the following root:

{notificationDestination}

"{notificationDestination}" is determined based on preconfigured information in the SCEF as described in clause 4.4.14.2. All resource URIs in the clauses below are defined relative to the above root URI.

The following resources and HTTP methods are supported for this API:

Table 5.15.3.1-1: Resources and methods overview

Resource name	Resource URI	HTTP method	Meaning
MSISDN-less MO SMS Notification	{notificationDestination}	POST	Deliver a received MSIDN-less MO SMS from the SCEF to the SCS/AS

5.15.3.2 MSISDN-less MO SMS Notification

5.15.3.2.1 Introduction

The MSISDN-less MO SMS Notification allows the SCEF to deliver a received MSIDN-less MO SMS to the SCS/AS.

5.15.3.2.2 Resource definition

The Callback URI: {notificationDestination} shall support the callback URI variables defined in table 5.15.3.2.2-1.

Table 5.15.3.2.2-1: Callback URI variables for resource "MSISDN-less MO SMS Notification"

Name	Data type	Definition
notificationDestination	Link	A URI indicating the notification destination where T8 notification requests shall be delivered to. This URI shall be preconfigured in the SCEF.

5.15.3.2.3 Standard methods

5.15.3.2.3.1 Notification via POST

The HTTP POST method delivers a received MSISDN-less MO SMS. The SCEF shall initiate the HTTP POST request message and the SCS/AS shall respond to the message.

This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.15.3.2.3.1-1 and table 5.15.3.2.3.1-2.

Table 5.15.3.2.3.1-1: URI query parameters supported by the POST method on this resource

Name	Data type	Cardinality	Remarks
none specified

Table 5.15.3.2.3.1-2: Data structures supported by the POST request/response by the resource

Request body	Data type	Cardinality	Remarks
	MsisdnLessMoSmsNotification	1	The MSISDN-less MO SMS.
Response body	Data type	Cardinality	Response codes	Remarks
	MsisdnLessMoSmsNotificationReply		200 OK	The MSISDN-less MO SMS is received successfully.
	none	0..1	307 Temporary Redirect	Temporary redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent. Redirection handling is described in clause 5.2.10.
	none	0..1	308 Permanent Redirect	Permanent redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent. Redirection handling is described in clause 5.2.10.
NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply.

Table 5.15.3.2.3.1-3: Headers supported by the 307 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected.

Table 5.15.3.2.3.1-4: Headers supported by the 308 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected.

5.15.4 Used Features

The table below defines the features applicable to the MsisdnLessMoSms API. Those features are negotiated as described in clause 5.2.7.

Table 5.15.4-1: Features used by MsisdnLessMoSms API

Feature Number	Feature	Description
Feature: A short name that can be used to refer to the bit and to the feature, e.g. "Notification". Description: A clear textual description of the feature.

5.15.5 Error handling

5.15.5.1 General

HTTP error handling shall be supported as specified in clause 5.2.6.

In addition, the requirements in the following clauses shall apply.

5.15.5.2 Protocol Errors

In this Release of the specification, there are no additional protocol errors applicable for the MsisdnLessMoSms API.

5.15.5.3 Application Errors

The application errors defined for MsisdnLessMoSms API are listed in table 5.15.5.3-1.

Table 5.15.5.3-1: Application errors

Application Error	HTTP status code	Description	Applicability