5 Services offered by the IP-SM-GW and SMS Router
29.5773GPP5G SystemIP Short Message Gateway and SMS Router For Short Message ServicesRelease 18Stage 3TS
5.1 Introduction
The IP-SM-GW offers to other NFs the following service:
– Nipsmgw_SMService
The SMS Router offers to other NFs the following service:
– Nrouter_SMService
The Nipsmgw_SMService service and Nrouter_SMService service are specified in 3GPP TS 23.540 [14].
Table 5.1-1 summarizes the corresponding APIs defined for this specification.
Table 5.1-1: API Descriptions
Service Name |
Clause |
Description |
OpenAPI Specification File |
apiName |
Annex |
Nipsmgw_SMService |
6.1 |
IP-SM-GW SMService Service |
TS29577_Nipsmgw_SMService.yaml |
nipsmgw-smservice |
A.2 |
Nrouter_SMService |
6.2 |
SMS Router SMService Service |
TS29577_Nrouter_SMService.yaml |
nrouter-smservice |
A.3 |
5.2 Nipsmgw_SMService Service
5.2.1 Service Description
The Nipsmgw_SMService service provides SBI-based MT SM transmit through IP-SM-GW. The IP-SM-GW is acting as NF Service Producer, while the UDM or SMS-GMSC is the NF Service Consumer.
Following functionalities are provided by the Nipsmgw_SMService service:
– Provide Routing Information;
– Transmit downlink SMS message.
The Nipsmgw_SMService service supports the following service operations.
Table 5.2.1-1: Service operations supported by the Nipsmgw_SMService service
Service Operations |
Description |
Operation Semantics |
Example Consumer(s) |
RoutingInfo |
Provide Routing Information. |
Request/Response |
UDM |
MtForwardSm |
Transmit downlink SMS message. |
Request/Response |
SMS-GMSC |
5.2.2 Service Operations
5.2.2.1 Introduction
See Table 5.2.1-1 for an overview of the service operations supported by the Nipsmgw_SMService service.
5.2.2.2 RoutingInfo
5.2.2.2.1 General
The RoutingInfo service operation shall be used to provide the SMSF Instance Id to the IP-SM-GW.
It is used in the following procedures:
– Successful Mobile Terminated short message transfer via IP-SM-GW (see clause 5.1.4 of 3GPP TS 23.540 [14]).
– Unsuccessful Mobile Terminated short message transfer via IP-SM-GW (see clause 5.1.6 of 3GPP TS 23.540 [14]).
The NF Service Consumer (e.g. UDM) shall provide the SMSF Instance Id to the IP-SM-GW by using the HTTP PUT method as shown in Figure 5.2.2.2.1-1.
Figure 5.2.2.2.1-1: Routing Information creation
1. The NF Service Consumer shall send a PUT request to the resource representing the UE’s Mobile Terminated Short Message Information resource (i.e. …/mt-sms/{gpsi}) of the IP-SM-GW to update or create the routing information for a given UE. The payload body of the PUT request shall contain:
– SMSF Instance Id.
2a. If the resource does not exist (there is no previous routing information stored in IP-SM-GW for that user), IP-SM-GW stores the received routing data and returns a "201 Created" response with the "Location" header containing the URI of the created resource.
The PUT response body shall include:
– the IP address of the IP-SM-GW (to be sent by the UDM to the SMS-GMSC); and/or
– the FQDN of the IP-SM-GW (to be sent by the UDM to the SMS-GMSC).
2b. If the resource exists (there is previous routing information stored in IP-SM-GW for that user), the IP-SM-GW updates the routing data by replacing it with the received information, and responds with "200 OK" or "204 No Content".
2c. On failure, or redirection, one of the HTTP status code listed in Table 6.1.3.3.3.1-3 shall be returned.
5.2.2.3 MtForwardSm
5.2.2.3.1 General
The MtForwardSm service operation shall be used to transmit downlink SMS message via IP-SM-GW.
It is used in the following procedures:
– Successful Mobile Terminated short message transfer via IP-SM-GW (see clause 5.1.4 of 3GPP TS 23.540 [14]).
– Unsuccessful Mobile Terminated short message transfer via IP-SM-GW (see clause 5.1.6 of 3GPP TS 23.540 [14]).
The NF Service Consumer (e.g. SMS-GMSC) shall transmit downlink SMS message to the IP-SM-GW by using the HTTP POST method as shown in Figure 5.2.2.3.1-1.
Figure 5.2.2.3.1-1: Transmit downlink SMS message
1. The NF Service Consumer shall send a POST request to the resource representing the UE’s Mobile Terminated Short Message Information resource (i.e. …/mt-sms/{gpsi}/sendsms) of the IP-SM-GW. The payload body of the POST request shall contain the SMS message to be sent.
2a. On success, "200 OK" shall be returned with "SmsDeliveryData" object contains the MT SMS Delivery Report in the response body.
2b. On failure, or redirection, one of the HTTP status code listed in Table 6.1.3.3.4.2.2-2 shall be returned.
5.3 Nrouter_SMService Service
5.3.1 Service Description
The Nrouter_SMService service provides SBI-based MT SM transmit through SMS Router. The SMS Router is acting as NF Service Producer, while the UDM or SMS-GMSC is the NF Service Consumer.
Following functionalities are provided by the Nrouter_SMService service:
– Provide Routing Information;
– Transmit downlink SMS message.
The Nrouter_SMService service supports the following service operations.
Table 5.3.1-1: Service operations supported by the Nrouter_SMService service
Service Operations |
Description |
Operation Semantics |
Example Consumer(s) |
RoutingInfo |
Provide Routing Information. |
Request/Response |
UDM |
MtForwardSm |
Transmit downlink SMS message. |
Request/Response |
SMS-GMSC |
5.3.2 Service Operations
5.3.2.1 Introduction
See Table 5.3.1-1 for an overview of the service operations supported by the Nrouter_SMService service.
5.3.2.2 RoutingInfo
5.3.2.2.1 General
The RoutingInfo service operation shall be used to provide the SMSF Instance Id to the SMS Router.
It is used in the following procedures:
– Successful Mobile Terminated short message transfer via SMS Router (see clause 5.1.3 of 3GPP TS 23.540 [14]).
– Unsuccessful Mobile Terminated short message transfer via SMS Router (see clause 5.1.9 of 3GPP TS 23.540 [14]).
The NF Service Consumer (e.g. UDM) shall provide the SMSF Instance Id to the SMS Router by using the HTTP PUT method as shown in Figure 5.3.2.2.1-1.
Figure 5.3.2.2.1-1: Routing Information creation
1. The NF Service Consumer shall send a PUT request to the resource representing the UE’s Mobile Terminated Short Message Information resource (i.e. …/mt-sms/{gpsi}) of the SMS Router to update or create the routing information for a given UE. The payload body of the PUT request shall contain:
– SMSF Instance Id.
2a. If the resource does not exist (there is no previous routing information stored in SMS Router for that user), SMS Router stores the received routing data and returns a "201 Created" response with the "Location" header containing the URI of the created resource.
The PUT response body shall include:
– the IP address of the SMS Router (to be sent by the UDM to the SMS-GMSC); and/or
– the FQDN of the SMS Router (to be sent by the UDM to the SMS-GMSC).
2b. If the resource exists (there is previous routing information stored in SMS Router for that user), the SMS Router updates the routing data by replacing it with the received information, and responds with "200 OK" or "204 No Content".
2c. On failure, or redirection, one of the HTTP status code listed in Table 6.2.3.3.3.1-3 shall be returned.
5.3.2.3 MtForwardSm
5.3.2.3.1 General
The MtForwardSm service operation shall be used to transmit downlink SMS message via SMS Router.
It is used in the following procedures:
– Successful Mobile Terminated short message transfer via SMS Router (see clause 5.1.3 of 3GPP TS 23.540 [14]).
– Unsuccessful Mobile Terminated short message transfer via SMS Router (see clause 5.1.9 of 3GPP TS 23.540 [14]).
The NF Service Consumer (e.g. SMS-GMSC) shall transmit downlink SMS message to the SMS Router by using the HTTP POST method as shown in Figure 5.3.2.3.1-1.
Figure 5.3.2.3.1-1: Transmit downlink SMS message
1. The NF Service Consumer shall send a POST request to the resource representing the UE’s Mobile Terminated Short Message Information resource (i.e. …/mt-sms/{gpsi}/sendsms) of the SMS Router. The payload body of the POST request shall contain the SMS message to be sent.
2a. On success, "200 OK" shall be returned with "SmsDeliveryData" object contains the MT SMS Delivery Report in the response body.
2b. On failure, or redirection, one of the HTTP status code listed in Table 6.2.3.3.4.2.2-2 shall be returned.