15 Message Formats

24.2823GPPMission Critical Data (MCData) signalling controlProtocol specificationRelease 18TS

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

15.1 MCData message functional definitions and contents

15.1.1 General

The following clauses describe the MCData message functional definitions and contents. Each message consist of a series of information elements. The standard format of an MCData message and the encoding rules for each type of information element follow that defined for the MCPTT Off-Network Protocol (MONP) as documented in Annex I of 3GPP TS 24.379 [10]. The associated MIME types and related considerations are documented in Annex E of the present document.

For off-network transport, the MONP MCData messages are transported in a MONP MCDATA CARRIER message defined in TS 24.379 [10].

15.1.2 SDS SIGNALLING PAYLOAD message

15.1.2.1 Message definition

This message is sent by the UE to other UEs when sending an SDS data payload. This message provides the signalling content related to the SDS data payload. For the contents of the message see Table 15.1.2.1-1.

Message type: SDS SIGNALLING PAYLOAD

Direction: UE to other UEs (can be via network)

Table 15.1.2.1-1: SDS SIGNALLING PAYLOAD message content

IEI

Information Element

Type/Reference

Presence

Format

Length

SDS signalling payload message identity

Message type
15.2.2

Date and time

Date and time
15.2.8

Conversation ID

15.2.9

Message ID

Message ID
15.2.10

InReplyTo message ID

InReplyTo message ID
15.2.11

Application ID

15.2.7

SDS disposition request type

SDS disposition request type
15.2.3

Extended application ID

Extended application ID
15.2.24

TLV-E

4-x

User location

User location
15.2.25

TLV-E

4-x

Sender MCData user ID

MCData user ID

15.2.15

TLV-E

4-x

Application metadata container

Application metadata container
15.2.28

TLV-E

4-x

15.1.3 FD SIGNALLING PAYLOAD message

15.1.3.1 Message definition

This message is sent by the UE to other UEs when sending an FD data payload. This message provides the signalling content related to the FD data payload. For the contents of the message see Table 15.1.3.1-1.

Message type: FD SIGNALLING PAYLOAD

Direction: UE to other UEs (via the network)

Table 15.1.3.1-1: FD SIGNALLING PAYLOAD message content

IEI	Information Element	Type/Reference	Presence	Format	Length
	FD signalling payload message identity	Message type 15.2.2	M	V	1
	Date and time	Date and time 15.2.8	M	V	5
	Conversation ID	Conversation ID 15.2.9	M	V	16
	Message ID	Message ID 15.2.10	M	V	16
21	InReplyTo message ID	InReplyTo message ID 15.2.11	O	TV	17
22	Application ID	Application ID 15.2.7	O	TV	2
9-	FD disposition request type	FD disposition request type 15.2.4	O	TV	1
A-	Mandatory download	Mandatory download 15.2.16	O	TV	1
78	Payload	Payload 15.2.13	O	TLV-E	4-x
79	Metadata	Metadata 15.2.17	O	TLV-E	4-x
7D	Extended application ID	Extended application ID 15.2.24	O	TLV-E	4-x
51	Sender MCData user ID	MCData user ID 15.2.15	O	TLV-E	4-x
53	Application metadata container	Application metadata container 15.2.28	O	TLV-E	4-x

15.1.4 DATA PAYLOAD message

15.1.4.1 Message definition

This message is sent by the UE to other UEs when sending an SDS data payload or an FD data payload. This message provides the data to be delivered to the user or application. For the contents of the message see Table 15.1.4.1-1.

Message type: DATA PAYLOAD

Direction: UE to other UEs (can be via the network for SDS and always via the network for FD)

Table 15.1.4.1-1: DATA PAYLOAD message content

IEI	Information Element		Type/Reference	Presence	Format	Length
	Data payload message identity		Message type 15.2.2	M	V	1
	Number of payloads		Number of payloads 15.2.12	M	V	1
7A		Security parameters and Payload	MCData Protected Payload message 3GPP TS 33.180 [26]	O	TLV-E	32-x
78	Payload		Payload 15.2.13	O	TLV-E	4-x

NOTE 1: The Number of payloads IE dictates the number of Payload IEs and Security parameters and Payload IEs that are included in the message by the sender. Multiple Payload IEs can be part of Security parameters and Payload IE if end-to-end security is required, i.e. if there are multiple protected user payloads, each one should be a separate Security parameters and Payload IE containing a "MCData Protected Payload message content" with the message type of "MCData Protected Payload message content" set according to 3GPP TS 33.180 [26].

NOTE 2: If end-to-end security is required for a one-to-one communication, Security parameters and Payload IE is included. Otherwise, if end-to-end security is not required for a one-to-one communication, Payload IE is included. For group communication, Payload IE is included.

NOTE 3: Formatting of user payloads as part of the Security parameters and Payload IE is specified in clause 15.2.13. The user payloads formatted as specified in the clause 15.2.13 and protected as specified in the clause 8.5.4.1 of 3GPP TS 33.180 [26]. The Protected Payload (Ciphertext) encapsulated in "MCData Protected Payload message content". Finally, the entire "MCData Protected Payload message content" is encoded in the "DATA PAYLOAD message content" as a "Security parameters and Payload" IE value.

NOTE 4: An entire "DATA PAYLOAD message content" can be protected for all the user payloads. Otherwise, each user payloads are protected and encapsulated in a separate "Security parameters and Payload" IEs of the "DATA PAYLOAD message content".

