A.3 Nnef_SMService API
29.5413GPP5G SystemNetwork Exposure (NE) function services for Non-IP Data Delivery (NIDD) and Short Message Services (SMS)Release 18Stage 3TS
openapi: 3.0.0
info:
title: Nnef_SMService
version: 1.1.0-alpha.1
description: |
Nnef SMService Service.
© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.541 V18.0.0; 5G System; Session Management Services for Non-IP Data Delivery (NIDD).
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.541/
servers:
– url: ‘{apiRoot}/nnef-smservice/v1’
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501
security:
– {}
– oAuth2ClientCredentials:
– nnef-smservice
paths:
/sm-contexts/{supi}/sendsms:
post:
summary: Send SMS payload for a given UE
operationId: SendSMS
tags:
– Send MO SMS message and the delivery report
parameters:
– name: supi
in: path
required: true
description: Subscription Permanent Identifier (SUPI)
schema:
type: string
requestBody:
content:
multipart/related: # message with a binary body part
schema:
type: object
properties:
jsonData:
$ref: ‘TS29577_Nipsmgw_SMService.yaml#/components/schemas/SmsData’
binaryPayload:
type: string
format: binary
encoding:
jsonData:
contentType: application/json
binaryPayload:
contentType: application/vnd.3gpp.sms
headers:
Content-Id:
schema:
type: string
required: true
responses:
‘200’:
description: sending delivery report
content:
multipart/related: # message with a binary body part
schema:
type: object
properties:
jsonData:
$ref: ‘TS29577_Nipsmgw_SMService.yaml#/components/schemas/SmsDeliveryData’
binaryPayload:
type: string
format: binary
encoding:
jsonData:
contentType: application/json
binaryPayload:
contentType: application/vnd.3gpp.sms
headers:
Content-Id:
schema:
type: string
‘400’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/400’
‘401’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/401’
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘411’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/411’
‘413’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/413’
‘415’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/415’
‘429’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/429’
‘500’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/500’
‘502’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/502’
‘503’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/504’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: ‘{nrfApiRoot}/oauth2/token’
scopes:
nnef-smcontext: Access to the Nnef_SMContext API
# schemas:
# COMPLEX TYPES:
# SIMPLE TYPES:
# ENUMS:
Annex B (informative):
Change history
|
Change history |
|||||||
|
Date |
Meeting |
TDoc |
CR |
Rev |
Cat |
Subject/Comment |
New version |
|
2019-09 |
CT4#93 |
C4-193889 |
Initial Draft. |
0.1.0 |
|||
|
2019-10 |
CT4#94 |
C4-194527 |
Incorporated pCRs agreed on CT4#94, including: C4-194208, C4-194440, C4-194441, C4-194442, C4-194443. |
0.2.0 |
|||
|
2019-11 |
CT4#95 |
C4-195642 |
Incorporated pCRs agreed on CT4#95, including: C4-195283, C4-195284, C4-195295. |
0.3.0 |
|||
|
2019-12 |
CT#86 |
CP-193072 |
TS presented for information |
1.0.0 |
|||
|
2020-03 |
CT4#96-e |
C4-201265 |
Incorporated pCRs agreed on CT4#96-e, including:.C4-200588, C4-200589, C4-200744, C4-200944, C4-200985, C4-201156. |
1.1.0 |
|||
|
2020-03 |
CT#87e |
CP-200061 |
Presented for approval |
2.0.0 |
|||
|
2020-03 |
CT#87e |
Approved at CT#87e |
16.0.0 |
||||
|
2020-06 |
CT#88e |
CP-201046 |
0001 |
2 |
B |
Add Extended Buffering |
16.1.0 |
|
2020-06 |
CT#88e |
CP-201071 |
0002 |
F |
Storage of YAML files in ETSI Forge |
16.1.0 |
|
|
2020-06 |
CT#88e |
CP-201046 |
0003 |
F |
Revert MO Exception Data Indication |
16.1.0 |
|
|
2020-06 |
CT#88e |
CP-201046 |
0004 |
1 |
F |
Parameter supplement to Create Service |
16.1.0 |
|
2020-06 |
CT#88e |
CP-201046 |
0005 |
1 |
F |
Parameter supplement to Delete Service |
16.1.0 |
|
2020-06 |
CT#88e |
CP-201046 |
0006 |
1 |
F |
Parameter supplement to Status Notify Service |
16.1.0 |
|
2020-06 |
CT#88e |
CP-201046 |
0008 |
1 |
F |
Miscellaneous Corrections |
16.1.0 |
|
2020-06 |
CT#88e |
CP-201073 |
0009 |
F |
29.541 Rel-16 API version and External doc update |
16.1.0 |
|
|
2020-12 |
CT#90e |
CP-203032 |
0010 |
F |
YAML files in 3GPP Forge |
16.2.0 |
|
|
2021-03 |
CT#91e |
CP-210037 |
0011 |
1 |
F |
HTTP 3xx redirection |
16.3.0 |
|
2021-03 |
CT#91e |
CP-210078 |
0012 |
F |
29.541 Rel-16 API version and External doc update |
16.3.0 |
|
|
2021-06 |
CT#92e |
CP-210055 |
0013 |
1 |
F |
Resolving Warning in Nnef_SMContext API |
17.0.0 |
|
2021-06 |
CT#92e |
CP-210051 |
0014 |
F |
OpenAPI Reference |
17.0.0 |
|
|
2021-06 |
CT#92e |
CP-210059 |
0016 |
1 |
F |
Redirect Response |
17.0.0 |
|
2021-06 |
CT#92e |
CP-210050 |
0017 |
F |
29.541 Rel-17 API version and External doc update |
17.0.0 |
|
|
2021-09 |
CT#93e |
CP-212060 |
0020 |
– |
A |
3xx description correction for SCP |
17.1.0 |
|
2022-03 |
CT#95e |
CP-220023 |
0023 |
– |
B |
Update Binding Indication for Multiple Resources |
17.2.0 |
|
2022-06 |
CT#96 |
CP-221045 |
0026 |
F |
Description Fields |
17.3.0 |
|
|
2022-06 |
CT#96 |
CP-221051 |
0027 |
F |
29.541 Rel-17 API version and External doc update |
17.3.0 |
|
|
2022-09 |
CT#97 |
CP-222201 |
0028 |
1 |
B |
Nnef_SMService_MoForwardSm service API |
17.4.0 |
|
2022-09 |
CT#97 |
CP-222027 |
0029 |
1 |
B |
Nnef_SMService_MoForwardSm service operation |
17.4.0 |
|
2022-09 |
CT#97 |
CP-222027 |
0030 |
1 |
F |
Update Reference Model |
17.4.0 |
|
2022-12 |
CT#98 |
CP-223028 |
0032 |
1 |
F |
Missing Mandatory Status Codes in OpenAPI |
18.0.0 |
|
2022-12 |
CT#98 |
CP-223033 |
0033 |
F |
29.541 Rel-18 API version and External doc update |
18.0.0 |
|