6 Services offered by the Message Gateway

29.5383GPPApplication Programming Interfaces (API) specificationEnabling MSGin5G ServiceRelease 18Stage 3TS

Tools: ARFCN - Frequency Conversion for 5G NR/LTE/UMTS/GSM

6.1 Introduction

The Table 6.1-1 lists the services provided by the MSGin5G Message Gateway and corresponding service operations. A service description clause for each API gives a general description of the related API.

Table 6.1-1 List of services provided by the MSGin5G Message Gateway

Service Name	Service Operations	Operation Semantics	Example Consumer(s)
MSGG_L3GDelivery	MSGG_L3GDelivery_GTDelivery	Request/Response	MSGin5G Server
	MSGG_L3GDelivery_GTDeliveryReport
MSGG_N3GDelivery	MSGG_N3GDelivery_GTDelivery	Request/ Response	MSGin5G Server
	MSGG_N3GDelivery_GTDeliveryReport

Table 6.1-2 summarizes the corresponding APIs defined in this specification.

Table 6.1-2: API Descriptions

Service Name	Clause	Description	OpenAPI Specification File	apiName	Annex
MSGS_L3GDelivery	9.1	L3G Message Delivery Service	TS29538_MSGG_ L3GDelivery.yaml	msgg-l3gdelivery	A.4
MSGS_N3GDelivery	9.2	N3G Message Delivery Service	TS29538_MSGG_ N3GDelivery.yaml	msgg-n3gdelivery	A.5

6.2 MSGG_L3GDelivery Service

6.2.1 Service Description

The MSGG_L3GDelivery Service corresponding to Ml3g as defined in 3GPP TS 23.554 [2], is provided by the Legacy 3GPP Message Gateway.

This service:

– allows MSGin5G Server invokes services provided by Legacy 3GPP Message Gateway to send MSGin5G Messages to Legacy 3GPP Message Gateway.

6.2.2 Service Operations

6.2.2.1 Introduction

The service operation defined for MSGG_L3GDelivery Service is shown in the table 6.2.2.1-1.

Table 6.2.2.1-1: Operations of the MSGG_L3GDelivery Service

Service operation name	Description	Initiated by
MSGG_L3GDelivery_GTDelivery	This service operation is used by MSGin5G Server to deliver MSGin5G message to Legacy 3GPP Message Gateway. This service operation corresponds to clause 9.2.1.1.2 as defined in 3GPP TS 23.554 [2].	MSGin5G Server
MSGG_L3GDelivery_GTDeliveryReport	This service operation is used by MSGin5G Server to deliver the delivery status report to Legacy 3GPP Message Gateway. This service operation corresponds to clause 9.2.1.3.2 as defined in 3GPP TS 23.554 [2].	MSGin5G Server

6.2.2.2 MSGG_L3GDelivery_GTDelivery

6.2.2.2.1 General

This service operation corresponds to clause 9.2.1.1.2 as defined in 3GPP TS 23.554 [2], is used by MSGin5G Server to deliver MSGin5G message to the Legacy 3GPP Message Gateway.

6.2.2.2.2 Legacy 3GPP Message Gateway Terminating Message Delivery

Figure 6.2.2.2.2-1: Legacy 3GPP Message Gateway Terminating Message Delivery

When the MSGin5G Server needs to send the message to the Legacy 3GPP Message Gateway, the MSGin5G Server shall send the HTTP POST request towards the "deliver-message" resource as shown in Figure 6.2.2.2.2-1.

The MSGin5G Server shall send a POST request to the resource with an L3gMessageDelivery object in the request body.

The L3gMessageDelivery data type shall include:

– the Originating UE Service ID/AS Service ID within the "oriAddr" attribute;

– the Recipient UE Service ID within the "destAddr" attribute;

– the Message ID within the "msgId" attribute; and

may include:

– the Application ID within the "appId" attribute;

– the indication whether the message delivery status report is required within the "delivStReqInd" attribute;

– the Payload within the "payload" attribute;

– the Message is segmented within the "segInd" attribute; and

– the message segment parameters within the "segParams" attribute, this attribute may include:

– the segmentation set identifier within the "segId" attribute;

– the total number of message segments within the "totalSegCount" attribute;

– the message segment number within the "segNumb" attribute; and

– the last segment flag within the "lastSegFlag" attribute.

When the Legacy 3GPP Message Gateway receives the HTTP POST request from the MSGin5G Server, the Legacy 3GPP Message Gateway shall respond to the MSGin5G Server with a 204 No Content message.

If errors occur when processing the HTTP POST request, the Legacy 3GPP Message Gateway shall apply error handling procedures as specified in clause 9.1.6.

6.2.2.3 MSGG_L3GDelivery_GTDeliveryReport

6.2.2.3.1 General

This service operation corresponds to clause 9.2.1.3.2 as defined in 3GPP TS 23.554 [2], is used by MSGin5G Server to deliver the delivery status report to the Legacy 3GPP Message Gateway.

6.2.2.3.2 Legacy 3GPP Message Gateway Terminating Message Delivery Status Report

Figure 6.2.2.3.2-1: Legacy 3GPP Message Gateway Terminating Delivery Status Report

When the MSGin5G Server needs to send the delivery status report to the Legacy 3GPP Message Gateway, the MSGin5G Server shall send the HTTP POST request towards the "deliver-report" resource as shown in Figure 6.2.2.3.2-1.