NOTE 5: The MCData Protected Payload message do not inherits the message type from the DATA PAYLOAD message when each user payloads are protected and encapsulated in a separate "Security parameters and Payload" IEs of the "DATA PAYLOAD message content". The bits 7, 8 set according to clause 8.5.1 of 3GPP TS 33.180 [26].

15.1.5 SDS NOTIFICATION message

15.1.5.1 Message definition

This message is sent by the UE to another other UE to share SDS disposition information. For the contents of the message see Table 15.1.5.1-1.

Message type: SDS NOTIFICATION

Direction: UE to other UEs (can be via network)

Table 15.1.5.1-1: SDS NOTIFICATION message content

IEI	Information Element	Type/Reference	Presence	Format	Length
	SDS notification message identity	Message type 15.2.2	M	V	1
	SDS disposition notification type	SDS disposition notification type 15.2.5	M	V	1
	Date and time	Date and time 15.2.8	M	V	5
	Conversation ID	Conversation ID 15.2.9	M	V	16
	Message ID	Message ID 15.2.10	M	V	16
22	Application ID	Application ID 15.2.7	O	TV	2
7D	Extended application ID	Extended application ID 15.2.24	O	TLV-E	4-x
51	Sender MCData user ID	MCData user ID 15.2.15	O	TLV-E	4-x

15.1.6 FD NOTIFICATION message

15.1.6.1 Message definition

This message is sent by the UE to another other UE to share FD disposition information. For the contents of the message see Table 15.1.6.1-1.

Message type: FD NOTIFICATION

Direction: UE to other UEs (via the network)

Table 15.1.6.1-1: FD NOTIFICATION message content

IEI	Information Element	Type/Reference	Presence	Format	Length
	FD notification message identity	Message type 15.2.2	M	V	1
	FD disposition notification type	FD disposition notification type 15.2.6	M	V	1
	Date and time	Date and time 15.2.8	M	V	5
	Conversation ID	Conversation ID 15.2.9	M	V	16
	Message ID	Message ID 15.2.10	M	V	16
22	Application ID	Application ID 15.2.7	O	TV	2
7D	Extended application ID	Extended application ID 15.2.24	O	TLV-E	4-x
51	Sender MCData user ID	MCData user ID 15.2.15	O	TLV-E	4-x

15.1.7 SDS OFF-NETWORK MESSAGE message

15.1.7.1 Message definition

This message is sent by the UE to other UEs to share application or user payload in a SDS message. For contents of the message see Table 15.1.7.1-1.

Message type: SDS OFF-NETWORK MESSAGE

Direction: UE to other UEs

Table 15.1.7.1-1: SDS OFF-NETWORK MESSAGE message content

IEI

Information Element

Type/Reference

Presence

Format

Length

SDS off-network message message identity

Message Type

15.2.2

Date and time

15.2.8

Number of payloads

15.2.12

Conversation ID

15.2.9

Message ID

15.2.10

Sender MCData user ID

MCData user ID

15.2.15

LV-E

3-x

InReplyTo message ID

15.2.11

Application ID

15.2.7

SDS disposition request type

15.2.3

Security parameters

MCData Protected Payload message

3GPP TS 33.180 [26]

MCData group ID

MCData group ID
15.2.14

TLV-E

4-x

Recipient MCData user ID

MCData user ID
15.2.15

TLV-E

4-x

Payload

15.2.13

TLV-E

4-x

Extended application ID

Extended application ID
15.2.24

TLV-E

4-x

User location

User location
15.2.25

TLV-E

4-x

15.1.8 SDS OFF-NETWORK NOTIFICATION message

15.1.8.1 Message definition

This message is sent by the UE to other UEs to share disposition status of a SDS message. For contents of the message see Table 15.1.8.1-1.

Message type: SDS OFF-NETWORK NOTIFICATION

Direction: UE to other UEs

Table 15.1.8.1-1: SDS OFF-NETWORK NOTIFICATION message content

IEI	Information Element	Type/Reference	Presence	Format	Length
	SDS off-network notification message identity	Message type 15.2.2	M	V	1
	SDS disposition notification type	SDS disposition notification type 15.2.5	M	V	1
	Date and time	Date and time 15.2.8	M	V	5
	Conversation ID	Conversation ID 15.2.9	M	V	16
	Message ID	Message ID 15.2.10	M	V	16
	Sender MCData user ID	MCData user ID 15.2.15	M	LV-E	3-x
22	Application ID	Application ID 15.2.7	O	TV	2
7D	Extended application ID	Extended application ID 15.2.24	O	TLV-E	4-x

15.1.9 FD NETWORK NOTIFICATION message

15.1.9.1 Message definition

This message is sent from the network to the UE to provide the UE a file availability indication. For the contents of the message see Table 15.1.9.1-1.

Message type: FD NETWORK NOTIFICATION

Direction: network to UE

Table 15.1.9.1-1: FD NETWORK NOTIFICATION message content

IEI	Information Element	Type/Reference	Presence	Format	Length
	FD network notification message identity	Message type 15.2.2	M	V	1
	FD notification type	Notification type 15.2.18	M	V	1
	Date and time	Date and time 15.2.8	M	V	5
	Conversation ID	Conversation ID 15.2.9	M	V	16
	Message ID	Message ID 15.2.10	M	V	16
22	Application ID	Application ID 15.2.7	O	TV	2
7D	Extended application ID	Extended application ID 15.2.24	O	TLV-E	4-x

15.1.10 COMMUNICATION RELEASE message

15.1.10.1 Message definition

