vnd.3gpp.sms

Binary encoded payload, encoding SMS payload, as specified in 3GPP TS 23.040 [11] and 3GPP TS 24.011 [12].

NOTE: Using 3GPP vendor content subtypes allows to describe the nature of the opaque payload (e.g. SMS payload) without having to rely on metadata in the JSON payload.

UEContext
(Document)

/ue-contexts/{supi}

PUT

It is used for the Activate service operation, for the purpose of:

– Activate SMS service for a given UE, which results in creating an individual UE Context resource in SMSF.

– Update SMS service parameters for a given UE, which results in updating an existing individual UE Context resource in SMSF.

– Deactivate SMS service for a given UE for one of the two registered Access Types, which results in updating an existing individual UE context resource in SMSF.

PATCH

It is used for the Activate service operation, for the purpose of:

– Partially update SMS service parameters for a given UE, which results in updating an existing individual UE Context resource in SMSF.

DELETE

It is used for the Deactivate service operation, for the purpose of:

– Deactivate SMS service for a given UE, which results in deleting an existing individual UE Context resource in SMSF.

/ue-contexts/{supi}/sendsms

sendsms

(POST)

It is used for the UplinkSMS service operation, to allow NF Service Consumer to send SMS payload in uplink direction.

/ue-contexts/{supi}/send-mt-sms

send-mt-sms

(POST)

It is used for the MtForwardSm service operation, to allow NF Service Consumer to send SMS payload in downlink direction.

apiRoot

string

See clause 6.1.1

apiRoot

string

See clause 6.1.1

supi

Supi

Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)

pattern: See pattern of type Supi in 3GPP TS 29.571 [6]

n/a

UeSmsContextData

M

1

Representation of the UE Context for SMS to be created in the SMSF, or to be updated in the SMSF.

UeSmsContextData

M

1

201 Created

This case represents the successful creation of an UE Context for SMS.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource.

n/a

204 No Content

This case represents the successful update of an UE Context for SMS.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same SMSF or SMSF (service) set.

(NOTE 2)

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same SMSF or SMSF (service) set.

(NOTE 2)

ProblemDetails

O

0..1

403 Forbidden

When used to represent the failure of creation / update of an UE Context for SMS, the "cause" attribute of the "ProblemDetails" shall be set to one of the following application error codes:

– SERVICE_NOT_ALLOWED, if SMS service is not allowed for the given service user;

ProblemDetails

O

0..1

404 Not Found

When used to represent the failure of creation / update of an UE Context for SMS, the "cause" attribute of the "ProblemDetails" shall be set to one of the following application error codes:

– USER_NOT_FOUND, if the provided subscriber identifier is invalid or the service user is not found from UDM;

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

NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4].

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/nsmsf-sms/<apiVersion>/ue-contexts/{supi}

ETag

string

O

0..1

Entity Tag, containing a strong validator, as described in IETF RFC 7232 [18], clause 2.3.

ETag

string

O

0..1

