Content for TS 23.554 Word version: 18.2.0

1… 4… 5… 5.5… 6… 7… 8… 8.2… 8.2.3… 8.2.5… 8.3… 8.3.4… 8.4… 8.5… 8.6… 8.7… 8.7.2… 8.7.3… 8.7.4… 8.7.5… 8.8… 8.9… 8.9.3… 8.10… 8.11… 9… 10…

8.3 Message delivery procedures into and from MSGin5G Server 8.3.1 General 8.3.2 MSGin5G inbound messages into the MSGin5G Server 8.3.3 MSGin5G outbound messages from the MSGin5G Server
...

8.3 Message delivery procedures into and from MSGin5G Server p. 46

8.3.1 General p. 46

All MSGin5G message traffic is routed via the MSGin5G Server. The present clause specifies all MSGin5G message traffic towards and from the MSGin5G Server.

8.3.2 MSGin5G inbound messages into the MSGin5G Server p. 46

Figure 8.3.2-1 shows the procedure for an MSGin5G UE that initiates an MSGin5G message request.

Copy of original 3GPP image for 3GPP TS 23.554, Fig. 8.3.2-1: New MSGin5G message request from UE

Figure 8.3.2-1: New MSGin5G message request from UE
(⇒ copy of original 3GPP image)

Figure 8.3.2-2 shows the procedure for an Application Server that initiates an API request specified in clause 9.1.1.1 for sending an MSGin5G message to UE.

Copy of original 3GPP image for 3GPP TS 23.554, Fig. 8.3.2-2: Application Server initiates a request for sending an MSGin5G message

Figure 8.3.2-2: Application Server initiates a request for sending an MSGin5G message
(⇒ copy of original 3GPP image)

Figure 8.3.2-3 shows the procedure for a Legacy 3GPP Message Gateway or a non-3GPP Message Gateway that sends a new MSGin5G message request to the MSGin5G Server on behalf of a Legacy 3GPP UE or Non-3GPP UE.

Copy of original 3GPP image for 3GPP TS 23.554, Fig. 8.3.2-3: New MSGin5G message request sending from Message Gateway

Figure 8.3.2-3: New MSGin5G message request sending from Message Gateway
(⇒ copy of original 3GPP image)

The following procedure applies to the above Figure 8.3.2-1, Figure 8.3.2-2 and Figure 8.3.2-3 with the exception that step 1 only applies to Figure 8.3.2-1.

Step 1.

The Application Client in the UE sends a request to the MSGin5G Client for invoking the MSGin5G Client to send a new MSGin5G message to a recipient or to multiple recipients.

Step 2.

As shown in Figure 8.3.2-1 or Figure 8.3.2-3, the MSGin5G Client or Message Gateway sends the MSGin5G message request to the MSGin5G Server and includes the IEs as listed in Table 8.3.2-1 in the request; or as shown in Figure 8.3.2-2, the Application Server sends an API request to the MSGin5G Server for sending an MSGin5G message, the API request includes the IEs as listed in Table 8.3.2-1.

Table 8.3.2-1: Request to MSGin5G Server for sending MSGin5G message