This message is sent by the MCData server to MCData UE to indicate about intension to release the MCData communication. This message is also sent by the MCData UE to MCData server to request extension for the MCData communication. The MCData server response back about the request using this message. For the contents of the message see Table 15.10.1-1.

Message type: COMMUNICATION RELEASE

Direction: Server to UE, UE to server

Table 15.1.10.1-1: COMMUNICATION RELEASE message content

IEI	Information Element	Type/Reference	Presence	Format	Length
	Comm Release message identity	Message type 15.2.2	M	V	1
	Comm Release Information type	Comm Release Information type 15.2.20	M	V	1
B-	Data query type	Data query type 15.2.19	O	TV	1
C-	Extension response type	Extension response type 15.2.21	O	TV	1

15.1.11 DEFERRED DATA REQUEST message

15.1.11.1 Message definition

This message is sent by the MCData UE to MCData server to request the list of group communications which was deferred by the MCData user.

Message type: DEFERRED DATA REQUEST

Direction: UE to server

Table 15.1.11.1-1: DEFERRED DATA REQUEST message content

IEI	Information Element	Type/Reference	Presence	Format	Length
	Deferred data request message identity	Message type 15.2.2	M	V	1

15.1.12 DEFERRED DATA RESPONSE message

15.1.12.1 Message definition

This message is sent by the MCData server to the MCData UE as response to the list of deferred group communications request from the MCData UE.

Message type: DEFERRED DATA RESPONSE

Direction: Server to UE

Table 15.1.12.1-1: DEFERRED DATA RESPONSE message content

IEI	Information Element	Type/Reference	Presence	Format	Length
	Deferred data response message identity	Message type 15.2.2	M	V	1
	Number of payloads	Number of payloads 15.2.12	M	V	1
7A	Security parameters and Payload	MCData Protected Payload message 3GPP TS 33.180 [26]	O	TLV-E	32-x
78	Payload	Payload 15.2.13	O	TLV-E	4-x
7B	MCData group ID	MCData group ID 15.2.14	O	TLV-E	4-x
52	Deferred FD signalling payload	Deferred FD signalling payload 15.2.27	O	TLV-E	4-x

The number of ‘Deferred FD signalling payload’ element depends on the ‘Number of payloads’ information element value (i.e as many entries as that of ‘Number of payloads’ element value).

NOTE: Only the ‘payload’ IE and its value applicability were specified in early versions of the present document from release 13 to release 16. The continued support for Payload element and its value is for backwards compatibility.

15.1.13 FD HTTP TERMINATION

15.1.13.1 Message definition

This message is sent by the UE to server or server to UE when trying to release FD communication over HTTP. This message provides the signalling content to identify the MESSAGE where FILE URL is shared. For the contents of the message see table 15.1.13.1-1.

Message type: FD HTTP TERMINATION

Direction: UE to server or server to UE

Table 15.1.13.1-1: FD HTTP TERMINATION content

IEI	Information Element	Type/Reference	Presence	Format	Length
	FD signalling payload message identity	Message type 15.2.2	M	V	1
	Conversation ID	Conversation ID 15.2.9	M	V	16
	Message ID	Message ID 15.2.10	M	V	16
	Termination Information Type	Termination information type 15.2.22	M	V	1
22	Application ID	Application ID 15.2.7	O	TV	2
C-	Extension Response Type	Extension response type 15.2.21	O	TV	1
D-	Release Response Type	Release response type 15.2.23	O	TV	1
78	Payload	Payload 15.2.13	O	TLV-E	4-x
7D	Extended application ID	Extended application ID 15.2.24	O	TLV-E	4-x

15.1.14 GROUP EMERGENCY ALERT message

15.1.14.1 Message definition

This message is sent by the UE to other UEs to indicate an emergency situation. For contents of the message see table 15.1.14.1-1.

Message type: GROUP EMERGENCY ALERT

Direction: UE to other UEs

Table 15.1.14.1-1: GROUP EMERGENCY ALERT message content

IEI	Information Element	Type/Reference	Presence	Format	Length
	Group emergency alert message identity	Message type 15.2.2	M	V	1
	MCData group ID	MCData group ID 15.2.14	M	LV-E	3-x
	Originating MCData user ID	MCData user ID 15.2.15	M	LV-E	3-x
7F	Organization name	Organization name 15.2.26	O	TLV-E	4-x
7E	User location	User location 15.2.25	O	TLV-E	4-x

15.1.15 GROUP EMERGENCY ALERT ACK message

15.1.15.1 Message definition

This message is sent by the UE to other UEs to indicate receipt of emergency alert. For contents of the message see table 15.1.15.1-1.

Message type: GROUP EMERGENCY ALERT ACK

Direction: UE to other UEs

Table 15.1.15.1-1: GROUP EMERGENCY ALERT ACK message content

IEI	Information Element	Type/Reference	Presence	Format	Length
	Group emergency alert ack message identity	Message type 15.2.2	M	V	1
	MCData group ID	MCData group ID 15.2.14	M	LV-E	3-x
	Originating MCData user ID	MCData user ID 15.2.15	M	LV-E	3-x
	Sending MCData user ID	MCData user ID 15.2.15	M	LV-E	3-x

15.1.16 GROUP EMERGENCY ALERT CANCEL message

15.1.16.1 Message definition

This message is sent by the UE to other UEs to indicate end of emergency situation. For contents of the message see table 15.1.16.1-1.

Message type: GROUP EMERGENCY ALERT CANCEL

Direction: UE to other UEs

Table 15.1.16.1-1: GROUP EMERGENCY ALERT CANCEL message content