Entity Tag, containing a strong validator, as described in IETF RFC 7232 [18], clause 2.3.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same SMSF or SMSF (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same SMSF or SMSF (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected

n/a

n/a

n/a

204 No Content

This case represents a successful deletion of an UE Context for SMS.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same SMSF or SMSF (service) set.

(NOTE 2)

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same SMSF or SMSF (service) set.

(NOTE 2)

ProblemDetails

O

0..1

404 Not Found

When used to represent an unsuccessful deletion of an UE Context for SMS, the "cause" attribute of the "ProblemDetails" may be used to include one of the following application error codes:

– CONTEXT_NOT_FOUND, if the UE context for SMS to be operated is invalid or not found in SMSF.

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

NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4].

If-Match

String

O

0..1

Validator for conditional requests, as described in IETF RFC 7232 [18], clause 3.1

Location

String

M

1

An alternative URI of the resource located on an alternative service instance within the same SMSF or SMSF (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

String

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same SMSF or SMSF (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected

supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

array(PatchItem)

M

1..N

Items describe the modifications to the Event Subscription

n/a

204 No Content

Upon success, an empty response body shall be returned.

PatchResult

C

1

200 OK

Upon partial success, if the NF service consumer has indicated "PatchReport" in the supported-feature, the execution report is returned.

(NOTE 3)

UeSmsContextData

C

0..1

200 OK

Upon partial success, if the NF service consumer does not support the "PatchReport" feature, the SMSF shall return a UeSmsContextData object in the response.

(NOTE 3)

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The NF service consumer shall generate a Location header field containing a URI pointing to the endpoint of another NF service consumer to which the notification should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent.

(NOTE 2)

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The NF service consumer shall generate a Location header field containing a URI pointing to the endpoint of another NF service consumer to which the notification should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent.

(NOTE 2)

ProblemDetails

O

0..1

403 Forbidden

One or more attributes are not allowed to be modified.

The "cause" attribute may be used to indicate one of the following application errors:

– MODIFICATION_NOT_ALLOWED, see 3GPP TS 29.500 [4] table 5.2.7.2-1.

ProblemDetails

O

0..1

404 Not Found

The "cause" attribute may be used to indicate one of the following application errors:

– USER_NOT_FOUND

– CONTEXT_NOT_FOUND

NOTE 1: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4].

NOTE 3: One of UeSmsContextData or PatchResult shall be returned, depending on whether the NF service consumer support "PatchReport" feature or not.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same SMSF or SMSF (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same SMSF or SMSF (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected

sendsms

/ue-contexts/{supi}/sendsms

POST

Send SMS payload or CP Ack in uplink direction.

send-mt-sms

/ue-contexts/{supi}/send-mt-sms

POST

Send MT SMS payload, or the related CP Ack.

SmsRecordData

M

1

Representation of the SMS Record to be created in the SMSF.

SmsRecordDeliveryData

M

1

200 OK

This case represents the successful of sending SMS record in uplink direction, with necessary response data.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same SMSF or SMSF (service) set.

(NOTE 2)

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same SMSF or SMSF (service) set.

(NOTE 2)

ProblemDetails

O

0..1

400 Bad Request

This case represents an unsuccessful delivery of SMS payload.

The "cause" attribute may be used to indicate one of the following application errors:

– SMS_PAYLOAD_MISSING, if the expected SMS payload content is missing;

– SMS_PAYLOAD_ERROR, if error exists in the SMS payload content.

ProblemDetails

O

0..1

403 Forbidden

This case represents an unsuccessful delivery of SMS payload.

The "cause" attribute may be used to indicate one of the following application errors:

– SERVICE_NOT_ALLOWED, if SMS service is not allowed for the given service user;

ProblemDetails

O

0..1

404 Not Found

This case represents an unsuccessful delivery of SMS payload.

The "cause" attribute may be used to indicate one of the following application errors:

– CONTEXT_NOT_FOUND, if the UE context for SMS to be operated is invalid or not found in SMSF.

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

NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4].

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same SMSF or SMSF (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same SMSF or SMSF (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected

SmsData

M

1

Representation of the MT SMS sent to the SMSF.

SmsDeliveryData

M

1

200 OK

This case represents the successful of sending SMS message in downlink direction, with necessary response data on the received delivery report.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same SMSF or SMSF (service) set.

(NOTE 2)

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same SMSF or SMSF (service) set.

(NOTE 2)

ProblemDetails

O

0..1

400 Bad Request

This case represents an unsuccessful delivery of SMS payload.

The "cause" attribute may be used to indicate one of the following application errors:

– SMS_PAYLOAD_MISSING, if the expected SMS payload content is missing;

– SMS_PAYLOAD_ERROR, if error exists in the SMS payload content.

ProblemDetails

O

0..1

403 Forbidden

This case represents an unsuccessful delivery of SMS payload.

The "cause" attribute may be used to indicate one of the following application errors:

– SERVICE_NOT_ALLOWED, if SMS service is not allowed for the given service user;

ProblemDetails

O

0..1

404 Not Found

This case represents an unsuccessful delivery of SMS payload.

The "cause" attribute may be used to indicate one of the following application errors:

– CONTEXT_NOT_FOUND, if the UE context for SMS to be operated is invalid or not found in SMSF.

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

NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4].

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same SMSF or SMSF (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same SMSF or SMSF (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected

UeSmsContextData

6.1.6.2.2

Information used for activating SMS service for a service user, or updating the parameters for SMS service.

SmsRecordData

6.1.6.2.3

Information within request message invoking UplinkSMS service operation, for delivering SMS payload.

SmsRecordDeliveryData

6.1.6.2.5

Information for result of invoking UplinkSMS service operation.

RecordId

6.1.6.3.2

Record ID used to identify a message carrying SMS payload.

SmsDeliveryStatus

6.1.6.3.3

Status of SMS delivery attempts.

ProblemDetails

3GPP TS 29.571 [6]

Common Data Type used in response bodies

RedirectResponse

3GPP TS 29.571 [6]

Redirect Response

Supi

3GPP TS 29.571 [6]

Subscription Permanent Identifier

Gpsi

3GPP TS 29.571 [6]

General Public Subscription Identifier

Pei

3GPP TS 29.571 [6]

Permanent Equipment, it contains an IMEI or IMEISV.

Guami

3GPP TS 29.571 [6]

Globally Unique AMF Identifier

AccessType

3GPP TS 29.571 [6]

Access Type (3GPP or non-3GPP access)

UserLocation

3GPP TS 29.571 [6]

User location information

TimeZone

3GPP TS 29.571 [6]

User time zone information

NfInstanceId

3GPP TS 29.571 [6]

NF Instance ID

RefToBinaryData

3GPP TS 29.571 [6]

Information for indicating the binary content of SMS payload.

TraceData

3GPP TS 29.571 [6]

Trace control and configuration parameters

BackupAmfInfo

3GPP TS 29.571 [6]

Backup AMF Information

NfGroupId

3GPP TS 29.571 [6]

Network Function Group Id

RatType

3GPP TS 29.571 [6]

RAT Type

SupportedFeatures

3GPP TS 29.571 [6]

Supported Features

PatchItem

3GPP TS 29.571 [6]

Patch item

PatchResult

3GPP TS 29.571 [6]

PATCH result

SmsData

3GPP TS 29.577 [22]

Information within request message for delivering SMS.

SmsDeliveryData

3GPP TS 29.577 [22]

Information within response message invoking MtForwardSm service operation, for delivering MT SMS Delivery Report.

supi

Supi

M

1

This IE shall be present, and it shall contain the subscriber permanent identify of the service user.

gpsi

Gpsi

O

0..1

When present, this IE shall contain the generic public subscriber identifier of the service user.

pei

Pei

O

0..1

When present, this IE shall contain the IMEI or IMEISV of the service user.

accessType

AccessType

M

1

This IE shall be present, and it shall contain the access type from which the service user accesses to network.

additionalAccessType

AccessType

C

0..1

This IE shall be present in activate service operations to indicate that the service user accesses the network and request SMS service from both 3GPP access and Non-3GPP access.

This IE shall be absent in deactivate service operations to indicate that service user is no longer served with SMS service via two access types. In this case the accessType attribute shall indicate the remaining access type.

amfId

NfInstanceId

M

1

This IE shall be present, and it shall contain the NF instance ID of the requesting AMF.

guamis

array(Guami)

O

1..N

When present, this IE shall contain the GUAMI(s) of the AMF.

ueLocation

UserLocation

O

0..1

When present, this IE shall contain the UE location information (e.g. TAI and CGI).

ueTimeZone

TimeZone

O

0..1

When present, this IE shall contain the current time zone of the service user.

traceData

TraceData

O

0..1

Trace Data. The Null value indicates that trace is not active.

backupAmfInfo

array(BackupAmfInfo)

C

1..N

This IE shall be included if the NF service consumer is an AMF and the AMF supports the AMF management without UDSF when the UE Context for SMS to be created in the SMSF, or to be updated in the SMSF.

The SMSF uses this attribute to do an NRF query in order to invoke later services in a backup AMF e.g. Namf_MT.

Absence of this attribute indicates the backup AMF Info is not provided or the previous provided backup AMF Info is removed.

udmGroupId

NfGroupId

O

0..1

Identity of the UDM group serving the supi

routingIndicator

string

O

0..1

When present, it shall indicate the Routing Indicator of the UE.

hNwPubKeyId

integer

O

0..1

When present, it shall indicate the Home Network Public Key Identifier of the UE. (see NOTE).

ratType

RatType

C

0..1

When present, it shall indicate the RAT type of the UE.

additionalRatType

RatType

C

0..1

When present, it shall indicate the RAT type of the UE corresponding to additionalAccessType. This IE shall not be included if additionalAccessType IE is not present.

supportedFeatures

SupportedFeatures

C

0..1

This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported.

NOTE: If present, this attribute shall be used together with routingIndicator. This attribute is only used by the HPLMN in roaming scenarios.

smsRecordId

RecordId

M

1

This IE shall be present, and it shall contain the record id uniquely identify a message carrying SMS payload.

smsPayload

RefToBinaryData

M

1

This IE shall be present, and it shall contain the reference to the SMS Payload Information binary data (see clause 6.1.6.4)

gpsi

Gpsi

O

0..1

When present, this IE shall contain the global permanent subscriber identifier of the service user.

pei

Pei

O

0..1

When present, this IE shall contain the IMEI or IMEISV of the service user.

accessType

AccessType

O

0..1

When present, this IE shall contain the access type from which the service user accesses to network.

ueLocation

UserLocation

O

0..1

When present, this IE shall contain the UE location information (e.g. TAI and CGI).

ueTimeZone

TimeZone

O

0..1

When present, this IE shall contain the time zone of the service user.

smsRecordId

RecordId

M

1

This IE shall be present, and it shall contain the record id uniquely identify a message carrying SMS payload.

deliveryStatus

SmsDeliveryStatus

M

1

This IE shall be present, and it shall indicate the status of SMS payload delivery attempt in the SMSF, after SMSF receiving SMS payload on Nsmsf interface.

RecordId

string

String uniquely identifying a record in the SMSF. The format of RecordId is implementation specific, e.g. using UUID format.

In an OpenAPI Specification [19] schema, the format shall be designated as "RecordId".

SMS_DELIVERY_PENDING

The SMS payload delivery at SMSF is pended.

SMS_DELIVERY_COMPLETED

The SMS payload delivery at SMSF is completed.

SMS_DELIVERY_FAILED

The SMS payload delivery at SMSF is failed due to certain reasons.

SMS_DELIVERY_SMSF_ACCEPTED

The SMS payload is accepted by the SMSF for further delivery.

SMS Payload Information

6.1.6.4.2

vnd.3gpp.sms

USER_NOT_FOUND

404 Not Found

The provided subscriber identifier is invalid or the service user not found.

CONTEXT_NOT_FOUND

404 Not Found

The UE context for SMS to be operated is invalid or not found in SMSF.

SERVICE_NOT_ALLOWED

403 Forbidden

The requested service is not allowed for this service user.

SMS_PAYLOAD_MISSING

400 Bad Request

The expected SMS payload content is missing.

SMS_PAYLOAD_ERROR

400 Bad Request

Errors exist in the format of SMS payload.

1

ES3XX

M

Extended Support of HTTP 307/308 redirection

An NF Service Consumer (e.g. AMF) that supports this feature shall support handling of HTTP 307/308 redirection for any service operation of the Nsmsf_SMService service. An NF Service Consumer that does not support this feature does only support HTTP redirection as specified for 3GPP Release 15.

2

PatchReport

O

If some of the modifications included in the PATCH request are not successfully implemented, the SMSF reports the result of PATCH request execution to the consumer. See clause 5.2.7.2 of 3GPP TS 29.500 [4].

Feature number: The order number of the feature within the supportedFeatures attribute (starting with 1).

Feature: A short name that can be used to refer to the bit and to the feature.

M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O").

Description: A clear textual description of the feature.