Content for TS 23.554 Word version: 19.3.0

1… 4… 5… 5.3… 5.5… 6… 7… 8… 8.2… 8.2.7… 8.2.11 8.3… 8.3.5… 8.4… 8.4.3 8.5… 8.6… 8.7… 8.7.2… 8.7.3… 8.7.4… 8.7.5… 8.7.6… 8.8… 8.9… 8.10… 8.11… 9… 9.2… 10… 11…

8.3 Message delivery procedures 8.3.1 General 8.3.2 MSGin5G messages origination procedure 8.3.3 MSGin5G messages termination procedure 8.3.4 MSGin5G message delivery status report into the MSGin5G Server
...

8.3 Message delivery procedures p. 51

8.3.1 General p. 51

All MSGin5G message traffic is routed via the MSGin5G Server. The present clause specifies the MSGin5G message origination procedure when a MSGin5G service endpoint (i.e. MSGin5G UE, AS or Message Gateway) sending a message to its recipient(s) and the MSGin5G message termination procedure when a MSGin5G Server delivers a message to the MSGin5G service endpoint.

8.3.2 MSGin5G messages origination procedure p. 51

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, AS-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.
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. The application priority levels include High, Normal and Low. The default Priority type of an MSGin5G message is Normal.
Message is segmented	O	Indicates this message is part of a segmented 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.
Store and forward flag	O	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. If this parameter is not presented in this message, there is no specific Store and forward requirement for this message. The MSGin5G Server may apply the local policy on the message delivery, e.g. whether MSGin5G deferred message specified in clause 8.3.7 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

Value	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 verifies that the sender is authorized to send the message and checks the integrity of the message.

If the received MSGin5G message request is for a Group Message, the MSGin5G Server shall generate an individual message to all group members (excluding the message originator) with additional Recipient UE Service ID to each individual message as shown in Table 8.3.3-1.

If the received MSGin5G message is a Message Topic message, the MSGin5G Server shall generate an individual message to all subscribers subscribing this message topic (excluding the message originator) with additional Recipient UE Service ID to each individual message as shown in Table 8.3.3-1.

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 Request that is being responded to.
Message ID	M	Identifier of the Request that is being responded to.
Sending MSGin5G Server address	M	The address of the MSGin5G Server that sends the response message.
Segment set identifier	O	Included in the message response if the originating message was a segmented message.
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 messages termination procedure p. 56

Figure 8.3.3-1 shows the procedure for the MSGin5G Server that delivers 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 same procedure (step 1 only), however for the MSGin5G Server that delivers the message to an Application Server by application request.

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 delivers 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-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 delivers the received MSGin5G message 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	The service identity of the originating MSGin5G Client, Legacy 3GPP UE, Non-3GPP UE or the originating Application Server.
Recipient UE Service ID/AS Service ID	O	The service identity of the receiving entity. 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	O	The identifier of the Service Area where the message needs to be broadcast.
Application ID	O	Identifies the application for which the payload is intended.
Message ID	M	Unique identifier of this message.
Delivery status required	O	Indicates if delivery acknowledgement from the recipient is requested.
Payload	O	Payload of the message.
Message is segmented	O	Indicates this message is part of a segmented message.
Group Service ID	O	The service identifier of a Group.
Messaging Topic	O	Indicates which Messaging Topic this message is related to.
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.
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.
Priority type	O	Application priority level requested by the message originator for this message.

8.3.4 MSGin5G message delivery status report into the MSGin5G Server p. 58

Figure 8.3.4-1 shows the procedure for an MSGin5G UE that initiates an MSGin5G message delivery status report.

Copy of original 3GPP image for 3GPP TS 23.554, Fig. 8.3.4-1: Message delivery status report from MSGin5G UE

Figure 8.3.4-1: Message delivery status report from MSGin5G UE
(⇒ copy of original 3GPP image)

Figure 8.3.4-2 shows the procedure for an Application Server that initiates an API request for MSGin5G message delivery status report specified in clause 9.1.1.4 to UE.

Copy of original 3GPP image for 3GPP TS 23.554, Fig. 8.3.4-2: Message delivery status report from Application Server

Figure 8.3.4-2: Message delivery status report from Application Server
(⇒ copy of original 3GPP image)

Figure 8.3.4-3 shows the procedure for a Legacy 3GPP Message Gateway or a Non-3GPP Message Gateway that sends an MSGin5G message delivery status report 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.4-3: Message delivery status report from Message Gateway (on behalf of Non-MSGin5G UE)

Figure 8.3.4-3: Message delivery status report from Message Gateway (on behalf of Non-MSGin5G UE)
(⇒ copy of original 3GPP image)

Pre-conditions:

The sender of an MSGin5G message has asked for a message delivery status report.

Procedures:

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

Step 1.

The Application Client in the MSGin5G UE sends a request to the MSGin5G Client for invoking the MSGin5G Client to send an MSGin5G message delivery status report to a recipient.

Step 2.

As shown in Figure 8.3.4-1 or Figure 8.3.4-3, the MSGin5G Client or Message Gateway sends the MSGin5G message delivery status report to the MSGin5G Server and includes the IEs as listed in Table 8.3.4-1, or as shown in Figure 8.3.4-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.4-1.

Table 8.3.4-1: Message delivery status report to MSGin5G Server

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 (NOTE)	M	The service identity of the receiving MSGin5G Client, Legacy 3GPP UE, Non-3GPP UE or the receiving Application Server. This is the sender of the message that this message delivery status report is for.
Message ID	M	Unique identifier of message delivery status report. The message ID of the MSGin5G message that is being acknowledged is included in this IE.
Failure Cause	O	The Failure Cause indicates the failure reason, if applicable.
Delivery Status	M	The delivery status description, including success or failure in delivery.
NOTE: When the originator is an Application Server, (i.e. Originating AS Service ID is present), this IE shall be a UE Service ID.

Step 3.

The MSGin5G Server verifies that the sender is authorized to send the message delivery status report.

Step 4.

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