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

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.

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.

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

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.

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, AS-to-Point messaging/Point-to-AS 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

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.

Priority type

O

Application priority level requested by the message originator for this message.

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.

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.

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)

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.