IEI	Information Element	Type/Reference	Presence	Format	Length
	Group emergency alert cancel message identity	Message type 15.2.2	M	V	1
	MCData group ID	MCData group ID 15.2.14	M	LV-E	3-x
	Originating MCData user ID	MCData User ID 15.2.15	M	LV-E	3-x

15.1.17 GROUP EMERGENCY ALERT CANCEL ACK message

15.1.17.1 Message definition

This message is sent by the UE to other UEs to indicate receipt of emergency alert cancel. For contents of the message see table 15.1.17.1-1.

Message type: GROUP EMERGENCY ALERT CANCEL ACK

Direction: UE to other UEs

Table 15.1.17.1-1: GROUP EMERGENCY ALERT CANCEL ACK message content

IEI	Information Element	Type/Reference	Presence	Format	Length
	Group emergency alert cancel ack message identity	Message type 15.2.2	M	V	1
	MCData group ID	MCData group ID 15.2.14	M	LV-E	3-x
	Originating MCData user ID	MCData User ID 15.2.15	M	LV-E	3-x
	Sending MCData user ID	MCData user ID 15.2.15	M	LV-E	3-x

15.2 General message format and information elements coding

15.2.1 General

The least significant bit of a field is represented by the lowest numbered bit of the highest numbered octet of the field. When the field extends over more than one octet, the order of bit values progressively decreases as the octet number increases.

Figure 15.2.1-1 shows an example of a field where the most significant bit of the field is marked MSB and the least significant bit of the field is marked LSB.

8	7	6	5	4	3	2	1
MSB	x	x	x	x	x	x	x	octet 1
x	x	x	x	x	x	x	x
x	x	x	x	x	x	x	LSB	octet N

Figure 15.2.1-1: Example of bit ordering of a field

Within the protocols defined in the present document, the message consists of the following parts:

a) message type information element; and

b) other information elements, as required.

The organization of a message is illustrated in the example shown in Figure 15.2.1-2.

8	7	6	5	4	3	2	1
Message type								octet 1
								octet 2
Other information elements as required
								octet n

Figure 15.2.1-2: General message organization example

Unless specified otherwise in the message descriptions of clause 15.1, a particular information element shall not be present more than once in a given message.

The sending entity shall set value of a spare bit to zero. The receiving entity shall ignore value of a spare bit

The sending entity shall not set a value of an information element to a reserved value. The receiving entity shall discard message containing an information element set to a reserved value.

15.2.2 Message type

The purpose of the Message type information element is to identify the type of the message.

The value part of the Message type information element is coded as shown in Table 15.2.2-1.

The Message type information element is a type 3 information element with a length of 1 octet.

Table 15.2.2-1: Message types

Bits
8	7	6	5	4	3	2	1

x	x	0	0	0	0	0	1	SDS SIGNALLING PAYLOAD
x	x	0	0	0	0	1	0	FD SIGNALLING PAYLOAD
x	x	0	0	0	0	1	1	DATA PAYLOAD
x	x	0	0	0	1	0	1	SDS NOTIFICATION
x	x	0	0	0	1	1	0	FD NOTIFICATION
x	x	0	0	0	1	1	1	SDS OFF-NETWORK MESSAGE
x	x	0	0	1	0	0	0	SDS OFF-NETWORK NOTIFICATION
x	x	0	0	1	0	0	1	FD NETWORK NOTIFICATION
x	x	0	0	1	0	1	0	COMMUNICATION RELEASE
x	x	0	0	1	0	1	1	DEFERRED LIST ACCESS REQUEST
x	x	0	0	1	1	0	0	DEFERRED LIST ACCESS RESPONSE
x	x	0	0	1	1	0	1	FD HTTP TERMINATION
x	x	0	1	0	0	0	1	GROUP EMERGENCY ALERT
x	x	0	1	0	0	1	0	GROUP EMERGENCY ALERT ACK
x	x	0	1	0	0	1	1	GROUP EMERGENCY ALERT CANCEL
x	x	0	1	0	1	0	0	GROUP EMERGENCY ALERT CANCEL ACK

All other values are reserved.

Bit 7 of the above defined messages is set as follows:

– ‘0’ – if the message is not protected as defined in 3GPP TS 33.180 [26]; or

– ‘1’ – if the message is protected as defined in 3GPP TS 33.180 [26].

Bit 8 of the above defined messages is set as follows:

– ‘0’ – if the message is not authenticated as defined in 3GPP TS 33.180 [26]; or

– ‘1’ – if the message is authenticated as defined in 3GPP TS 33.180 [26].

15.2.3 SDS disposition request type

The purpose of the SDS disposition request type information element is to identify the type of SDS disposition notification that the sender requires from the receiver.

The value part of the SDS disposition request type information element is coded as shown in Table 15.2.3-1.

The SDS disposition request type information element is a type 1 information element.

8	7	6	5	4	3	2	1
SDS disposition request type IEI				SDS disposition request type value				octet 1

Figure 15.2.3-1: SDS disposition request type

Table 15.2.3-1: SDS disposition request type

SDS disposition request type value (octet 1)
Bits
4	3	2	1
0	0	0	1	DELIVERY
0	0	1	0	READ
0	0	1	1	DELIVERY AND READ

All other values are reserved.

15.2.4 FD disposition request type

The purpose of the FD disposition request type information element is to identify the type of FD disposition notification that the sender requires from the receiver.

The value part of the FD disposition request type information element is coded as shown in Table 15.2.4-1.

The FD disposition request type information element is a type 1 information element.

8	7	6	5	4	3	2	1
FD disposition request type IEI				FD disposition request type value				octet 1

