Tech-invite3GPPspaceIETF RFCsSIP
Quick21222324252627282931323334353637384‑5x

Content for  TS 23.554  Word version:  18.0.0

Top   Top   Up   Prev   Next
1…   4…   5…   5.5…   6…   7…   8…   8.2…   8.2.3…   8.2.5…   8.3…   8.3.4…   8.4…   8.5…   8.6…   8.7…   8.7.2…   8.7.3…   8.7.4…   8.7.5…   8.8…   8.9…   8.9.3…   8.10…   8.11…   9…   10…

 

9  APIs and related information flowsp. 108

9.1  APIs provided by MSGin5G Serverp. 108

9.1.1  Mm5s APIsp. 108

9.1.1.1  M5S_AS_Originating_Message_Delivery APIp. 108

9.1.1.1.1  Generalp. 108
API description:
This API enables the Application Server to send MSGin5G message to the MSGin5G Server.
9.1.1.1.2  Send_MSGin5G_Message operationp. 108
API operation name:
Send_MSGin5G_Message
Description:
Send an MSGin5G message to MSGin5G Server.
Known Consumers:
Application Server
Inputs:
Outputs:
See subclause 8.3.2 for the details of usage of this API operation.

9.1.1.2  M5S_UE_Originating_Message_Delivery APIp. 108

9.1.1.2.1  Generalp. 108
API description:
This API enables the Message Gateway or other 5GS Function to delivery MSGin5G message to the MSGin5G Server.
9.1.1.2.2  Send_ MSGin5G_Message operationp. 108
API operation name:
Send_MSGin5G_Message
Description:
Send an MSGin5G Message to MSGin5G Server.
Known Consumers:
L3G, N3G.
Inputs:
Outputs:
See subclause 8.3.2 for the details of usage of this API operation.

9.1.1.3  M5S_AS_Originating_Delivery_Status_Report APIp. 108

9.1.1.3.1  Generalp. 108
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 operationp. 108
API operation name:
Report_Message_Delivery_Status
Description:
Send an MSGin5G message delivery status report to MSGin5G Server.
Known Consumers:
Application Server
Inputs:
Outputs:
See subclause 8.3.4 for the details of usage of this API operation.

9.1.1.4  M5S_UE_Originating_Delivery_Status_Report APIp. 109

9.1.1.4.1  Generalp. 109
API description:
This API enables the Message Gateway or other 5GS Function to deliver MSGin5G message delivery status report to the MSGin5G Server.
9.1.1.4.2  Report_Message_Delivery_Status operationp. 109
API operation name:
Report_Message_Delivery_Status
Description:
Send an MSGin5G message delivery status report to MSGin5G Server.
Known Consumers:
L3G, N3G.
Inputs:
Outputs:
See subclause 8.3.4 for the details of usage of this API operation.

9.1.1.5  M5S_AS_Registration APIp. 109

9.1.1.5.1  Generalp. 109
API description:
This API enables the Application Server to register to MSGin5G Server.
9.1.1.5.2  Registration operationp. 109
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:
Outputs:
9.1.1.5.3  Deregistration operationp. 109
API operation name:
Send_MSGin5G_Message
Description:
Do deregistration with an MSGin5G Server.
Known Consumers:
Application Server
Inputs:
Outputs:

9.1.2  Mm5s Information flowsp. 110

9.1.2.1  M5S Application Server originating message send requestp. 110

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
LatencyOThe latency requirement for the message.
Authorization InformationOThe authorization information used to determine whether the Application Server is allowed to send the message
Up

9.1.2.2  M5S Application Server originating message delivery status report requestp. 110

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
Authorization InformationOThe authorization information used to determine whether the Application Server is allowed to send the message
Up

9.1.2.3  M5S Application Server registration requestp. 110

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 IDMThe MSGin5G identifier of the Application Server.
This ID is configured before registration.
Application IDOThe identifier of the application specified by the application provider.
Authorization InformationOThe authorization information used to determine whether the Application Server is allowed to send the message
Security CredentialsOSecurity information required for the Application Server to register to the MSGin5G Server.
Notification target URIOThe URL for receiving message, message delivery status report, etc. The MSGin5G Server uses this URL to interact to Application Server.
Application Profile (NOTE)OThe elements in Application Profile include the information of the Application Server, e.g. application name, application provider, application scenario description, application category, etc.
This IE is used by MSGin5G Server to compare with application client information.
NOTE:
The detailed definition of Application Profile is out of scope of this document.
Up

9.1.2.4  M5S Application Server registration responsep. 110

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 IDMThe MSGin5G identifier of the Application Server.
Registration resultMIndication if the registration is success or failure
Up

9.1.2.5  M5S Application Server de-registration requestp. 111

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 IDMThe MSGin5G identifier of the Application Server.
Up

9.1.2.6  M5S Application Server de-registration responsep. 111

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 IDMThe MSGin5G identifier of the Application Server.
De-registration resultMIndication if the de-registration is success or failure
Up

9.2  APIs provided by Message Gatewayp. 111

9.2.1  Ml3g APIsp. 111

9.2.1.1  L3G_Message_Delivery APIp. 111

9.2.1.1.1  Generalp. 111
API description:
This API enables the MSGin5G Server to delivery MSGin5G Message to the Legacy 3GPP Message Gateway.
9.2.1.1.2  Send_Message operationp. 111
API operation name:
Send_MSGin5G_Message
Description:
Send an MSGin5G Message to Legacy 3GPP Message Gateway.
Known Consumers:
M5S.
Inputs:
Outputs:
See subclause 8.3.3 for the details of usage of this API operation.

9.2.1.2  L3G_Delivery_Status_Report APIp. 112

9.2.1.2.1  Generalp. 112
API description:
This API enables the MSGin5G Server to delivery MSGin5G Message to the Legacy 3GPP Message Gateway.
9.2.1.2.2  Report_Message_Delivery_Status operationp. 112
API operation name:
Report_Message_Delivery_Status
Description:
Send an MSGin5G message delivery status report to Legacy 3GPP Message Gateway.
Known Consumers:
M5S.
Inputs:
Outputs:
See subclause 8.3.5 for the details of usage of this API operation.

9.2.2  Mn3g APIsp. 112

9.2.2.1  N3G_Message_Delivery APIp. 112

9.2.2.1.1  Generalp. 112
API description:
This API enables the MSGin5G Server to delivery MSGin5G message to the Non-3GPP Message Gateway.
9.2.2.1.2  Send_Message operationp. 112
API operation name:
Create_MSGin5G_Message
Description:
Send an MSGin5G message to Non-3GPP Message Gateway.
Known Consumers:
M5S.
Inputs:
Outputs:
See subclause 8.3.3 for the details of usage of this API operation.

9.2.2.2  N3G_Delivery_Status_Report APIp. 112

9.2.2.2.1  Generalp. 112
API description:
This API enables the MSGin5G Server to delivery MSGin5G message to the Non-3GPP Message Gateway.
9.2.2.2.2  Report_Message_Delivery_Status operationp. 112
API operation name:
Report_Message_Delivery_Status
Description:
Send an MSGin5G message delivery status report to Non-3GPP Message Gateway.
Known Consumers:
M5S.
Inputs:
Outputs:
See subclause 8.3.5 for the details of usage of this API operation.

Up   Top   ToC