A.2 Based on standard L3 message

24.5383GPPEnabling MSGin5G ServiceProtocol specificationRelease 17TS

The following clauses describe an example based on standard L3 message as specified in clause 11.2 of 3GPP TS 24.007 [15].

Each message definition in the clause includes a brief description of the message direction, the use, and the significance indicates whether the message is relevant only on the sender or receiver (local) or the message is relevant on both sender and receiver (dual).

NOTE: Message format defined in this clause can be used if the communication between the Constrained UE and the MSGin5G GW UE is based on PC5 / NR-PC5.

A.2.1 Message contents and functions

A.2.1.1 for sending a message to MSGin5G Client

For sending a message to MSGin5G Client, the Application Client may use the message content specified in Table A.2.1.1-1.

Message type: MESSAGE SENDING REQUEST

Significance: dual

Direction: the Application Client of the Constrained UE to the MSGin5G Client of the MSGin5G Gateway UE

Table A.2.1.1-1: message content for sending a message to MSGin5G Client

IEI

Information Element

Type/Reference

Presence

Format

Length

Message Type

Message Type

A.2.2.1

M

V

1

Target address

Target address
A.2.2.2

M

LV

6-n

Message ID

Message ID
A.2.2.4

M

V

16

Payload

Payload

A.2.2.5

M

LV-E

3-65537

A

Application ID

Application ID
A.2.2.3

O

TV

3

B

Delivery status required

Delivery status required

A.2.2.6

O

TV

1

D

Target Type

Target Type

A.2.2.7

O

TV

1

If using the message content specified in table A.2.1.1-1, the Application Client may generate a message according to 6.4.2.3.1 and send the generated message to the MSGin5G Client.

A.2.1.2 for sending a message delivery report to MSGin5G Client

For sending a message delivery status report to MSGin5G Client, the Application Client may use the message content specified in Table A.2.1.2-1.

Message type: DELIVERY REPORT SENDING REQUEST

Significance: dual

Direction: the Application Client of the Constrained UE to the MSGin5G Client of the MSGin5G Gateway UE

Table A.2.1.2-1: message content for sending a message delivery status report to MSGin5G Client

IEI

Information Element

Type/Reference

Presence

Format

Length

Message Type

Message Type

A.2.2.1

M

V

1

Delivery Status

Delivery Status
A.2.2.8

M

V

1

Message ID

Message ID

A.2.2.4

M

V

16

Reply-to Message ID

Reply-to Message ID
A.2.2.13

M

V

16

If using the message content specified in table A.2.1.2-1, the Application Client may generate a message according to 6.4.2.3.2 and send the generated message to the MSGin5G Client.

A.2.1.3 for sending a message to Application Client

For sending a message to Application Client, the MSGin5G Client may use the message content specified in Table A.2.1.3-1.

Message type: MESSAGE RECEIVED REQUEST

Significance: dual

Direction: the MSGin5G Client of the MSGin5G Gateway UE to the Application Client of the Constrained UE

Table A.2.1.3-1: message content for sending a message to Application Client

IEI

Information Element

Type/Reference

Presence

Format

Length

Message Type

Message Type

A.2.2.1

M

V

1

Message ID

Message ID
A.2.2.4

M

V

16

Payload

Payload

A.2.2.5

M

LV-E

2-65537

F

Originator Address

Originator Address

A.2.2.10

O

TLV

3-257

E

Group ID

Group ID
A.2.2.11

O

TLV

3-257

B

Delivery status required

Delivery status required

A.2.2.6

O

TV

1

C

Priority

Priority

A.2.2.9

O

TV

1

If using the message content specified in table A.2.1.3-1, the MSGin5G Client may generate a message according to 6.4.2.2.1 and send the generated message to the Application Client.

A.2.1.4 for sending a message delivery status report to Application Client

For sending a message delivery status report to Application Client, the MSGin5G Client may use the message content specified in Table A.2.1.4-1.

Message type: DELIVERY REPORT RECEIVED REQUEST

Significance: dual

Direction: the MSGin5G Client of the MSGin5G Gateway UE to the Application Client of the Constrained UE

Table A.2.1.4-1: message content for sending a message delivery status report to MSGin5G Client

IEI

Information Element

Type/Reference

Presence

Format

Length

Message Type

Message Type

A.2.2.1

M

V

1

Delivery Status

Delivery Status
A.2.2.8