Figure 15.2.4-1: FD disposition request type

Table 15.2.4-1: FD disposition request type

FD disposition request type value (octet 1)
Bits
4	3	2	1
0	0	0	1	FILE DOWNLOAD COMPLETED UPDATE

All other values are reserved.

15.2.5 SDS disposition notification type

The purpose of the SDS disposition notification type information element is to identify the type of SDS disposition notification sent from receiver to the sender.

The value part of the SDS disposition notification type information element is coded as shown in Table 15.2.5-1.

The SDS disposition notification type information element is a type 3 information element with a length of 1 octet.

Table 15.2.5-1: SDS disposition notification type

Bits
8	7	6	5	4	3	2	1

0	0	0	0	0	0	0	1	UNDELIVERED
0	0	0	0	0	0	1	0	DELIVERED
0	0	0	0	0	0	1	1	READ
0	0	0	0	0	1	0	0	DELIVERED AND READ
0	0	0	0	0	1	0	1	DISPOSITION PREVENTED BY SYSTEM (NOTE)

All other values are reserved. NOTE: Usage of this value is described in 3GPP TS 29.582 [48].

15.2.6 FD disposition notification type

The purpose of the FD disposition notification type information element is to identify the type of FD disposition notification sent from receiver to the sender.

The value part of the FD disposition notification type information element is coded as shown in Table 15.2.6-1.

The FD disposition notification type information element is a type 3 information element with a length of 1 octet.

Table 15.2.6-1: FD disposition notification type

Bits
8	7	6	5	4	3	2	1

0	0	0	0	0	0	0	1	FILE DOWNLOAD REQUEST ACCEPTED
0	0	0	0	0	0	1	0	FILE DOWNLOAD REQUEST REJECTED
0	0	0	0	0	0	1	1	FILE DOWNLOAD COMPLETED
0	0	0	0	0	1	0	0	FILE DOWNLOAD DEFERRED

All other values are reserved.

15.2.7 Application ID

The purpose of the Application ID information element is to uniquely identify the application for which the payload is intended.

The Application ID information element is coded as shown in figure 15.2.7-1 and table 15.2.7-1

The Application ID information element is a type 3 information element with a length of 2 octets.

8	7	6	5	4	3	2	1
Application ID IEI								octet1
Application ID value								octet 2

Figure 15.2.7-1: Application ID value

Table 15.2.7-1: Application ID value

Application ID value (octet 1)

The Application ID contains a number that uniquely identifies the destination application.

15.2.8 Date and time

The Date and time information element is used to indicate the UTC time when a message or file was sent.

The Date and time information element is coded as shown in Figure 15.2.8-1 and Table 15.2.8-1.

The Date and time information element is a type 3 information element with a length of 5 octets.

Date and time value

octet 1

octet 5

Figure 15.2.8-1: Date and time value

Table 15.2.8-1: Date and time value

Date and time value (octet 1 to 5)

The Date and time value is an unsigned integer containing UTC time of the time when a message was sent, in seconds since midnight UTC of January 1, 1970 (not counting leap seconds).

15.2.9 Conversation ID

The Conversation ID information element uniquely identifies the conversation.

The Conversation ID information element is coded as shown in Figure 15.2.9-1 and Table 15.2.9-1.

The Conversation ID information element is a type 3 information element with a length of 16 octets.

Conversation ID value

octet 1

octet 16

Figure 15.2.9-1: Conversation ID value

Table 15.2.9-1: Conversation ID value

Conversation identifier value (octet 1 to 16)

The Conversation ID contains a number uniquely identifying the conversation. The value is a universally unique identifier as specified in IETF RFC 4122 [14].

15.2.10 Message ID

The Message ID information element uniquely identifies a message within a conversation.

The Message ID information element is coded as shown in Figure 15.2.10-1 and Table 15.2.10-1.

The Message ID information element is a type 3 information element with a length of 16 octets.

Message ID value

octet 1

octet 16

Figure 15.2.10-1: Message ID value

Table 15.2.10-1: Message ID value

Message ID value (octet 1 to 16)

The Message ID contains a number uniquely identifying a message. The value is a universally unique identifier as specified in IETF RFC 4122 [14].

15.2.11 InReplyTo message ID

The InReplyTo message ID information element is used to associate a message within a conversation that is a reply to an existing message in a conversation.

The InReplyTo message ID information element is coded as shown in Figure 15.2.11-1 and Table 15.2.11-1.

The InReplyTo message ID information element is a type 3 information element with a length of 17 octets.

InReplyTo message ID IEI

octet 1

InReplyTo message ID value

octet 2

octet 17

Figure 15.2.11-1: InReplyTo message ID value

Table 15.2.11-1: InReplyTo Message ID value

InReplyTo message ID value (octet 2 to 17)

The InReplyTo message ID contains a number uniquely identifying a message. The value is a universally unique identifier as specified in IETF RFC 4122 [14].

15.2.12 Number of payloads

The Number of payloads information element identifies the number of payloads contained in the message.

The Number of payloads information element is coded as shown in Figure 15.2.12-1, Table 15.2.12-1.

The Number of payloads information element is a type 3 information element with a length of 1 octet.

8	7	6	5	4	3	2	1
Number of payloads								octet 1

Figure 15.2.12-1: Number of payloads information element

Table 15.2.12-1: Number of payloads information element

Number of payloads value (octet 1)

The Number of payloads contains a value from 1 to 255.

15.2.13 Payload

The Payload information element contains the payload intended for the recipient user or application;

