A.5 MSGG_N3GDelivery API
29.5383GPPApplication Programming Interfaces (API) specificationEnabling MSGin5G ServiceRelease 18Stage 3TS
openapi: 3.0.0
info:
title: MSGG_N3GDelivery
version: 1.0.0
description: |
API for MSGG N3G Message Delivery Service.
© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 29.538 V17.1.0; Enabling MSGin5G Service; Application Programming Interfaces (API)
specification; Stage 3
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.538/
servers:
– url: ‘{apiRoot}/msgg-n3gdelivery/v1’
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501
security:
– {}
– oAuth2ClientCredentials:
– msgg-n3gdelivery
paths:
/deliver-message:
post:
summary: deliver message to NON-3GPP Message Gateway
tags:
– N3G Message delivery
requestBody:
required: true
content:
application/json:
schema:
$ref: ‘#/components/schemas/N3gMessageDelivery’
responses:
‘204’:
description: No Content,Message delivery successful
‘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’
‘503’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/503’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/deliver-report:
post:
summary: deliver status report to NON-3GPP Message Gateway
tags:
– N3G status report delivery
requestBody:
required: true
content:
application/json:
schema:
$ref: ‘TS29538_MSGS_MSGDelivery.yaml#/components/schemas/DeliveryStatusReport’
responses:
‘204’:
description: No Content, status report delivery successfully
‘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’
‘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:
msgg-n3gdelivery: Access to the MSGG_N3GDelivery API
schemas:
#
# STRUCTURED DATA TYPES
#
N3gMessageDelivery:
description: N3G message delivery data
type: object
required:
– oriAddr
– destAddr
– msgId
properties:
oriAddr:
$ref: ‘TS29538_MSGG_L3GDelivery.yaml#/components/schemas/Address’
destAddr:
$ref: ‘TS29538_MSGG_L3GDelivery.yaml#/components/schemas/Address’
appId:
type: string
msgId:
type: string
delivStReqInd:
type: boolean
payload:
type: string
segInd:
type: boolean
segParams:
$ref: ‘TS29538_MSGS_MSGDelivery.yaml#/components/schemas/MessageSegmentParameters’
Annex B (informative):
Change history
|
Change history |
|||||||
|
Date |
Meeting |
TDoc |
CR |
Rev |
Cat |
Subject/Comment |
New version |
|
2021-10 |
CT3#118-e |
C3-215030 |
Draft skeleton provided by the rapporteur |
0.0.0 |
|||
|
2021-10 |
CT3#118-e |
C3-215479 |
Inclusion of documents agreed in CT3#118e C3-215116, Editorial change from the rapporteur. Correction from the rapporteur. |
0.1.0 |
|||
|
2021-11 |
CT3#119-e |
C3-216552 |
Inclusion of documents agreed in CT3#119e C3-216175, Correction from the rapporteur. |
0.2.0 |
|||
|
2022-01 |
CT3#119bis-e |
C3-220458 |
Inclusion of documents agreed in CT3#119bis-e C3-220384, C3-220385, C3-220386, C3-220387, C3-220389, C3-220391, C3-220410, C3-220411, C3-220412 and C3-220413. Correction from the rapporteur. |
0.3.0 |
|||
|
2022-02 |
CT3#120e |
C3-221559 |
Inclusion of documents agreed in CT3#120e C3-221245, Correction from the rapporteur. |
0.4.0 |
|||
|
2022-03 |
CT#95e |
CP-220163 |
Presentation to TSG CT for approval |
1.0.0 |
|||
|
2022-03 |
CT#95e |
CP-220163 |
Approved by TSG CT |
17.0.0 |
|||
|
2022-06 |
CT#96 |
CP-221118 |
0001 |
1 |
B |
Add Usage of Network Capabilities in MSGin5G Server |
17.1.0 |
|
2022-06 |
CT#96 |
CP-221118 |
0002 |
1 |
F |
Update of abbreviations and terms |
17.1.0 |
|
2022-06 |
CT#96 |
CP-221118 |
0003 |
1 |
F |
Update the Presence condition of appId in Table 8.1.5.2.2-1 |
17.1.0 |
|
2022-06 |
CT#96 |
CP-221151 |
0004 |
F |
Update of info and externalDocs fields |
17.1.0 |
|
|
2022-09 |
CT#97e |
CP-222092 |
0005 |
2 |
F |
Update the Presence condition of Store and forward flag |
17.2.0 |
|
2022-12 |
CT#98-e |
CP-223199 |
0007 |
1 |
F |
MSGS_ASRegistration_Deregister operation related corrections in the description clause |
18.0.0 |
|
2022-12 |
CT#98-e |
CP-223199 |
0008 |
1 |
F |
MSGS_ASRegistration_Request operation related corrections in the description clause |
18.0.0 |
|
2022-12 |
CT#98-e |
CP-223185 |
0009 |
F |
"Error handling" clause: alignment with other NBI and 5GS APIs |
18.0.0 |
|
|
2022-12 |
CT#98-e |
CP-223200 |
0010 |
1 |
F |
Rewording some description of data structure in clasue 5.3.2 |
18.0.0 |
|
2022-12 |
CT#98-e |
CP-223200 |
0011 |
1 |
F |
Change the underline to hyphen of the apiname in clause 5.1 |
18.0.0 |
|
2022-12 |
CT#98-e |
CP-223189 |
0012 |
F |
Update of info and externalDocs fields |
18.0.0 |
|