M

V

1

Message ID

Message ID

A.2.2.4

M

V

16

Reply-to Message ID

Reply-to Message ID
A.2.2.13

M

V

16

If using the message content specified in table A.2.1.4-1, the MSGin5G Client may generate a message according to 6.4.2.2.3 and send the generated message to the Application Client.

A.2.1.5 for sending a message sending response to Application Client

For sending a message sending response to Application Client, the MSGin5G Client may use the message content specified in Table A.2.1.5-1.

Message type: MESSAGE SENDING RESPONSE

Significance: dual

Direction: the MSGin5G Client of the MSGin5G Gateway UE to the Application Client of the Constrained UE

Table A.2.1.5-1: message content for message sending response

IEI

Information Element

Type/Reference

Presence

Format

Length

Message Type

Message Type

A.2.2.1

M

V

1

Result

Result

A.2.2.11

M

V

1

Spare half octet

Spare half octet

A.2.2.18

M

V

1/2

X

Failure Reason

MSGin5G cause

A.2.2.17

O

TV

2

If using the message content specified in table A.2.1.5-1, the MSGin5G Client may generate a message according to 6.4.2.2.3 and send the generated message to the Application Client.

A.2.1.6 for sending a message received response to MSGin5G Client

For sending a message sending response to MSGin5G Client, the Application Client of the Constrained UEmay use the message content specified in Table A.2.1.6-1.

Message type: MESSAGE RECEIVED RESPONSE

Significance: dual

Direction: the Application Client of the Constrained UE to the MSGin5G Client of the MSGin5G Gateway UE

Table A.2.1.6-1: message content for message sending response

IEI

Information Element

Type/Reference

Presence

Format

Length

Message Type

Message Type

A.2.2.1

M

V

1

Result

Result

A.2.2.11

M

V

1

Spare half octet

Spare half octet

A.2.2.18

M

V

1/2

X

Failure Reason

MSGin5G cause

A.2.2.17

O

TV

2

If using the message content specified in table A.2.1.6-1, the Application Client may generate a message according to 6.4.2.3.3 and send the generated message to the MSGin5G Client.

A.2.1.7 Registration Request

The Registration Request is sent by the Application Client of the Constrained UE to the MSGin5G Client of the MSGin5G Gateway UE to initiate registration. See table A.2.1.7.

Message type: REGISTRATION REQUEST

Significance: dual

Direction: the Application Client of the Constrained UE to the MSGin5G Client of the MSGin5G Gateway UE

Table A.2.1.7: REGISTRATION REQUEST content

IEI

Information Element

Type/Reference

Presence

Format

Length

Message Type

Message Type

A.2.2.1

M

V

1

Application ID

Application ID

A.2.2.3

M

V

2

Credential information

Credential information

A.2.2.15

M

LV

3-65537

A.2.1.8 Registration Accept

The Registration Accept is sent by the MSGin5G Client of the MSGin5G Gateway UE to the Application Client of the Constrained UE to indicate the registration is accepted. See table A.2.1.8.

Message type: REGISTRATION ACCEPT

Significance: dual

Direction: the MSGin5G Client of the MSGin5G Gateway UE to the Application Client of the Constrained UE

Table A.2.1.8: REGISTRATION ACCEPT content

IEI

Information Element

Type/Reference

Presence

Format

Length

Message Type

Message Type

A.2.2.1

M

V

1

Registration ID

MSCin5G Registration ID

A.2.2.16

M

V

6

A.2.1.9 Registration Reject

The Registration Reject is sent by the MSGin5G Client of the MSGin5G Gateway UE to the Application Client of the Constrained UE to indicate the registration is rejected. See table A.2.1.9.

Message type: REGISTRATION REJECT

Significance: dual

Direction: the MSGin5G Client of the MSGin5G Gateway UE to the Application Client of the Constrained UE

Table A.2.1.9: REGISTRATION REJECT content

IEI

Information Element

Type/Reference

Presence

Format

Length

Message Type

Message Type

A.2.2.1

M

V

1

Failure Reason

MSGin5G cause

A.2.2.17

M

V

1

A.2.1.10 De-registration Request

The De-registration Request is sent by the Application Client of the Constrained UE to the MSGin5G Client of the MSGin5G Gateway UE to initiate de-registration. See table A.2.1.10.

Message type: DEREGISTRATION REQUEST

Significance: dual

