Content for TS 23.554 Word version: 19.3.0
1…
4…
5…
5.3…
5.5…
6…
7…
8…
8.2…
8.2.7…
8.2.11
8.3…
8.3.5…
8.4…
8.4.3
8.5…
8.6…
8.7…
8.7.2…
8.7.3…
8.7.4…
8.7.5…
8.7.6…
8.8…
8.9…
8.10…
8.11…
9…
9.2…
10…
11…
9 APIs and related information flows
9.1 APIs provided by MSGin5G Server
9.1.1 Mm5s APIs
9.1.1.1 M5S_AS_Originating_Message_Delivery API
9.1.1.2 M5S_UE_Originating_Message_Delivery API
9.1.1.3 M5S_AS_Originating_Delivery_Status_Report API
9.1.1.4 M5S_Delivery_Status_Report API
9.1.1.5 M5S_AS_Registration API
9.1.1.6 M5S_Topiclist_Event API
9.1.2 Mm5s Information flows
9.1.2.1 M5S Application Server originating message send request
9.1.2.2 M5S Application Server originating message delivery status report request
9.1.2.3 M5S Application Server registration request
9.1.2.4 M5S Application Server registration response
9.1.2.5 M5S Application Server de-registration request
9.1.2.6 M5S Application Server de-registration response
9.1.2.7 M5S Send_MSGin5G_Message response notification
...
...
9 APIs and related information flows p. 132
9.1 APIs provided by MSGin5G Server p. 132
9.1.1 Mm5s APIs p. 132
9.1.1.1 M5S_AS_Originating_Message_Delivery API p. 132
9.1.1.1.1 General p. 132
API description:
This API enables the Application Server to send MSGin5G message to the MSGin5G Server, and enables the MSGin5G Server to send MSGin5G message response notification to the Application Server.
9.1.1.1.2 Send_MSGin5G_Message operation p. 132
API operation name:
Send_MSGin5G_Message
Description:
Send an MSGin5G message to MSGin5G Server.
Known Consumers:
Application Server
Inputs:
Refer subclause 9.1.2.1
Outputs:
Refer subclause 8.3.2
See subclause 8.3.2 for the details of usage of this API operation.
9.1.1.1.3 Send_MSGin5G_Message response notification operation |R19| p. 132
API operation name:
Send_MSGin5G_Message response notification
Description:
Send an MSGin5G message response notification to Application Server.
Known Consumers:
Application Server
Inputs:
Refer subclause 9.1.2.7
Outputs:
Refer the MSGin5G_Message response in subclause 8.3.2
See subclause 8.3.2 for the details of usage of this API operation.
9.1.1.2 M5S_UE_Originating_Message_Delivery API p. 132
9.1.1.2.1 General p. 132
API description:
This API enables the Message Gateway or other 5GS Function to deliver MSGin5G message to the MSGin5G Server.
9.1.1.2.2 Send_ MSGin5G_Message operation p. 132
API operation name:
Send_MSGin5G_Message
Description:
Send an MSGin5G message to MSGin5G Server.
Known Consumers:
L3G, N3G.
Inputs:
Refer subclause 8.3.2
Outputs:
Refer subclause 8.3.2
See subclause 8.3.2 for the details of usage of this API operation.
9.1.1.3 M5S_AS_Originating_Delivery_Status_Report API p. 133
9.1.1.3.1 General p. 133
API description:
This API enables the Application Server to delivery MSGin5G message delivery status report to the MSGin5G Server.
9.1.1.3.2 Report_Message_Delivery_Status operation p. 133
API operation name:
Report_Message_Delivery_Status
Description:
Send an MSGin5G message delivery status report to MSGin5G Server.
Known Consumers:
Application Server
Inputs:
Refer subclause 9.1.2.2
Outputs:
Refer subclause 8.3.4
See subclause 8.3.4 for the details of usage of this API operation.
9.1.1.4 M5S_Delivery_Status_Report API p. 133
9.1.1.4.1 General p. 133
API description:
This API enables the Message Gateway to deliver MSGin5G message delivery status reports to the MSGin5G Server.
9.1.1.4.2 Report_Message_Delivery_Status operation p. 133
API operation name:
Report_Message_Delivery_Status
Description:
Send an MSGin5G message delivery status report to MSGin5G Server.
Known Consumers:
L3G, N3G, BMG.
Inputs:
Refer subclause 8.3.4
Outputs:
Refer subclause 8.3.4
See subclause 8.3.4 for the details of usage of this API operation.
9.1.1.5 M5S_AS_Registration API p. 133
9.1.1.5.1 General p. 133
API description:
This API enables the Application Server to register to MSGin5G Server.
9.1.1.5.2 Registration operation p. 133
API operation name:
Registration
Description:
Do registration or update registration to an MSGin5G Server, by using this API, the Application Server provides/updates its information, including the URL used for the message delivery from MSGin5G Server to Application Server.
Known Consumers:
Application Server
Inputs:
Refer subclause 9.1.2.3
Outputs:
Refer subclause 9.1.2.4
9.1.1.5.3 Deregistration operation p. 134
API operation name:
Send_MSGin5G_Message
Description:
Do deregistration with an MSGin5G Server.
Known Consumers:
Application Server
Inputs:
Refer subclause 9.1.2.5
Outputs:
Refer subclause 9.1.2.6
9.1.1.6 M5S_Topiclist_Event API |R18| p. 134
9.1.1.6.1 General p. 134
API description:
This API enables another MSGin5G Server to communicate with the MSGin5G Server to subscribe and receive subsequent notification events of the Messaging Topic list and information of specific message topics on the MSGin5G Server.
9.1.1.6.2 Subscribe Messaging Topiclist operation p. 134
API operation name:
Subscribe_Messaging_Topiclist
Description:
Subscribing to changes to Messaging Topic list on the MSGin5G Server.
Known Consumers:
MSGin5G Server
Inputs:
Refer subclause 8.8.4.2
Outputs:
Refer subclause 8.8.4.2
See subclause 8.8.4.2 for the details of usage of this API operation
9.1.1.6.3 Notify Messaging Topiclist operation p. 134
API operation name:
Notify_Messaging_Topiclist
Description:
Notification for changes to Messaging Topic list on the MSGin5G Server.
Known Consumers:
MSGin5G Server
Inputs:
Refer subclause 8.8.4.2
Outputs:
Refer subclause 8.8.4.2
See subclause 8.8.4.2 for the details of usage of this API operation
9.1.1.6.4 Subscribe Messaging Topic operation p. 134
API operation name:
Subscribe_Messaging_Topic
Description:
Subscribing to changes to one or more specific Messaging Topic(s) on the MSGin5G Server.
Known Consumers:
MSGin5G Server
Inputs:
Refer subclause 8.8.4.3
Outputs:
Refer subclause 8.8.4.3
See subclause 8.8.4.3 for the details of usage of this API operation
9.1.1.6.5 Notify Messaging Topic operation p. 135
API operation name:
Notify_Messaging_Topic
Description:
Notification for changes to one or more specific Messaging Topic(s) on the MSGin5G Server.
Known Consumers:
MSGin5G Server
Inputs:
Refer subclause 8.8.4.3
Outputs:
Refer subclause 8.8.4.3
See subclause 8.8.4.3 for the details of usage of this API operation
9.1.1.6.6 Unsubscribe Messaging Topiclist operation p. 135
API operation name:
Unsubscribe_Messaging_Topiclist
Description:
Unsubscribing to changes to Messaging Topic list on the MSGin5G Server.
Known Consumers:
MSGin5G Server
Inputs:
Refer subclause 8.8.4.2a
Outputs:
Refer subclause 8.8.4.2a
See subclause 8.8.4.2 for the details of usage of this API operation
9.1.1.6.7 Unsubscribe Messaging Topic operation p. 135
API operation name:
Unsubscribe_Messaging_Topic
Description:
Unsubscribing to changes to one or more specific Messaging Topic(s) on the MSGin5G Server.
Known Consumers:
MSGin5G Server
Inputs:
Refer subclause 8.8.4.4
Outputs:
Refer subclause 8.8.4.4
See subclause 8.8.4.4 for the details of usage of this API operation
9.1.2 Mm5s Information flows p. 135
9.1.2.1 M5S Application Server originating message send request p. 135
The information flows from the Application Server to the MSGin5G Server for message delivery includes the IEs in Table 8.3.2-1. Additionally, the following information in Table 9.1.2.1-2 elements needs to be included:
| Information element | Status | Description |
|---|---|---|
| Latency | O | The latency requirement for the message. |
| Authorization Information | O | The authorization information used to determine whether the Application Server is allowed to send the message. |
| Notification URL | M | The URL for MSGin5G Server to send the MSGin5G response notification. |
9.1.2.2 M5S Application Server originating message delivery status report request p. 135
The information flows from the Application Server to the MSGin5G Server for message delivery status report includes the IE in Table 8.3.4-1, and the following information in Table 9.1.2.2-1 elements needs to be included:
| Information element | Status | Description |
|---|---|---|
| O | The authorization information used to determine whether the Application Server is allowed to send the message. |
9.1.2.3 M5S Application Server registration request p. 136
The information flows from the Application Server to the MSGin5G Server for registration request includes the information elements in Table 9.1.2.3-1.
| Information element | Status | Description |
|---|---|---|
| AS service ID | M | The MSGin5G identifier of the Application Server. This ID is configured before registration. |
| Application ID | O | The identifier of the application specified by the application provider. |
| Authorization Information | O | The authorization information used to determine whether the Application Server is allowed to send the message. |
| Notification target URI | O | The URL for receiving message, message delivery status report. The MSGin5G Server uses this URL to interact to Application Server. |
| Requested expiration time | O | Requested expiration time for the registration. |
| Application Profile (NOTE 1) | O | The elements in Application Profile include the information of the Application Server, e.g. application name, application provider, application scenario description, application category. This IE is used by MSGin5G Server to compare with application client information. |
| Expected MSGin5G group list (NOTE 2) | O | A list of MSGin5G group which the Application Server will control, i.e. acts as a Controlling AS in these MSGin5G groups. |
|
NOTE 1:
The detailed definition of Application Profile is out of scope of this document.
NOTE 2:
The Application Server acts as VAL Server and gets the MSGin5G Group Service ID from the SEAL Group Management Server.
|
||
9.1.2.4 M5S Application Server registration response p. 136
The information flows from the MSGin5G Server to the Application Server for registration response includes the information elements in Table 9.1.2.4-1.
| Information element | Status | Description |
|---|---|---|
| AS service ID | M | The MSGin5G identifier of the Application Server. |
| Registration result | M | Indication if the registration is success or failure. |
| Registration expiration time
(see NOTE 1) | O | Indicates the expiration time of the registration. |
| Failure Cause
(see NOTE 2) | O | The reason for failure. |
|
NOTE 1:
This IE shall only be present when the Registration is Success.
NOTE 2:
This IE shall only be present when the Registration result is Failure.
|
||
9.1.2.5 M5S Application Server de-registration request p. 136
The information flows from the Application Server to the MSGin5G Server for de-registration request includes the information elements in Table 9.1.2.5-1.
| Information element | Status | Description |
|---|---|---|
| AS service ID | M | The MSGin5G identifier of the Application Server. |
9.1.2.6 M5S Application Server de-registration response p. 137
The information flows from the MSGin5G Server to the Application Server for de-registration response includes the information elements in Table 9.1.2.6-1.
| Information element | Status | Description |
|---|---|---|
| AS service ID | M | The MSGin5G identifier of the Application Server. |
| De-registration result | M | Indication if the de-registration is success or failure. |
| Failure Cause (see NOTE) | O | The reason for failure. |
|
NOTE:
This IE shall only be present when the de-registration result is Failure.
|
||
9.1.2.7 M5S Send_MSGin5G_Message response notification |R19| p. 137
The information flows from the MSGin5G Server to the Application Server for message response notification includes the IEs in Table 8.3.2-3. Additionally, the following information in Table 9.1.2.7-1 elements needs to be included:
| Information element | Status | Description |
|---|---|---|
| Authorization Information | O | The authorization information used to determine whether the Application Server is allowed to send the message. |