The Payload information element is coded as shown in Figure 15.2.13-1, Table 15.2.13-1, Table 15.2.13-2 and Table 15.2.13-3.

The Payload information element is a type 6 information element.

8	7	6	5	4	3	2	1
Payload IEI								octet 1
Length of Payload contents								octet 2
								octet 3
								octet 4
Payload contents
								octet n

Figure 15.2.13-1: Payload information element

Table 15.2.13-1: Payload contents

8	7	6	5	4	3	2	1
Payload content type								octet 4
								octet 5
Payload data
								octet n

Table 15.2.13-2: Payload content type

Bits
8	7	6	5	4	3	2	1

0	0	0	0	0	0	0	1	TEXT
0	0	0	0	0	0	1	0	BINARY
0	0	0	0	0	0	1	1	HYPERLINKS
0	0	0	0	0	1	0	0	FILEURL
0	0	0	0	0	1	0	1	LOCATION
0	0	0	0	0	1	1	0	ENHANCED STATUS
0	0	0	0	0	1	1	1	Value allocated for use in interworking (NOTE)
0	0	0	0	1	0	0	0	LOCATION ALTITUDE
0	0	0	0	1	0	0	1	LOCATION TIMESTAMP

All other values are reserved.
NOTE: Usage of this value is described in 3GPP TS 29.582 [48].

Table 15.2.13-3: Payload data

Payload data is included in octet 5 to octet n; Max value of 65535 octets.

Payload data contains the payload destined for the user or application.

A file URL is encoded as specified in IETF RFC 1738 [70].

The length of location information payload content is 6 bytes. The first 3 bytes contain the latitude information and the next 3 bytes contain the longitude information coded as in clause 6.1 in 3GPP TS 23.032 [47].

The length of the location altitude payload content is 2 bytes coded as in clause 6.3 in 3GPP TS 23.032 [47].

The length of location timestamp is contained as a binary value in the first octet of the payload content, and the value of the location timestamp is contained in the remaining octets of the payload content in the format "yyyy-mm-dd hh:mm:ss.fffff" per ISO 8601 [73].

15.2.14 MCData group ID

The MCData group ID information element is used to indicate the destination MCData group identifier;

The MCData group ID information element is coded as shown in Figure 15.2.14-1 and Table 15.2.14-1.

The MCData group ID information element is a type 6 information element.

8	7	6	5	4	3	2	1
MCData group ID IEI								octet 1
Length of MCData group ID contents								octet 2
								octet 3
								octet 4
MCData group ID contents
								octet n

Figure 15.2.14-1: MCData group ID information element

Table 15.2.14-1: MCData group ID information element

MCData group ID is contained in octet 4 to octet n; Max value of 65535 octets.

15.2.15 MCData user ID

The MCData user ID information element is used to indicate an MCData user ID.

The MCData user ID information element is coded as shown in Figure 15.2.15-1 and Table 15.2.15-1.

The MCData user ID information element is a type 6 information element.

8	7	6	5	4	3	2	1
MCData user ID IEI								octet 1
Length of MCData user ID contents								octet 2
								octet 3
								octet 4
MCData user ID contents
								octet n

Figure 15.2.15-1: MCData user ID information element

Table 15.2.15-1: MCData user ID information element

MCData user ID is contained in octet 4 to octet n if the IE is used as an optional IE.
If used as a mandatory IE, MCData user ID IEI is omitted and MCData user ID is contained in octet 3 to octet n;
Max value of 65535 octets.

15.2.16 Mandatory download

The purpose of the Mandatory download information element is for the originating client to inform the terminating client that a file must be downloaded immediately.

The value part of the Mandatory download information element is coded as shown in Figure 15.2.16-1 and Table 15.2.16-1.

The Mandatory download information element is a type 1 information element.

8	7	6	5	4	3	2	1
Mandatory download IEI				Mandatory download value				octet 1

Figure 15.2.16-1: Mandatory download

Table 15.2.16-1: Mandatory download

Mandatory download value (octet 1)
Bits
4	3	2	1
0	0	0	1	MANDATORY DOWNLOAD
All other values are reserved.

15.2.17 Metadata

The Metadata information element is data that is used to describe a file.

The Metadata information element is coded as shown in Figure 15.2.17-1 and Table 15.2.17-1.

The Metadata information element is a type 6 information element.

8	7	6	5	4	3	2	1
Metadata IEI								octet 1
Length of Metadata contents								octet 2
								octet 3
								octet 4
Metadata contents
								octet n

Figure 15.2.17-1: Metadata information element

Table 15.2.17-1: Metadata information element

Metadata is contained in octet 4 to octet n; Max value of n is 65535 octets.

Metadata contains a concatenation of the following data:

– fileselector (which is a concatenation of filename, filesize, filetype and hash)

– file-date (which is set to "creation", "modification" or "read" with a date/time, to indicate date/time file was created, last modified or last read)

– file-availability (set to a date and time that the file is available until)

– file-description (which is set to text specifying description of file)

The file-selector is encoded as shown in the "file-selector-attr" ABNF specified in IETF RFC 5547 [69].

The file-date is encoded as shown in the "file-date-attr" ABNF specified in IETF RFC 5547 [69].

The file-availability is encoded as

file-availability = "file-availability:" date-time

;date-time is defined in IETF RFC 5322 [83]

The file-description is encoded as

file-description = "file-description:" <text to describe file>

15.2.18 Notification type

The purpose of the Notification type information element is to identify the type of notification sent from receiver to the sender.

The value part of the Notification type information element is coded as shown in Table 15.2.18-1.

