AS Registrations

/registrations

POST

Registers a new AS at the MSGin5G Server.

AS DeRegistration

/registrations/{registrationId}

DELETE

Removes an AS registration resource.

apiRoot

string

See clause 7.5

apiVersion

string

See clause 8.1.1

n/a

ASRegistration

M

1

AS registration request information.

ASRegistrationAck

M

1

201 Created

AS information is registered successfully at MSGin5G Server.

The URI of the created resource shall be returned in the "Location" HTTP header.

NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] shall also apply.

n/a

Location

String

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/msgs-asregistration/<apiVersion>/registrations/{registrationId}

n/a

apiRoot

string

See clause 7.5

apiVersion

string

See clause 8.1.1

registrationId

string

The AS registration resource id

n/a

n/a

ASRegistrationAck

M

1

200 OK

The AS DeRegistration information matching the registrationId is deleted.

n/a

204 No Content

Successful response. The individual AS registration matching the registrationId is successfully deleted.

NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] shall also apply.

n/a

n/a

n/a

ASRegistration

8.1.5.2.2

The AS registration request information.

ASRegistrationAck

8.1.5.2.3

The AS registration response information.

ASProfile

8.1.5.2.4

The profile information related to the AS in the ASRegistration data type.

ProblemDetails

3GPP TS 29.571 [5]

Uri

3GPP TS 29.571 [5]

asSvcId

string

M

1

The MSGin5G identifier of the Application Server.

appId

string

O

0..1

The identifier of the application specified by the application provider

targetUri

Uri

O

0..1

The URL for receiving message, message delivery status report, etc. The MSGin5G Server uses this URL to interact to AS.

asProf

ASProfile

O

0..1

The profile information of the AS.

asSvcId

string

M

1

The MSGin5G identifier of the Application Server.

result

ProblemDetails

M

1

The result of the registration.

appName

string

O

1

The name of the Application Server

appProviders

array(string)

O

1..N

The provider of the Application Server

appSenarios

array(string)

O

1..N

The application scenario description.

appCategory

string

O

0..1

The category or type of Application Server.

asStatus

string

O

0..1

AS status (e.g. Enabled, Disabled etc.)

{apiRoot}/msgs-msgdelivery/<apiVersion>/deliver-as-message

POST

Request of AS to deliver message to a given MSGin5G Server.

{apiRoot}/msgs-msgdelivery/<apiVersion>/deliver-ue-message

POST

Request of Message Gateway (on behalf of Legacy 3GPP UE or Non-3GPP UE) to deliver message to a given MSGin5G Server.

{apiRoot}/msgs-msgdelivery/<apiVersion>/deliver-report

POST

Request of Message Gateway (on behalf of Legacy 3GPP UE or Non-3GPP UE) to deliver status report to a given MSGin5G Server.

ASMessageDelivery

M

1

Represents the data to be used for AS to deliver message.

MessageDeliveryAck

M

1

200 OK

AS Message is delivered successfully.

NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

UEMessageDelivery

M

1

Represents the data to be used for Message Gateway (on behalf of Legacy 3GPP UE or Non-3GPP UE) to deliver message.

MessageDeliveryAck

M

1

200 OK

UE Message is delivered successfully.

NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

DeliveryStatusReport

M

1

Represents the data to be used for Message Gateway (on behalf of Legacy 3GPP UE or Non-3GPP UE) or the Application Server to deliver status report.

MessageDeliveryAck

M

1

200 OK

The status report is delivered successfully.

NOTE: The manadatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

ASMessageDelivery

8.2.5.2.2

The AS message delivery request information.

DeliveryStatus

8.2.5.3.3

Indicates if delivery is a failure, or if the message is stored for deferred delivery.

DeliveryStatusReport

8.2.5.2.7

The message delivery status report request information.

MessageDeliveryAck

8.2.5.2.4

The message delivery response information.

MessageSegmentParameters

8.2.5.2.5

Contains the message segment information of the message.

Priority

8.2.5.3.5

Application priority level requested for this message.

ReportDeliveryStatus

8.2.5.3.4

The delivery status description, including success or failure in delivery.

StoreAndForwardParameters

8.2.5.2.6

Contains the store forward information of the message.

UEMessageDelivery

8.2.5.2.3

The UE message delivery request information.

Address

9.1.5.2.3

The data type of the oriAddr and destAddr.

DateTime

3GPP TS 29.571 [5]

String with format "date-time" as defined in OpenAPI Specification [6].

oriAddr

Address

M

1

The service identity of the sending Application Server (NOTE).

destAddr

Address

M

1

The service identity of the receiving Legacy 3GPP UE, Non-3GPP UE or MSGin5G UE.

The service identifier of the target MSGin5G Group.

The service identifier of the Broadcast Service Area where the message needs to be broadcast.

Indicates which Messaging Topic this message is related to.

appId

string

O

0..1

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.

msgId

string

M

1

Unique identifier of this message.

secCred

string

O

0..1

Security information required by the MSGin5G Server.

This is a placeholder for SA3 security information.

delivStReqInd

boolean

O