Direction: the Application Client of the Constrained UE to the MSGin5G Client of the MSGin5G Gateway UE

Table A.2.1.10: DEREGISTRATION REQUEST content

IEI

Information Element

Type/Reference

Presence

Format

Length

Message Type

Message Type

A.2.2.1

M

V

1

Registration ID

MSCin5G Registration ID

A.2.2.16

M

V

6

A.2.1.11 De-registration Accept

The De-registration Accept is sent by the MSGin5G Client of the MSGin5G Gateway UE to the Application Client of the Constrained UE to indicate the de-registration is accepted. See table A.2.1.11.

Message type: DEREGISTRATION ACCEPT

Significance: dual

Direction: the MSGin5G Client of the MSGin5G Gateway UE to the Application Client of the Constrained UE

Table A.2.1.11: DEREGISTRATION ACCEPT content

IEI

Information Element

Type/Reference

Presence

Format

Length

Message Type

Message Type

A.2.2.1

M

V

1

Registration ID

MSCin5G Registration ID

A.2.2.16

M

V

6

A.2.1.12 De-registration Reject

The De-registration Reject is sent by the MSGin5G Client of the MSGin5G Gateway UE to the Application Client of the Constrained UE to indicate the de-registration is rejected. See table A.2.1.12.

Message type: DEREGISTRATION REJECT

Significance: dual

Direction: the MSGin5G Client of the MSGin5G Gateway UE to the Application Client of the Constrained UE

Table A.2.1.12: DEREGISTRATION REJECT content

IEI

Information Element

Type/Reference

Presence

Format

Length

Message Type

Message Type

A.2.2.1

M

V

1

Failure Reason

MSGin5G cause

A.2.2.17

M

V

1

A.2.2 information elements coding

A.2.2.1 Message Type

The purpose of the Message type information element is to identify the type of the request or response.

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

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

Table A.2.2.1-1: Message types

Bits

8

7

6

5

4

3

2

1

0

0

0

0

0

0

0

1

MESSAGE SENDING REQUEST

0

0

0

0

0

0

1

0

MESSAGE SENDING RESPONSE

0

0

0

0

0

0

1

1

MESSAGE RECEIVED REQUEST

0

0

0

0

0

1

0

0

MESSAGE RECEIVED RESPONSE

0

0

0

0

0

1

0

1

DELIVERY REPORT SENDING REQUEST

0

0

0

0

0

1

1

0

DELIVERY REPORT RECEIVED REQUEST

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

1

1

1

1

1

1

0

0

0

0

1

1

0

0

1

1

0

1

0

1

0

1

0

REGISTRATION REQUEST

REGISTRATION ACCEPT

REGISTRATION REJECT

DEREGISTRATION REQUEST

DEREGISTRATION REJECT

DEREGISTRATION ACCEPT

All other values are reserved.

A.2.2.2 Target address

The Target address information element is used to indicate the address of target recipient or the target group while sending message from Constrained UE.

The Target address information element is coded as shown in figure A.2.2.2-1 and table A.2.2.2-1.

The Target address information element is a type 4 information element.

8

7

6

5

4

3

2

1

Length of Target address contents

octet 1

Target address type value

octet 2

octet 3

Target address contents

octet n

Figure A.2.2.2-1: Target address information element

Table A.2.2.2-1: Target address information element

Target Address type value (octet 2)

Bits

7

6

5

4

3

2

1

0

0

0

0

0

0

1

IPv4 address

0

0

0

0

0

1

0

IPv6 address

0

0

0

0

0

1

1

FQDN

All other values are reserved.

Target address content is contained in octet 6 to octet n; The maximum value depends on the length of FQDN.

If Target address type value indicates IPv4 address, the Target address contents in octet 3 to octet 6 contains an IPv4 address.

If Target address type value indicates IPv6 address, the Target address contents in octet 3 to octet 18 contains an IPv6 address.

If Target address type indicates FQDN, the Target address contents in octet 3 to octet n contains an FQDN encoded as defined in clause 28.3.2 of 3GPP TS 23.003 [18].

A.2.2.3 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 A.2.2.3-1 and table A.2.2.3-1

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

8

7

6

5

4

3

2

1

Application ID IEI

octet1

Application ID value

octet 2

octet 3

Figure A.2.2.3-1: Application ID value

Table A.2.2.3-1: Application ID value

Application ID value (octet 2-3)

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