The notification type information element is a type 3 information element with a length of 1 octet.

Table 15.2.18-1: Notification type

Bits
8	7	6	5	4	3	2	1

0	0	0	0	0	0	0	1	FILE EXPIRED UNAVAILABLE TO DOWNLOAD
0	0	0	0	0	0	1	0	FILE DELETED UNAVAILABLE TO DOWNLOAD

All other values are reserved.

15.2.19 Data query type

The purpose of the data query type information element is to identify the type of data information that the sender requires from the receiver.

The value part of the data query request type information element is coded as shown in Figure 15.2.19-1 and Table 15.2.19-1.

The data query request type information element is a type 1 information element with a length of 1 octet

8	7	6	5	4	3	2	1
Data query type IEI				Data query type value				octet 1

Figure 15.2.19-1: Data query type

Table 15.2.19-1: Data query type

Data query type value (octet 1)
Bits
4	3	2	1
0	0	0	1	REMAINING AMOUNT OF DATA

All other values are reserved.

15.2.20 Comm release Information type

The purpose of the comm release information type information element is to identify the type of communication release information that the sender wants to inform to the receiver.

The value part of the comm release information type information element is coded as shown in Table 15.2.20-1.

The comm release information type information element is a type 3 information element with a length of 1 octet

Table 15.2.20-1: Comm release Information type

Bits
8	7	6	5	4	3	2	1

0	0	0	0	0	0	0	1	INTENT TO RELEASE
0	0	0	0	0	0	1	0	EXTENSION REQUEST
0	0	0	0	0	0	1	1	EXTENSION RESPONSE
0	0	0	0	0	1	0	0	AUTH USER RELEASE REQ

All other values are reserved.

15.2.21 Extension response type

The purpose of the extension request type information element is to inform MCData server’s response towards MCData client’s request for extension of the MCData communication. This information element is used only when comm release information type IE takes "EXTENSION RESPONSE" value. The receiver can ignore Extension response type information element value if comm release information type IE takes any other value.

The value part of the Extension response type information element is coded as shown in Figure 15.2.21.1 and Table 15.2.21-1.

The Extension response type information element is a type 1 information element.

8	7	6	5	4	3	2	1
Extension response type IEI				Extension response type value				octet 1

Figure 15.2.21-1: Extension response type

Table 15.2.21-1: Extension response type

Extension response type value (octet 1)
Bits
4	3	2	1
0	0	0	1	ACCEPTED
0	0	1	0	REJECTED

All other values are reserved.

15.2.22 Termination Information type

The purpose of the Termination information type is to identify the type of termination request that the sender wants to inform to the receiver.

The value part of the Termination information type element is coded as shown in table 15.2.22-1.

The Termination information type is a type 3 information element with a length of 1 octet.

Table 15.2.22-1: Termination Information type

Bits
8	7	6	5	4	3	2	1

0	0	0	0	0	0	0	1	TERMINATION REQUEST
0	0	0	0	0	0	1	0	TERMINATION RESPONSE
0	0	0	0	0	0	1	1	TRANSMISSION STOPPED
0	0	0	0	0	1	0	0	INTENT TO RELEASE COMM OVER HTTP
0	0	0	0	0	1	0	1	EXTENSION REQUEST FOR COMM OVER HTTP
0	0	0	0	0	1	1	0	EXTENSION RESPONSE FOR COMM OVER HTTP
0	0	0	0	0	1	1	1	AUTH USER TERMINATION REQUEST FOR COMM OVER HTTP
All other values are reserved.

15.2.23 Release Response Type

The purpose of the Release Response Type information element is to inform MCData server’s response towards MCData client’s request for termination of the MCData communication. This information element is used only when Termination information type IE takes "TERMINATION RESPONSE" value. The receiver can ignore Release response type information element value if Termination information type IE takes any other value

The value part of the Release response type information element is coded as shown in figure 15.2.23-1 and table 15.2.23-1.

The Release Response Type information element is a type 1 information element.

8	7	6	5	4	3	2	1
Release Response Type IEI				Release Response Type value				octet 1

Figure 15.2.23-1: Release Response Type

Table 15.2.23-1: Release Response Type

Release Response Type value (octet 1)

Bits
4	3	2	1
0	0	0	1	RELEASE SUCCESS
0	0	1	0	RELEASE FAILED

All other values are reserved.

15.2.24 Extended application ID

The purpose of the Extended application ID information element is to uniquely identify the application for which the payload is intended when the format of the identifier used is not the format available in the Application ID.

The Extended application ID information element is coded as shown in figure 15.2.24-1, table 15.2.24‑1, table 15.2.24‑2 and table 15.2.24-3.

The Extended application ID information element is a type 6 information element.

8	7	6	5	4	3	2	1
Extended application ID IEI								octet 1
Length of Extended application ID contents								octet 2
								octet 3
Extended application ID contents								octet 4 octet n

Figure 15.2.24-1: Extended application ID value

Table 15.2.24-1: Extended application ID contents

8	7	6	5	4	3	2	1
Extended application ID content type								octet 4
								octet 5
Extended application ID data
								octet n

Table 15.2.24-2: Extended application ID content type

Bits
8	7	6	5	4	3	2	1

0	0	0	0	0	0	0	1	TEXT
0	0	0	0	0	0	1	0	URI

All other values are reserved.

Table 15.2.24-3: Extended application ID data

Extended application ID data is included in octet 5 to octet n; Max length 65534 octets.

Extended application ID data contains a value that uniquely identifies the destination application, encoded in the format specified by Extended application ID content type.

