9 APIs and related information flows

23.5543GPPApplication architecture for MSGin5G ServiceRelease 18Stage 2TS

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

9.1 APIs provided by MSGin5G Server

9.1.1 Mm5s APIs

9.1.1.1 M5S_AS_Originating_Message_Delivery API

9.1.1.1.1 General

API description: This API enables the Application Server to send MSGin5G message to the MSGin5G Server.

9.1.1.1.2 Send_MSGin5G_Message operation

API operation name: Send_MSGin5G_Message

Description: Send an MSGin5G message to MSGin5G Server.

Known Consumers: Application Server

Inputs: Refer subclause 9.1.2.1

Outputs: Refer subclause 8.3.2

See subclause 8.3.2 for the details of usage of this API operation.

9.1.1.2 M5S_UE_Originating_Message_Delivery API

9.1.1.2.1 General

API description: This API enables the Message Gateway or other 5GS Function to deliver MSGin5G message to the MSGin5G Server.

9.1.1.2.2 Send_ MSGin5G_Message operation

API operation name: Send_MSGin5G_Message

Description: Send an MSGin5G message to MSGin5G Server.

Known Consumers: L3G, N3G.

Inputs: Refer subclause 8.3.2

Outputs: Refer subclause 8.3.2

See subclause 8.3.2 for the details of usage of this API operation.

9.1.1.3 M5S_AS_Originating_Delivery_Status_Report API

9.1.1.3.1 General

API description: This API enables the Application Server to delivery MSGin5G message delivery status report to the MSGin5G Server.

9.1.1.3.2 Report_Message_Delivery_Status operation

API operation name: Report_Message_Delivery_Status

Description: Send an MSGin5G message delivery status report to MSGin5G Server.

Known Consumers: Application Server

Inputs: Refer subclause 9.1.2.2

Outputs: Refer subclause 8.3.4

See subclause 8.3.4 for the details of usage of this API operation.

9.1.1.4 M5S_Delivery_Status_Report API

9.1.1.4.1 General

API description: This API enables the Message Gateway to deliver MSGin5G message delivery status reports to the MSGin5G Server.

9.1.1.4.2 Report_Message_Delivery_Status operation

API operation name: Report_Message_Delivery_Status

Description: Send an MSGin5G message delivery status report to MSGin5G Server.

Known Consumers: L3G, N3G, BMG.

Inputs: Refer subclause 8.3.4

Outputs: Refer subclause 8.3.4

See subclause 8.3.4 for the details of usage of this API operation.

9.1.1.5 M5S_AS_Registration API

9.1.1.5.1 General

API description: This API enables the Application Server to register to MSGin5G Server.

9.1.1.5.2 Registration operation

API operation name: Registration

Description: Do registration or update registration to an MSGin5G Server, by using this API, the Application Server provides/updates its information, including the URL used for the message delivery from MSGin5G Server to Application Server.

Known Consumers: Application Server

Inputs: Refer subclause 9.1.2.3

Outputs: Refer subclause 9.1.2.4

9.1.1.5.3 Deregistration operation

API operation name: Send_MSGin5G_Message

Description: Do deregistration with an MSGin5G Server.

Known Consumers: Application Server

Inputs: Refer subclause 9.1.2.5

Outputs: Refer subclause 9.1.2.6

9.1.2 Mm5s Information flows

9.1.2.1 M5S Application Server originating message send request

The information flows from the Application Server to the MSGin5G Server for message delivery includes the IEs in table 8.3.2-1. Additionally, the following information in table 9.1.2.1-2 elements needs to be included:

Table 9.1.2.1-2: M5S Northbound Message Delivery Send request

Information element	Status	Description
Latency	O	The latency requirement for the message.
Authorization Information	O	The authorization information used to determine whether the Application Server is allowed to send the message

9.1.2.2 M5S Application Server originating message delivery status report request

The information flows from the Application Server to the MSGin5G Server for message delivery status report includes the IE in table 8.3.4-1, and the following information in table 9.1.2.2-1 elements needs to be included:

Table 9.1.2.2-1: M5S Northbound Message Delivery Send request

Information element	Status	Description
Authorization Information	O	The authorization information used to determine whether the Application Server is allowed to send the message

9.1.2.3 M5S Application Server registration request

The information flows from the Application Server to the MSGin5G Server for registration request includes the information elements in Table 9.1.2.3-1.

Table 9.1.2.3-1: Application Server Registration request