Information element	Status	Description
Originating UE Service ID/AS Service ID	M	The service identity of the sending MSGin5G Client, Legacy 3GPP UE, Non-3GPP UE or the sending Application Server.
Recipient UE Service ID/AS Service ID (see NOTE 1, NOTE 2)	O	The service identity of the receiving MSGin5G Client, Legacy 3GPP UE, Non-3GPP UE or the receiving Application Server. This IE is mandatory for Point-to-Point messaging, Application-to-Point messaging, AOMT messaging and MOAT messaging and is not present in other message scenarios.
Group Service ID (see NOTE 1)	O	The service identifier of the target MSGin5G Group. This IE is mandatory for a Group Message and is not present in other message scenarios.
Broadcast Area ID (see NOTE 1)	O	The service identifier of the Broadcast Service Area where the message needs to be broadcast. This IE is mandatory in the Broadcast Message and is not present in other message scenarios.
Messaging Topic (see NOTE 1)	O	Indicates which Messaging Topic this message is related to. This IE is mandatory for a message distribution based on topic and is not present in other message scenarios.
Application ID	O	Identifies the application(s) for which the payload is intended. This list of Application IDs IE is required when the message is sent to one or multiple Application Clients served by same MSGin5G Client. This list of Application IDs IE may be included when the message is sent to an Application Server or to an Application Client. MSGin5G Server is unaware of the content.
Message ID	M	Unique identifier of this message.
Security credentials	O	Security information required by the MSGin5G Server. This is a placeholder for SA3 security information.
Delivery status required	O	Indicates if delivery acknowledgement from the recipient is requested.
Payload	O	Payload of the message. MSGin5G Server/Client is unaware of the content. If the request is sent from MSGin5G Client or Message Gateway to the MSGin5G Server, the maximum size of this IE is a configurable value that shall not exceed 2048 octets.
Priority type (see NOTE 3)	O	Application priority level requested for this message.
Message is segmented	O	Indicates this message is part of a segmented message. The application priority levels include High, Normal and Low. The default Priority type of an MSGin5G message is Normal.
Segmentation set identifier	O	All segmented messages associated within the same set of segmented messages (i.e. associated with the same MSGin5G message) are assigned the same unique identifier. Mandatory IE to be present in every segmented message.
Total number of message segments	O	Indicates the total number of segments for the message. The Total Segments needs to be included only in the first segment of the message.
Message segment number	O	An incrementing message segment number that indicates segmented message number of each segmented message within a set of segmented messages
Last segment flag	O	An indicator of whether this segmented message is the last segment in the set of segmented messages or not. The Last Segment Flag needs to be included only in the last segment of the message. Message segment number of the segment with "Last Segment Flag" set can be considered as total segments.
Store and forward flag	M	An indicator of whether store and forward services are requested for this message. If the value indicates that store and forward services are requested by the sender, the store and forward procedure in clause 8.3.6 applies.
Store and forward parameters	O	Parameters used by MSGin5G Server for providing store and forward services, as detailed in Table 8.3.2-2. This IE shall be included only if the value of the Store and forward flag IE indicates that store and forward services are requested. The MSGin5G store and forward procedure is detailed in clause 8.3.6.
NOTE 1: Only one of these IEs shall be included to represent the type of message request. The MSGin5G client may construct the related IEs based on the information received from Application Client, e.g. adds the MSGin5G service domain. NOTE 2: When the originator is an Application Server, (i.e. Originating AS Service ID is present), this IE shall be a UE Service ID. NOTE 3: The MSGin5G message with high priority should not be aggregated. The other usages of the priority level of the message is implementation specific and is out of scope of this document.

Table 8.3.2-2: Store and forward parameters

Information element	Status	Description
Message expiration time	O	Indicates message expiration time used for providing store and forward services if the destination is not available for communications, The MSGin5GServer attempts delivery at or before the message expiration time, or when the recipient becomes available.
Application specific store and forward information	O	Application specific information about store and forward handling, e.g. a delivery time/date.

Step 3.

The MSGin5G Server authenticates the message and verifies that the sender is authorized to send the message.

Step 4.

The MSGin5G Server may send a Message response to the originating entity if the message is rejected or stored and includes the IEs as listed in Table 8.3.2-3 in the response.

Table 8.3.2-3: Message Response

Information element	Status	Description
Originating UE Service ID/AS Service ID	M	The identity of the MSGin5G Client, Legacy 3GPP UE, Non-3GPP UE or the identity of the Application Server that initiated the previous Request.
Message ID	M	Identifier of the initiating Request.
Delivery Status	O	Indicates if delivery is a failure, or if the message is stored for deferred delivery.
Failure Cause	O	The reason for failure

8.3.3 MSGin5G outbound messages from the MSGin5G Server p. 51

Figure 8.3.3-1 shows the procedure for the MSGin5G Server that forwards an MSGin5G message.

Copy of original 3GPP image for 3GPP TS 23.554, Fig. 8.3.3-1: MSGin5G message towards UE

Figure 8.3.3-1: MSGin5G message towards UE
(⇒ copy of original 3GPP image)

Figure 8.3.3-2 shows the procedure for the MSGin5G Server that sends an MSGin5G message to a Legacy 3GPP Message Gateway, a Non-3GPP Message Gateway, or a Broadcast Message Gateway.

Copy of original 3GPP image for 3GPP TS 23.554, Fig. 8.3.3-2: message towards an Application Server

Figure 8.3.3-2: message towards an Application Server
(⇒ copy of original 3GPP image)

