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.
Figure 8.3.2-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.
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.
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.
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.
Security Credentials
O
Security information required by the MSGin5G Server.
This is a placeholder for SA3 security information.
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.
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.
Figure 8.3.5-3 shows the procedure for the MSGin5G Server that forwards an MSGin5G message delivery status report to a Legacy 3GPP Message Gateway or a Non-3GPP Message Gateway.
the MSGin5G Server sends the MSGin5G message delivery status report to the MSGin5G UE or Message Gateway and includes the IEs as listed in Table 8.3.5-1, or as shown in Figure 8.3.5-2 and Figure 8.3.5-3, the MSGin5G Server sends an API request to the Application Server for sending an MSGin5G message, the API request includes the IEs as listed in Table 8.3.5-1.
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)
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.
Figure 8.3.6-1 shows the procedure for providing store and forward services for MSGin5G message requests.
This procedure applies when an MSGin5G inbound message is received at the MSGin5G Server and the recipient UE is not available; otherwise, the procedure detailed in clause 8.3.2 applies.
Pre-conditions:
The MSGin5G Client or Application Server has registered to the MSGin5G Server.
The MSGin5G server has determined that the recipient UE is not available.
Inbound MSGin5G message handling, see steps 1-3 in clause 8.3.2. The value of the Store and forward flag IE (see Table 8.3.2-1) in the MSGin5G message indicates that store and forward services are requested by the sender.
The MSGin5G Server checks the registration information of the recipient UE. If the Store and forward option IE (see Table 8.2.1-3) indicates that the recipient UE opts out of store and forward services, the message is discarded and the procedure ends. If the Store and forward flag IE (see Table 8.3.2-1) in the received message indicates that store and forward services are not requested by the sender, the message is discarded and the procedure ends.
If store and forward processing is required, the MSGin5G Server uses the Application specific store and forward information IE (see Table 8.3.2-2) to determine storage and forwarding
Before the Message expiration time is expired, the MSGin5G Server may trigger the Recipient UE based on the MSGin5G device triggering procedure in clause 8.9.3.
The MSGin5G Server may send a message response as defined in Table 8.3.2-3 which includes store and forward status information in the Delivery Status IE, e.g., that the delivery had been deferred
When the recipient UE becomes available, the MSGin5G Server attempts delivery of the request using the procedure specified in clause 8.3.3.
If the UE does not become available prior to the expiration time, the MSGin5G Server attempts delivery of the request at the message expiration time and the stored message is discarded afterwards.
The MSGin5G Server may send a message response as defined in Table 8.3.2-3 which includes store and forward status information in the Delivery Status IE, e.g., that the message was discarded.