The MSGin5G Server shall send a POST request to the resource with a DeliveryStatusReport object in the request body.

The DeliveryStatusReport data type shall include:

– the Originating UE Service ID/AS Service ID within the "oriAddr" attribute;

– the Recipient UE Service ID within the "destAddr" attribute;

– the Message ID within the "msgId" attribute;

– the delivery status within the "delivSt" attribute; and

may include:

– the failure cause within the "failureCause" attribute.

When the Legacy 3GPP Message Gateway receives the HTTP POST request from the MSGin5G Server, the Legacy 3GPP Message Gateway shall respond to the MSGin5G Server with a 204 No Content message.

If errors occur when processing the HTTP POST request, the Legacy 3GPP Message Gateway shall apply error handling procedures as specified in clause 9.1.6.

6.3 MSGG_N3GDelivery Service

6.3.1 Service Description

The MSGG_N3GDelivery Service corresponding to Mn3g as defined in 3GPP TS 23.554 [2], is provided by the Non-3GPP Message Gateway.

This service:

– allows MSGin5G Server invokes services provided by Non-3GPP Message Gateway to send MSGin5G Messages to Non-3GPP Message Gateway.

6.3.2 Service Operations

6.3.2.1 Introduction

The service operation defined for MSGG_N3GDelivery Service is shown in the table 6.3.2.1-1.

Table 6.3.2.1-1: Operations of the MSGG_N3GDelivery Service

Service operation name	Description	Initiated by
MSGG_N3GDelivery_GTDelivery	This service operation is used by MSGin5G Server to deliver MSGin5G message to Non-3GPP Message Gateway. This service operation corresponds to clause 9.2.2.1.2 as defined in 3GPP TS 23.554 [2].	MSGin5G Server
MSGG_N3GDelivery_GTDeliveryReport	This service operation is used by MSGin5G Server to deliver the delivery status report to Non-3GPP Message Gateway. This service operation corresponds to clause 9.2.2.2.2 as defined in 3GPP TS 23.554 [2].	MSGin5G Server

6.3.2.2 MSGG_N3GDelivery_GTDelivery

6.3.2.2.1 General

This service operation corresponds to clause 9.2.2.1.2 as defined in 3GPP TS 23.554 [2], is used by MSGin5G Server to deliver MSGin5G message to the Non-3GPP Message Gateway.

6.3.2.2.2 Non-3GPP Message Gateway Terminating Message Delivery

Figure 6.3.2.2.2-1: Non-3GPP Message Gateway Terminating Message Delivery

When the MSGin5G Server needs to send the message to the Non-3GPP Message Gateway, the MSGin5G Server shall send the HTTP POST request towards the "deliver-message" resource as shown in figure 6.3.2.2.2-1.

The MSGin5G Server shall send a POST request to the resource with an N3gMessageDelivery object in the request body.

The N3gMessageDelivery data type shall include:

– the Originating UE Service ID/AS Service ID within the "oriAddr" attribute;

– the Recipient UE Service ID within the "destAddr" attribute;

– the Message ID within the "msgId" attribute; and

may include:

– the Application ID within the "appId" attribute;

– the indication whether the message delivery status report is required within the "delivStReqInd" attribute;

– the Payload within the "payload" attribute;

– the Message is segmented within the "segInd" attribute; and

– the message segment parameters within the "segParams" attribute, this attribute may include:

– the segmentation set identifier within the "segId" attribute;

– the total number of message segments within the "totalSegCount" attribute;

– the message segment number within the "segNumb" attribute; and

– the last segment flag within the "lastSegFlag" attribute.

When the Non-3GPP Message Gateway receives the HTTP POST request from the MSGin5G Server, the Non-3GPP Message Gateway shall respond to the MSGin5G Server with a 204 No Content message.

If errors occur when processing the HTTP POST request, the Non-3GPP Message Gateway shall apply error handling procedures as specified in clause 9.2.6.

6.3.2.3 MSGG_N3GDelivery_GTDeliveryReport

6.3.2.3.1 General

This service operation corresponds to clause 9.2.2.2.2 as defined in 3GPP TS 23.554 [2], is used by MSGin5G Server to deliver the delivery status report to the Non-3GPP Message Gateway.

6.3.2.3.2 Non-3GPP Message Gateway Terminating Message Delivery Status Report

Figure 6.3.2.3.2-1: Non-3GPP Message Gateway Terminating Delivery Status Report

When the MSGin5G Server needs to send the delivery status report to the Non-3GPP Message Gateway, the MSGin5G Server shall send the HTTP POST request towards the "deliver-report" resource as shown in figure 6.3.2.3.2-1.

The MSGin5G Server shall send a POST request to the resource with a DeliveryStatusReport object in the request body.

The DeliveryStatusReport data type shall include:

– the Originating UE Service ID/AS Service ID within the "oriAddr" attribute;

– the Recipient UE Service ID within the "destAddr" attribute;

– the Message ID within the "msgId" attribute;

– the delivery status within the "delivSt" attribute; and

may include:

– the failure cause within the "failureCause" attribute.

When the Non-3GPP Message Gateway receives the HTTP POST request from the MSGin5G Server, the Non-3GPP Message Gateway shall respond to the MSGin5G Server with a 204 No Content message.

If errors occur when processing the HTTP POST request, the Non-3GPP Message Gateway shall apply error handling procedures as specified in clause 9.2.6.