Information element	Status	Description
AS service ID	M	The MSGin5G identifier of the Application Server. This ID is configured before registration.
Application ID	O	The identifier of the application specified by the application provider.
Authorization Information	O	The authorization information used to determine whether the Application Server is allowed to send the message
Notification target URI	O	The URL for receiving message, message delivery status report, etc. The MSGin5G Server uses this URL to interact to Application Server.
Application Profile (NOTE)	O	The elements in Application Profile include the information of the Application Server, e.g. application name, application provider, application scenario description, application category, etc. This IE is used by MSGin5G Server to compare with application client information.
NOTE: The detailed definition of Application Profile is out of scope of this document.

9.1.2.4 M5S Application Server registration response

The information flows from the MSGin5G Server to the Application Server for registration response includes the information elements in Table 9.1.2.4-1.

Table 9.1.2.4-1: Application Server registration response

Information element	Status	Description
AS service ID	M	The MSGin5G identifier of the Application Server.
Registration result	M	Indication if the registration is success or failure

Editor’s note: Whether other information may be included in the Application Server registration response is FFS.

9.1.2.5 M5S Application Server de-registration request

The information flows from the Application Server to the MSGin5G Server for de-registration request includes the information elements in Table 9.1.2.5-1.

Table 9.1.2.5-1: Application Server de-registration request

Information element	Status	Description
AS service ID	M	The MSGin5G identifier of the Application Server.

9.1.2.6 M5S Application Server de-registration response

The information flows from the MSGin5G Server to the Application Server for de-registration response includes the information elements in Table 9.1.2.6-1.

Table 9.1.2.6-1: Application Server de-registration response

Information element	Status	Description
AS service ID	M	The MSGin5G identifier of the Application Server.
De-registration result	M	Indication if the de-registration is success or failure

9.2 APIs provided by Message Gateway

9.2.1 Ml3g APIs

9.2.1.1 L3G_Message_Delivery API

9.2.1.1.1 General

API description: This API enables the MSGin5G Server to deliver MSGin5G message to the Legacy 3GPP Message Gateway.

9.2.1.1.2 Send_Message operation

API operation name: Send_MSGin5G_Message

Description: Send an MSGin5G message to Legacy 3GPP Message Gateway.

Known Consumers: M5S.

Inputs: Refer subclause 8.3.3

Outputs: Refer subclause 8.3.3

See subclause 8.3.3 for the details of usage of this API operation.

9.2.1.2 L3G_Delivery_Status_Report API

9.2.1.2.1 General

API description: This API enables the MSGin5G Server to deliver a Delivery Status Report to the Legacy 3GPP Message Gateway.

9.2.1.2.2 Report_Message_Delivery_Status operation

API operation name: Report_Message_Delivery_Status

Description: Send an MSGin5G message delivery status report to Legacy 3GPP Message Gateway.

Known Consumers: M5S.

Inputs: Refer subclause 8.3.5

Outputs: Refer subclause 8.3.5

See subclause 8.3.5 for the details of usage of this API operation.

9.2.2 Mn3g APIs

9.2.2.1 N3G_Message_Delivery API

9.2.2.1.1 General

API description: This API enables the MSGin5G Server to deliver MSGin5G message to the Non-3GPP Message Gateway.

9.2.2.1.2 Send_Message operation

API operation name: Create_MSGin5G_Message

Description: Send an MSGin5G message to Non-3GPP Message Gateway.

Known Consumers: M5S.

Inputs: Refer subclause 8.3.3

Outputs: Refer subclause 8.3.3

See subclause 8.3.3 for the details of usage of this API operation.

9.2.2.2 N3G_Delivery_Status_Report API

9.2.2.2.1 General

API description: This API enables the MSGin5G Server to deliver a Delivery Status Report to the Non-3GPP Message Gateway.

9.2.2.2.2 Report_Message_Delivery_Status operation

API operation name: Report_Message_Delivery_Status

Description: Send an MSGin5G message delivery status report to Non-3GPP Message Gateway.

Known Consumers: M5S.

Inputs: Refer subclause 8.3.5

Outputs: Refer subclause 8.3.5

See subclause 8.3.5 for the details of usage of this API operation.

9.2.3 Mbg APIs

9.2.3.1 Nbg_Message_Delivery API

9.2.3.1.1 General

API description: This API enables the MSGin5G Server to deliver MSGin5G messages to the Broadcast Message Gateway.

9.2.3.1.2 Send_Message operation

API operation name: Create_MSGin5G_Message

Description: Send an MSGin5G message to Broadcast Message Gateway.

Known Consumers: M5S.

Inputs: Refer subclause 8.3.3

Outputs: Refer subclause 8.3.3

See subclause 8.3.3 for the details of usage of this API operation.