A.2.2.4 Message ID

The Message ID information element uniquely identifies a message or message delivery report.

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

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

8

7

6

5

4

3

2

1

Message ID value

octet 1

octet 16

Figure A.2.2.4-1: Message ID value

Table A.2.2.4-1: Message ID value

Message ID value (octet 1 to 16)

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

A.2.2.5 Payload

The Payload information element is used to send application specific message;

The Payload information element is coded as shown in Figure A.2.2.5-1 and Table A.2.2.5-1.

The Payload data information element is a type 6 information element.

8

7

6

5

4

3

2

1

Length of Payload contents

octet 1

octet 2

octet 3

Payload contents

octet n

Figure A.2.2.5-1: Payload information element

Table A.2.2.5-1: Payload information element

Payload data is contained in octet 3 to octet n; Max value of 65535 octets.

A.2.2.6 Delivery Status Required

The purpose of the Delivery Status Required information element is to identify whether delivery status is required from the receiver or not.

The value part of the Delivery Status Required information element is coded as shown in Figure A.2.2.6-1 and Table A.2.2.6-1.

The Delivery Status Required information element is a type 1 information element.

8

7

6

5

4

3

2

1

Delivery Status Required IEI

Delivery Status Required value

octet 1

Figure A.2.2.6-1: Delivery Status Required type

Table A.2.2.6-1: Delivery Status Required type

Delivery status value (octet 1)

Bits

4

3

2

1

0

0

0

0

DELIVERY REPORT NOT REQUIRED

0

0

0

1

DELIVERY REPORT REQUIRED

All other values are reserved.

A.2.2.7 Target Type

The purpose of the Target Type information element is to indicate the type of the message target.

The value part of the Target Type information element is coded as shown in Figure A.2.2.7-1 and Table A.2.2.7-1.

The Target Type information element is a type 1 information element.

8

7

6

5

4

3

2

1

Target Type IEI

Target Type value

octet 1

Figure A.2.2.7-1: Target Type type

Table A.2.2.7-1: Target Type type

E2E Message type value (octet 1)

Bits

4

3

2

1

0

0

0

0

UE

0

0

0

1

GROUP

0

0

1

0

AS

All other values are reserved.

A.2.2.8 Delivery Status

The Delivery Status information element is used to indicate the delivery status from message recipient.

The Delivery Status information element is coded as shown in Figure A.2.2.8-1 and Table A.2.2.8-1.

The Delivery Status information element is a type 3 information element.

8

7

6

5

4

3

2

1

Delivery Status value

octet 1

Figure A.2.2.8-1: Delivery Status type

Table A.2.2.8-1: Delivery Status type

Delivery status value (octet 1)

Bits

8

7

6

5

4

3

2

1

0

0

0

0

0

0

0

0

FAILED

0

0

0

0

0

0

0

1

SUCCESS

All other values are reserved.

A.2.2.9 Priority

The purpose of the priority information element is to identify application level priority of the received message.

The value part of the priority information element is coded as shown in Figure 2.2.9-1 and Table 2.2.9-1.

The priority type information element is a type 1 information element.

8

7

6

5

4

3

2

1

Priority IEI

Priority value

octet 1

Figure 2.2.9-1: Priority type

Table 2.2.9-1: Priority type

Priority type value (octet 1)

Bits

4

3

2

1

0

0

0

0

LOW

0

0

0

1

MEDIUM

0

0

1

0

HIGH

All other values are reserved.

A.2.2.10 Originator Address

The Originator Address information element is used to indicate address of originating UE/AS while sending message to Constrained UE.

The Originator Address information element is coded as shown in Figure A.2.2.10-1 and Table A.2.2.10-1.

The Originator Address information element is a type 4 information element.

8

7

6

5

4

3

2

1

Originator Address TEI

octet 1

Length of Originator Address contents

octet 2

octet 3

Originator Address contents

octet n

Figure A.2.2.10-1: Originator Address information element

Table A.2.2.10-1: Originator Address information element

Originator Address is contained in octet 3 to octet n; Max value of 255 octets.

A.2.2.11 Group ID

The Group ID information element is used to indicate the group which the message is from while sending message to Constrained UE.

The Group ID information element is coded as shown in Figure A.2.2.11-1 and Table A.2.2.11-1.

The Group ID information element is a type 4 information element.

8

7

6

5

4

3

2

1

Group ID IEI