0..1

Indicates if delivery acknowledgement from the recipient is requested.

Set to "true" if delivery acknowledgement from the recipient is requested. otherwise set to "false". Default value is "false".

payload

string

O

0..1

Payload of the message.

priority

Priority

O

0..1

Application priority level requested for this message.

segInd

boolean

O

0..1

Indicates this message is part of a segmented message.

Set to "true" if the message is part of a segmented message. otherwise set to "false". Default value is "false".

segParams

MessageSegmentParameters

O

0..1

The message segment parameters.

This IE shall be included only if the value of the message Segment Flag IE indicates that message Segment services are requested.

stoAndFwInd

boolean

M

1

An indicator of whether store and forward services are requested for this message.

Set to "true" if it is required to store and forward services for this message. otherwise set to "false".

stoAndFwParams

StoreAndForwardParameters

O

0..1

Parameters used by MSGin5G Server for providing store and forward services, This IE shall be included only if the value of the Store and forward flag IE indicates that store and forward services are requested.

latency

integer

O

0..1

The latency requirement for the message which only applies to AS Originating MSGin5G Message. Unit: millisecond.

NOTE: Only "AS" is applicable to the addrType attribute in the Address data type to represent the originating type of message request.

oriAddr

Address

M

1

The service identity of the sending Legacy 3GPP UE or Non-3GPP UE (NOTE).

destAddr

Address

M

1

The service identity of the receiving Application Server or MSGin5G UE.

appId

string

O

0..1

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.

msgId

string

M

1

Unique identifier of this message.

secCred

string

O

0..1

Security information required by the MSGin5G Server.

This is a placeholder for SA3 security information.

delivStReqInd

boolean

O

0..1

Indicates if delivery acknowledgement from the recipient is requested.

Set to "true" if delivery acknowledgement from the recipient is requested. otherwise set to "false". Default value is "false".

payload

string

O

0..1

Payload of the message.

segInd

boolean

O

0..1

Indicates this message is part of a segmented message.

Set to "true" if the message is part of a segmented message. otherwise set to "false". Default value is "false".

segParams

MessageSegmentParameters

O

0..1

The message segment parameters.

This IE shall be included only if the value of the message Segment Flag IE indicates that message Segment services are requested.

stoAndFwInd

boolean

M

1

An indicator of whether store and forward services are requested for this message.

Set to "true" if it is required to store and forward services for this message. otherwise set to "false".

stoAndFwParams

StoreAndForwardParameters

O

0..1

Parameters used by MSGin5G Server for providing store and forward services, This IE shall be included only if the value of the Store and forward flag IE indicates that store and forward services are requested.

NOTE: Only "UE" is applicable to the addrType attribute in the Address data type to represent the originating type of message request.

oriAddr

Address

M

1

The service identity of the sending Legacy 3GPP UE, Non-3GPP UE or the sending Application Server (NOTE).

msgId

string

M

1

Unique identifier of this message.

status

DeliveryStatus

O

0..1

Indicates if delivery is a failure, or if the message is stored for deferred delivery.

failureCause

string

C

0..1

The reason for failure.

May only be present if the "status" attribute is set to "DELY_FAILED".

NOTE: Either "UE" or "AS" shall be included in the "addrType" attribute within the Address data type to represent the originating type of message request.

segId

string

O

0..1

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.

totalSegCount

integer

O

0..1

Indicates the total number of segments for the message.

segNumb

integer

O

0..1

Indicates segmented message number of each segmented message within a set of segmented messages.

lastSegFlag

boolean

O

0..1

An indicator of whether this segmented message is the last segment in the set of segmented messages or not.

Set to "true" if the segmented message is the last segment in the set of segmented messages. otherwise set to "false". Default value is "false".

exprTime

DateTime

O

0..1

Indicates message expiration time.

oriAddr

Address

M

1

The service identity of the sending Legacy 3GPP UE, Non-3GPP UE or the sending Application Server (NOTE).

destAddr

Address

M

1

The service identity of the receiving Legacy 3GPP UE, Non-3GPP UE or the receiving Application Server (NOTE).

msgId

string

M

1

Unique identifier of this message.

secCred

string

O

0..1

Security information required by the MSGin5G Server.

This is a placeholder for SA3 security information.

failureCause

string

C

0..1

The Failure Cause indicates the failure reason, if applicable.

May only be present if the ReportDeliveryStatus sets to "REPT_DELY_FAILED".

delivSt

ReportDeliveryStatus

M

1

The delivery status description, including success or failure in delivery.

NOTE: Either "UE" or "AS" shall be included in the addrType attribute in Address data type to represent the originating type of message request.

DELY_FAILED

Indicates that the message delivery is failed.

DELY_STORED

Indicates that the message is stored for deferred delivery.

REPT_DELY_SUCCESS

Indicates that the report delivery is successful.

REPT_DELY_FAILED

Indicates that the report delivery is failed.

HIGH

Indicates the messages should be sent in high priority.

MIDDLE

Indicates the messages should be sent in middle priority.

LOW

Indicates the messages should be sent in low priority.