GMDviaMBMSbyMB2

API for Group Message Delivery via MBMS by MB2.

OpenAPI

OpenAPI Version: 3.0.0

info

Title: GMDviaMBMSbyMB2

Description: API for Group Message Delivery via MBMS by MB2

Version: "1.0.0"

externalDocs

Description: 3GPP TS 29.122 V15.2.0 T8 reference point for Northbound APIs

URL: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.122/'

security

- {}

- oAuth2ClientCredentials: []

servers

URL: '{apiRoot}/3gpp-group-message-delivery-mb2/v1'

Variables:

API Root:

Default: https://example.com

Description: apiRoot as defined in subclause 5.2.4 of 3GPP TS 29.122.

paths

scsAsId tmgi allocation

get:

Summary: read all TMGI Allocation resource for a given SCS/AS

Tags:

- TMGI Allocatin Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of SCS/AS

Required/Optional: true

Schema:

Type: string

Responses:

'200' OK (successful query of TMGI Allocation resource)

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/TMGIAllocation'

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'406': Reference 'TS29122_CommonData.yaml#/components/responses/406'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

Method: Post

Summary: creates a new TMGI Allocation resource for a given SCS/AS

Tags:

- TMGI Allocatin Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of SCS/AS

Required/Optional: true

Schema:

Type: string

Request Body:

Description: representation of the TMGI Allocation to be created in the SCEF

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/TMGIAllocation'

Responses:

'201' successful creation of an TMGI Allocation

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/TMGIAllocation'

Headers:

Location:

Description: 'Contains the URI of the newly created resource'

Required/Optional: true

Schema:

Type: string

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'411': Reference 'TS29122_CommonData.yaml#/components/responses/411'

'413': Reference 'TS29122_CommonData.yaml#/components/responses/413'

'415': Reference 'TS29122_CommonData.yaml#/components/responses/415'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

scsAsId tmgi allocation tmgi

get:

Summary: read a TMGI Allocation resource for a given SCS/AS and a TMGI

Tags:

- Individual TMGI Allocatin Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of SCS/AS

Required/Optional: true

Schema:

Type: string

- name: tmgi

In: path

Description: TMGI

Required/Optional: true

Schema:

Type: string

Responses:

'200' OK (successful query of TMGI Allocation resource)

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/TMGIAllocation'

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'406': Reference 'TS29122_CommonData.yaml#/components/responses/406'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

put:

Summary: Updates an existing TMGI Allocation resource for a given SCS/AS and a TMGI

Tags:

- Individual TMGI Allocatin Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of SCS/AS

Required/Optional: true

Schema:

Type: string

- name: tmgi

In: path

Description: TMGI

Required/Optional: true

Schema:

Type: string

Request Body:

Description: representation of the TMGI Allocation to be updated in the SCEF

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/TMGIAllocation'

Responses:

'200' successful creation of an TMGI Allocation

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/TMGIAllocation'

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'411': Reference 'TS29122_CommonData.yaml#/components/responses/411'

'413': Reference 'TS29122_CommonData.yaml#/components/responses/413'

'415': Reference 'TS29122_CommonData.yaml#/components/responses/415'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

patch:

Summary: Updates an existing TMGI Allocation resource for a given SCS/AS and a TMGI

Tags:

- Individual TMGI Allocatin Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of SCS/AS

Required/Optional: true

Schema:

Type: string

- name: tmgi

In: path

Description: TMGI

Required/Optional: true

Schema:

Type: string

Request Body:

Description: representation of the TMGI Allocation to be updated in the SCEF

Required/Optional: true

Content:

application/merge-patch+json:

Schema:

Reference: '#/components/schemas/TMGIAllocationPatch'

Responses:

'200' successful creation of an TMGI Allocation

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/TMGIAllocation'

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'411': Reference 'TS29122_CommonData.yaml#/components/responses/411'

'413': Reference 'TS29122_CommonData.yaml#/components/responses/413'

'415': Reference 'TS29122_CommonData.yaml#/components/responses/415'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

delete:

Summary: deletes an existing TMGI Allocation resource for a given SCS/AS and a TMGI

Tags:

- Individual TMGI Allocatin Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of SCS/AS

Required/Optional: true

Schema:

Type: string

- name: tmgi

In: path

Description: TMGI

Required/Optional: true

Schema:

Type: string

Responses:

'204' No Content, successful deletion of an TMGI Allocation

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

scsAsId tmgi-allocation tmgi delivery via mbms

get:

Summary: read all group message delivery via MBMS resource for a given SCS/AS and a TMGI

Tags:

- Delivery via MBMS Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of SCS/AS

Required/Optional: true

Schema:

Type: string

- name: tmgi

In: path

Description: TMGI

Required/Optional: true

Schema:

Type: string

Responses:

'200' OK (successful query of Delivery via MBMS resource)

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/GMDViaMBMSByMb2'

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'406': Reference 'TS29122_CommonData.yaml#/components/responses/406'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

Method: Post

Summary: Creates a new delivery via MBMS for a given SCS/AS and a TMGI

Tags:

- Delivery via MBMS Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of SCS/AS

Required/Optional: true

Schema:

Type: string

- name: tmgi

In: path

Description: TMGI

Required/Optional: true

Schema:

Type: string

Request Body:

Description: representation of the GMD via MBMS by MB2 resource to be Created in the SCEF

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/GMDViaMBMSByMb2'

Callbacks:

gMDByMb2Notification:

'{$request.body#/notificationDestination}':

Method: Post

Request Body: # contents of the callback message

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/GMDByMb2Notification'

Responses:

'200' OK (The successful acknowledgement of the notification with a body)

Content:

Application/JSON:

Schema:

Reference: 'TS29122_CommonData.yaml#/components/schemas/Acknowledgement'

'204' successful notification

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'411': Reference 'TS29122_CommonData.yaml#/components/responses/411'

'413': Reference 'TS29122_CommonData.yaml#/components/responses/413'

'415': Reference 'TS29122_CommonData.yaml#/components/responses/415'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

Responses:

'201' successful creation of an GMD via MBMS by MB2 resource

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/GMDViaMBMSByMb2'

Headers:

Location:

Description: 'Contains the URI of the newly created resource'

Required/Optional: true

Schema:

Type: string

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'411': Reference 'TS29122_CommonData.yaml#/components/responses/411'

'413': Reference 'TS29122_CommonData.yaml#/components/responses/413'

'415': Reference 'TS29122_CommonData.yaml#/components/responses/415'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

scsAsId tmgi allocation tmgi delivery via mbms transactionId

get:

Summary: read all group message delivery via MBMS resource for a given SCS/AS and a TMGI

Tags:

- Individual Delivery via MBMS resource Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of SCS/AS

Required/Optional: true

Schema:

Type: string

- name: tmgi

In: path

Description: TMGI

Required/Optional: true

Schema:

Type: string

- name: transactionId

In: path

Description: Identifier of transaction

Required/Optional: true

Schema:

Type: string

Responses:

'200' OK (successful query of an Delivery via MBMS resource)

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/GMDViaMBMSByMb2'

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'406': Reference 'TS29122_CommonData.yaml#/components/responses/406'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

put:

Summary: Updates a existing delivery via MBMS for a given SCS/AS, a TMGI and transaction Id.

Tags:

- Individual Delivery via MBMS resource Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of SCS/AS

Required/Optional: true

Schema:

Type: string

- name: tmgi

In: path

Description: TMGI

Required/Optional: true

Schema:

Type: string

- name: transactionId

In: path

Description: Identifier of transaction

Required/Optional: true

Schema:

Type: string

Request Body:

Description: representation of the GMD via MBMS by MB2 resource to be udpated in the SCEF

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/GMDViaMBMSByMb2'

Responses:

'200' successful update of an individual GMD via MBMS by MB2 resource

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/GMDViaMBMSByMb2'

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'411': Reference 'TS29122_CommonData.yaml#/components/responses/411'

'413': Reference 'TS29122_CommonData.yaml#/components/responses/413'

'415': Reference 'TS29122_CommonData.yaml#/components/responses/415'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

patch:

Summary: Updates a existing delivery via MBMS for a given SCS/AS, a TMGI and transaction Id.

Tags:

- Individual Delivery via MBMS resource Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of SCS/AS

Required/Optional: true

Schema:

Type: string

- name: tmgi

In: path

Description: TMGI

Required/Optional: true

Schema:

Type: string

- name: transactionId

In: path

Description: Identifier of transaction

Required/Optional: true

Schema:

Type: string

Request Body:

Description: representation of the GMD via MBMS by MB2 resource to be udpated in the SCEF

Required/Optional: true

Content:

application/merge-patch+json:

Schema:

Reference: '#/components/schemas/GMDViaMBMSByMb2Patch'

Responses:

'200' successful update of an individual GMD via MBMS by MB2 resource

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/GMDViaMBMSByMb2'

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'411': Reference 'TS29122_CommonData.yaml#/components/responses/411'

'413': Reference 'TS29122_CommonData.yaml#/components/responses/413'