octet 1

Length of Group ID contents

octet 2

octet 3

Group ID contents

octet n

Figure A.2.2.11-1: Group ID information element

Table A.2.2.11-1: Group ID information element

Group ID is contained in octet 3 to octet n; Max value of 255 octets.

A.2.2.11 Result

The Result information element is used to indicate the result of handling message sending request as described in A.2.1.1.

The Result information element is coded as shown in Figure A.2.2.11-1 and Table A.2.2.11-1.

The Result information element is a type 1 information element.

8

7

6

5

4

3

2

1

Result value

octet 1

Figure A.2.2.11-1: Result type

Table A.2.2.11-1: Result type

Result value (octet 1)

Bits

4

3

2

1

0

0

0

0

FAILED

0

0

0

1

SUCCESS

All other values are reserved.

A.2.2.12 Void

A.2.2.13 Reply-to Message ID

The Reply-to Message ID information element uniquely identifies the message delivery report and is same with the Message ID included in the message acknowledged.

The Reply-to Message ID information element is coded as shown in Figure A.2.2.13-1 and Table A.2.2.13-1.

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

8

7

6

5

4

3

2

1

Reply-to Message ID value

octet 1

octet 16

Figure A.2.2.13-1: Reply-to Message ID value

Table A.2.2.13-1: Reply-to Message ID value

Reply-to Message ID value (octet 1 to 16)

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

A.2.2.14 Void

A.2.2.15 Credential information

The purpose of the Credential information information element is to carrie credentials from a credentials holder(e.g. application server, the MSGin5G Gateway UE).

The Credential information information element is coded as shown in Figure A.2.2.15-1 and Table A.2.2.15-1.

The Credential information information element is a type 6 information element with a minimum length of 3 octets and a maximum length of 65537 octets.

8

7

6

5

4

3

2

1

Length of Credential information contents

octet 1

octet 2

octet 3

Credential information contents

octet n

Figure A.2.2.15-1: Credential information information element

Table A.2.2.15-1: Credential information information element

Payload data is contained in octet 3 to octet n; Max value of 65535 octets.

The format of the Credential information contents is out of scope of this specification.

A.2.2.16 MSCin5G Registration ID

The purpose of the MSCin5G Registration ID information element is to indicate the Registration ID that is allocated by the MSGin5G Client of the MSGin5G Gateway UE.

The MSCin5G Registration ID is a type 3 information element with a length of 6 octets.

The MSCin5G Registration ID information element is coded as shown in figure A.2.2.16 and table A.2.2.16.

8

7

6

5

4

3

2

1

MSCin5G Registration ID value

octet 1

octet 6

Figure A.2.2.16: MSCin5G Registration ID information element

Table A.2.2.16: MSCin5G Registration ID information element

MSCin5G Registration ID (octet 1 to 6)

This field contains the 48-bit MSCin5G Registration ID.

A.2.2.17 MSGin5G cause

The purpose of the MSGin5G cause information element is to indicate the cause used for MSGin5G procedures.

The MSGin5G cause is a type 3 information element with a length of 2 octets.

The MSGin5G cause information element is coded as shown in figure A.2.2.17 and table A.2.2.17.

8

7

6

5

4

3

2

1

MSGin5G cause IEI

octet 1

MSGin5G cause value

octet 2

Figure A.2.2.17: MSGin5G cause information element

Table A.2.2.17: MSGin5G cause information element

MSGin5G cause (octet 2)

Bits

8

7

6

5

4

3

2

1

0

0

0

0

0

0

0

1

Access via a Gateway UE is not allowed

0

0

0

0

0

0

1

0

Invalid credentials

0

0

0

0

0

0

1

1

Conflict of transport identifier for unicast communication is detected

0

0

0

0

0

1

0

0

Connection is not available anymore

0

0

0

0

0

1

0

1

Lack of resources for lower layer

0

0

0

0

0

1

1

0

Congestion situation

0

0

0

0

0

1

1

1

Unknown device

0

1

1

0

1

1

1

1

Protocol error, unspecified

Any other value received by the UE shall be treated as 0110 1111, "protocol error, unspecified".

A.2.2.18 Spare half octet

This element is used in the L3 messages as specified in clause A.2.1 when an odd number of half octet type 1 information elements are used. This element is filled with spare bits set to zero and is placed in bits 5 to 8 of the octet unless otherwise specified.