Figure 8.3.3-3 shows the procedure for the MSGin5G Server that sends an MSGin5G message to a Legacy 3GPP Message Gateway or a Non-3GPP Message Gateway.

Copy of original 3GPP image for 3GPP TS 23.554, Fig. 8.3.3-3: MSGin5G message towards a Message Gateway

Figure 8.3.3-3: MSGin5G message towards a Message Gateway
(⇒ copy of original 3GPP image)

The following procedure applies to the above Figure 8.3.3-1, Figure 8.3.3-2 and Figure 8.3.3-3 with the exception that step 2 only applies to Figure 8.3.3-1.

Step 1.

The MSGin5G Server sends the MSGin5G message request and includes the IEs as listed in Table 8.3.3-1.

Table 8.3.3-1: MSGin5G message request from MSGin5G Server

Information element	Status	Description
Originating UE Service ID/AS Service ID M	M	The service identity of the originating MSGin5G Client, Legacy 3GPP UE, Non-3GPP UE or the originating Application Server. This IE is copied from the associated inbound message.
Recipient UE Service ID/AS Service ID (see NOTE1, NOTE 2)	O	The service identity of the receiving entity. This IE is present in case the recipient is an individual UE or Application Server For Point-to-Point messaging, Application-to-Point messaging/Point-to-Application messaging, this IE is copied from the associated inbound message. For Group messaging, this IE can be a Recipient UE Service ID only. This IE is fetched from the participant information of the recipient in the group profile. For message delivery based on Messaging Topic subscription, this IE is the UE Service ID/AS Service ID of the Messaging Topic subscriber.
Broadcast Area ID (see NOTE 1)	O	The identifier of the Service Area where the message needs to be broadcast. This IE is mandatory in the Broadcast Message and is not present in other message scenarios. This IE is copied from the associated inbound message.
Application ID	O	Identifies the application for which the payload is intended. This list of Application ID(s) IE is required when the message is sent to one or multiple Application Clients served by same MSGin5G Client. This list of Application ID(s) IE may be included when the message is sent to an Application Server or to an Application Client. This list of IEs is copied from the associated inbound message.
Message ID	M	Unique identifier of this message. This IE is copied from the associated inbound message request.
Delivery status required	O	Indicates if delivery acknowledgement from the recipient is requested. This IE is copied from the associated inbound message.
Payload	O	Payload of the message. This IE is copied from the associated inbound message.
Message is segmented	O	Indicates this message is part of a segmented message.
Group Service ID	O	The service identifier of a Group. This IE is included if message delivery is based on Group messaging. This IE is copied from the Recipient Group Service ID IE in the associated inbound message.
Messaging Topic	O
	O	Indicates which Messaging Topic this message is related to. This IE is included if message delivery is based on a Messaging Topic subscription. This IE is copied from the Messaging Topic IE in the associated inbound message.
Segmentation Set Identifier	O	All segmented messages associated within the same set of segmented messages (i.e. associated with the same MSGin5G message) are assigned the same unique identifier. Mandatory IE to be present in every segmented message.
Total number of message segments	O	Indicates the total number of segments for the message. The Total Segments needs to be included only in the first segment of the message.
Message segment number	O	An incrementing message segment number that indicates segmented message number of each segmented message within a set of segmented messages.
Last Segment Flag	O	An indicator of whether this segmented message is the last segment in the set of segmented messages or not. The Last Segment Flag needs to be included only in the last segment of the message. Message segment number of the segment with "Last Segment Flag" set can be considered as total segments.
NOTE 1: Only one of these IEs shall be included to represent the type of message request. The MSGin5G client may construct the IEs specified in Table 8.11.5-1 based on the IEs above in the received MSGin5G message, e.g. removes the MSGin5G service domain, if the Payload is sent to Application Client. NOTE 2: When the originator is an Application Server, (i.e. Originating AS Service ID is present), this IE shall be a UE Service ID.

If the received MSGin5G message request is for Group Message, the MSGin5G Server shall, in addition to the Recipient Group Service ID IE, add the Recipient UE Service ID of each individual group member, excluding the message originator.

If the received MSGin5G message request is for a Topic Message, the MSGin5G Server shall, in addition to the Messaging Topic IE, add the Recipient UE Service ID/AS Service ID of each individual Topic subscriber, excluding the message originator.