'415': Reference 'TS29122_CommonData.yaml#/components/responses/415'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

delete:

Summary: deletes a delivery via MBMS resource for a given SCS/AS, a TMGI and a transcation Id.

Tags:

- Individual Delivery via MBMS resource Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of SCS/AS

Required/Optional: true

Schema:

Type: string

- name: tmgi

In: path

Description: TMGI

Required/Optional: true

Schema:

Type: string

- name: transactionId

In: path

Description: Identifier of transaction

Required/Optional: true

Schema:

Type: string

Responses:

'204' No Content, successful deletion of an resouce of deliery via MBMS

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

components

securitySchemes

oAuth2ClientCredentials

Type: oauth2

Flows:

clientCredentials:

tokenUrl: '{tokenUrl}'

scopes: {}

schemas

TMGIAllocation

Type: object

Properties:

self:

Reference: 'TS29122_CommonData.yaml#/components/schemas/Link'

supportedFeatures:

Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

externalGroupId:

Reference: 'TS29122_CommonData.yaml#/components/schemas/ExternalGroupId'

mbmsLocArea:

Reference: '#/components/schemas/MbmsLocArea'

tmgiExpiration:

Reference: 'TS29122_CommonData.yaml#/components/schemas/DateTimeRo'

GMDViaMBMSByMb2

Type: object

Properties:

self:

Reference: 'TS29122_CommonData.yaml#/components/schemas/Link'

notificationDestination:

Reference: 'TS29122_CommonData.yaml#/components/schemas/Link'

requestTestNotification:

Type: boolean

Description: Set to true by the SCS/AS to request the SCEF to send a test notification as defined in subclause 5.2.5.3. Set to false or omitted otherwise.

websockNotifConfig:

Reference: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig'

externalGroupId:

Reference: 'TS29122_CommonData.yaml#/components/schemas/ExternalGroupId'

mbmsLocArea:

Reference: '#/components/schemas/MbmsLocArea'

messageDeliveryStartTime:

Reference: 'TS29122_CommonData.yaml#/components/schemas/DateTime'

groupMessagePayload:

Reference: 'TS29122_CommonData.yaml#/components/schemas/Bytes'

scefMessageDeliveryIPv4:

Reference: 'TS29122_CommonData.yaml#/components/schemas/Ipv4AddrRo'

scefMessageDeliveryIPv6:

Reference: 'TS29122_CommonData.yaml#/components/schemas/Ipv6AddrRo'

scefMessageDeliveryPort:

Reference: 'TS29122_CommonData.yaml#/components/schemas/PortRo'

Required:

- notificationDestination

GMDByMb2Notification

Type: object

Properties:

transaction:

Reference: 'TS29122_CommonData.yaml#/components/schemas/Link'

deliveryTriggerStatus:

Type: boolean

Description: Indicates whether delivery of group message payload corresponding to the TMGI was successful (TRUE) or not (FALSE)

Required:

  • transaction

  • deliveryTriggerStatus

TMGIAllocationPatch

Type: object

Properties:

externalGroupId:

Reference: 'TS29122_CommonData.yaml#/components/schemas/ExternalGroupId'

mbmsLocArea:

Reference: '#/components/schemas/MbmsLocArea'

GMDViaMBMSByMb2Patch

Type: object

Properties:

externalGroupId:

Reference: 'TS29122_CommonData.yaml#/components/schemas/ExternalGroupId'

mbmsLocArea:

Reference: '#/components/schemas/MbmsLocArea'

messageDeliveryStartTime:

Reference: 'TS29122_CommonData.yaml#/components/schemas/DateTime'

groupMessagePayload:

Reference: 'TS29122_CommonData.yaml#/components/schemas/Bytes'

MbmsLocArea

Type: object

Properties:

cellId:

Type: array

Items:

Type: string

minItems: 1

Description: Indicates a Cell Global Identification of the user which identifies the cell the UE is registered.

enodeBId:

Type: array

Items:

Type: string

minItems: 1

Description: Indicates an eNodeB in which the UE is currently located.

geographicArea:

Type: array

Items:

Reference: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea'

minItems: 1

Description: Identifies a geographic area of the user where the UE is located.

mbmsServiceAreaId:

Type: array

Items:

Type: string

minItems: 1

Description: Identifies an MBMS Service Area Identity of the user where the UE is located.

civicAddress:

Type: array

Items:

Reference: 'TS29572_Nlmf_Location.yaml#/components/schemas/CivicAddress'

minItems: 1

Description: Identifies a civic address of the user where the UE is located.