-
Notifications
You must be signed in to change notification settings - Fork 263
/
Copy pathTS29577_Nipsmgw_SMService.yaml
270 lines (257 loc) · 8.94 KB
/
TS29577_Nipsmgw_SMService.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
openapi: 3.0.0
info:
version: '1.1.0-alpha.3'
title: 'Nipsmgw_SMService Service API'
description: |
IP-SM-GW SMService.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.577 V18.3.0; 5G System; IP Short Message Gateway and SMS Router For Short Message Services; Stage 3
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.577/'
security:
- oAuth2ClientCredentials:
- nipsmgw-smservice
- {}
servers:
- url: '{apiRoot}/nipsmgw-smservice/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501.
paths:
/mt-sm-infos/{gpsi}:
put:
summary: Create the routing information for a given UE
operationId: RoutingInfo
tags:
- Creation of Routing Info
security:
- {}
- oAuth2ClientCredentials:
- nipsmgw_smservice
- oAuth2ClientCredentials:
- nipsmgw_smservice
- nipsmgw_smservice:mtsminfos:write
parameters:
- name: gpsi
in: path
required: true
description: Generic Public Subscription Identifier (GPSI)
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateRoutingData'
required: true
responses:
'201':
description: Routing Information is created in IP-SM-GW
content:
application/json:
schema:
$ref: '#/components/schemas/CreatedRoutingData'
headers:
Location:
description: >
'Contains the URI of the newly created resource, according to the structure:
{apiRoot}/nipsmgw-smservice/<apiVersion>/mt-sm-infos/{gpsi}'
required: true
schema:
type: string
'200':
description: Routing Information is updated in IP-SM-GW
content:
application/json:
schema:
$ref: '#/components/schemas/CreatedRoutingData'
'204':
description: Routing Information is updated in IP-SM-GW
'307':
$ref: 'TS29571_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29571_CommonData.yaml#/components/responses/308'
'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/404'
'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/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
/mt-sm-infos/{gpsi}/sendsms:
post:
summary: Send SMS payload for a given UE
operationId: SendSMS
tags:
- Send MT SMS message and the delivery report
security:
- {}
- oAuth2ClientCredentials:
- nipsmgw_smservice
- oAuth2ClientCredentials:
- nipsmgw_smservice
- nipsmgw_smservice:sendsms:invoke
parameters:
- name: gpsi
in: path
required: true
description: Generic Public Subscription Identifier (GPSI)
schema:
type: string
requestBody:
content:
multipart/related: # message with a binary body part
schema:
type: object
properties:
jsonData:
$ref: '#/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: '#/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
'307':
$ref: 'TS29571_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29571_CommonData.yaml#/components/responses/308'
'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/404'
'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/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: '{nrfApiRoot}/oauth2/token'
scopes:
nipsmgw-smservice: Access to the nipsmgw-smservice API
nipsmgw-smservice:mtsminfos:write: Access to write MT SM Infos
nipsmgw-smservice:sendsms:invoke: Access to invoke Send SMS
schemas:
CreateRoutingData:
description: Information used for creating or updating the routing information of the user.
type: object
required:
- smsfId
properties:
smsfId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
smsf3Gpp:
$ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/SmsfRegistration'
smsfNon3Gpp:
$ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/SmsfRegistration'
supi:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Supi'
ipSmGwGuidanceInd:
type: boolean
default: false
supportedFeatures:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
CreatedRoutingData:
description: Information used for receiving the MT SMS.
type: object
properties:
ipsmgwIpv4:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
ipsmgwIpv6:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr'
ipsmgwFqdn:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn'
ipSmGwNfInstanceId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
correlationId:
type: string
ipSmGwGuidance:
$ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/IpSmGwGuidance'
supportedFeatures:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
SmsData:
description: Information within request message for delivering SMS.
type: object
required:
- smsPayload
properties:
smsPayload:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
SmsDeliveryData:
description: >
Information within response message invoking MtForwardSm service operation, for delivering
MT SMS Delivery Report.
type: object
required:
- smsPayload
properties:
smsPayload:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'