A URI is encoded as specified in IETF RFC 3986 [46].

15.2.25 User location

The User location information element is used to indicate the current location of the MCData client;

The User location information element is coded as shown in figure 15.2.25-1 and table 15.2.25-1.

The User location information element is a type 6 information element.

8	7	6	5	4	3	2	1
User location IEI								octet 1
Length of User location contents								octet 2
								octet 3
								octet 4
User location contents
								octet n

Figure 15.2.25-1: User location information element

Table 15.2.25-1: User location information element

User location is contained in octet 4 to octet n; Max value of 65535 octets.

The User location information element contains the LocationInfo structure defined in clause 7.4 of 3GPP TS 29.199‑09 [65].

15.2.26 Organization name

The Organization name information element is used to indicate the name of the organization to which the user belongs.

The Organization name information element is coded as shown in figure 15.2.26-1 and table 15.2.26-1.

The Organization name information element is a type 6 information element.

8	7	6	5	4	3	2	1
Length of Organization name contents								octet 1
								octet 2
								octet 3
Organization name contents
								octet n

Figure 15.2.26-1: Organization name information element

Table 15.2.26-1: Organization name information element

Organization name is contained in octet 3 to octet n; Max value of 65535 octets.

15.2.27 Deferred FD signalling payload

The Deferred FD signaling payload information element contains the signaling data payload of the FD request of the MCData client;

The Deferred FD signalling payload information element is coded as shown in figure 15.2.27-1 and table 15.2.27-1.

The Deferred FD signalling payload information element is a type 6 information element.

8	7	6	5	4	3	2	1
Deferred FD signalling payload IEI								octet 1
Length of Deferred FD signalling payload contents								octet 2
								octet 3
								octet 4
Deferred FD signalling payload contents
								octet n

Figure 15.2.27-1: Deferred FD signalling payload information element

Table 15.2.27-1: Deferred FD signalling payload contents

Deferred FD signalling payload contents are included in octet 4 to octet n; Max value of 65535 octets.

Deferred FD signalling payload contents contains the signalling content related to the FD data payload and coded as per 15.1.2.1.

15.2.28 Application metadata container

The Application metadata container information element is used to carry metadata specific to the application.

The Application metadata container information element is coded as shown in figure 15.2.28-1 and table 15.2.28-1.

The Application metadata container contents are coded per the ABNF syntax defined in table 15.2.28-2.

The Application metadata container information element is a type 6 information element.

The Application metadata container information element provides a means for the sender of the SDS or file to attach application-specific information to the SDS or file.

NOTE: For example, a police officer could send a data file with attached Application metadata container content: {value-end-delimiter=’#’}agency-ID=county-police-dept#incident-ID=N5Q432X1#injuries=3#

8	7	6	5	4	3	2	1
Application metadata container IEI								octet 1
Length of Application metadata container contents								octet 2
								octet 3
								octet 4
Application metadata container contents
								octet n

Figure 15.2.28-1: Application metadata container information element

Table 15.2.28-1: Application metadata container information element

Application metadata is contained in octet 4 to octet n;

Maximum value of n is 65536.

The Application metadata content is formatted per the syntax in table 15.2.28-2.

Table 15.2.28-2: Syntax of Application metadata content

Appl-metadata-content = "{" *delimiter-definition "}" 1*organization-attribute

delimiter-definition = *1tag-end-delimiter *1value-end-delimiter *1escape-character

tag-end-delimiter = "tag-delimiter" 1*VCHAR-restricted

value-end-delimiter = "value-delimiter" 1*VCHAR-restricted

escape-character = "escape" 1*VCHAR-restricted

organization-attribute = tag tag-end-delimiter attribute-value value-end-delimiter

tag = 1*VCHAR-restricted 0*(1*WSP 1*VCHAR-restricted)

attribute-value = 1*VCHAR-restricted 0*(1*WSP 1*VCHAR-restricted)

VCHAR = %x21-7E

; visible (printing) 7-bit US-ASCII characters per RFC5234 [75]

VCHAR-restricted = %x21-7A / %x7C / %x7E ;all visible characters except space, "{", and "}"

WSP = %x20 ; space character

If a delimiter is not defined, the default value shall be used.

The default tag-end-delimiter shall be ‘=’.

The default value-end-delimiter shall be ‘;’.

The default escape-character shall be ‘\’.

The values chosen for the tag-end-delimiter, the value-end-delimiter, and the escape-character shall all be unique.

An escape-character plus the next following character shall be treated as the value of the following character.
The following character shall not be treated as a tag-value-delimiter, a value-end-delimiter or an escape-character.

Editor’s Note: The definitions of tag and attribute-value should be enhanced to show the possible inclusion of an escape-character.

The tag can contain any visible (printing) 7-bit US-ASCII character except the tag-value-delimiter unless the character defined as the tag-value-delimiter is escaped using the escape-character.

The attribute-value can contain any visible (printing) 7-bit US-ASCII except the value-end-delimiter and the escape-character unless the character defined as the value-end-delimiter is escaped using the escape-character or the character defined as the escape-character is escaped using the escape-character. For example, if the escape-character is ‘\’, then the ‘\’ character can be included in the attribute-value by using ‘\\’.

Examples:

{}officer-name=John Smith;incident=123abc;

{tag-delimiter#}name#John Smith;incident#123abc;

{tag-delimitere}nam\eeJohn Smith;incid\ente123abcd\ef;

{value-delimiter%}name=John Smith%incident=123abc%

{tag-delimiter:value-delimiter|}FirstName:John|LastName:Smith|