GMDviaMBMSbyxMB API

GMDviaMBMSbyxMB APIs is RESTful API that allow the SCS/AS to deliver the group message to the SCEF. It defines a set of data models, resources and the related procedures for the creation and management of the group message delivery.

OpenAPI

OpenAPI Version: 3.0.0

info

Title: GMDviaMBMSbyxMB

Description: API for Group Message Delivery via MBMS by xMB

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-xmb/v1'

Variables:

API Root:

Default: https://example.com

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

paths

scsAsId services

get:

Summary: read all service resources for a given SCS/AS

Tags:

- Service Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of SCS/AS

Required/Optional: true

Schema:

Type: string

Responses:

'200' OK (successful query of service creation resource)

Content:

Application/JSON:

Schema:

Type: array

items:

Reference: '#/components/schemas/ServiceCreation'

minItems: 0

Description: The service resource for the SCS/AS in the request URI is returned.

'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 service creation resource for a given SCS/AS

Tags:

- Service Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of SCS/AS

Required/Optional: true

Schema:

Type: string

Request Body:

Description: representation of the service to be created in the SCEF

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/ServiceCreation'

Responses:

'201' successful creation of a service

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/ServiceCreation'

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 services serviceId

get:

Summary: read a service resource for a given SCS/AS and a Service Id

Tags:

- Individual Service Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of SCS/AS

Required/Optional: true

Schema:

Type: string

- name: serviceId

In: path

Description: Service Id

Required/Optional: true

Schema:

Type: string

Responses:

'200' OK (successful query of service resource)

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/ServiceCreation'

'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'

delete:

Summary: deletes an existing service resource for a given SCS/AS and a service id

Tags:

- Individual service Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of SCS/AS

Required/Optional: true

Schema:

Type: string

- name: serviceId

In: path

Description: Service Id

Required/Optional: true

Schema:

Type: string

Responses:

'204' No Content, successful deletion of a service resource

'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 services serviceId delivery via mbms

get:

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

Tags:

- Delivery via MBMS Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of SCS/AS

Required/Optional: true

Schema:

Type: string

- name: serviceId

In: path

Description: Service Id

Required/Optional: true

Schema:

Type: string

Responses:

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

Content:

Application/JSON:

Schema:

Type: array

items:

Reference: '#/components/schemas/GMDViaMBMSByxMB'

minItems: 0

'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 service Id

Tags:

- Delivery via MBMS Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of SCS/AS

Required/Optional: true

Schema:

Type: string

- name: serviceId

In: path

Description: Service Id

Required/Optional: true

Schema:

Type: string

Request Body:

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

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/GMDViaMBMSByxMB'

Callbacks:

gMDByxMBNotification:

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

Method: Post

Request Body: # contents of the callback message

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/GMDByxMBNotification'

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 xMB resource

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/GMDViaMBMSByxMB'

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 services serviceId delivery via mbms transactionId

get:

Summary: read all group message delivery via MBMS resource for a given SCS/AS and a service 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: serviceId

In: path

Description: Service Id

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/GMDViaMBMSByxMB'

'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 delivery via MBMS for a given SCS/AS, a service Id 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: serviceId

In: path

Description: Service Id

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 xMB resource to be udpated in the SCEF

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/GMDViaMBMSByxMB'

Responses:

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

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/GMDViaMBMSByxMB'

'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 delivery via MBMS for a given SCS/AS, a service Id 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: serviceId

In: path

Description: Service Id

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 xMB resource to be udpated in the SCEF

Required/Optional: true

Content:

application/merge-patch+json:

Schema:

Reference: '#/components/schemas/GMDViaMBMSByxMBPatch'

Responses:

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

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/GMDViaMBMSByxMB'

'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 service Id 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: serviceId

In: path

Description: Service Id

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

ServiceCreation

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'

userServiceId:

Type: string

Description: Identifies the MBMS User Service supplied by the SCEF.

readOnly: true

serviceClass:

Type: string

Description: The service class that service belongs to supplied by the SCEF.

readOnly: true

serviceLanguages:

Type: array

Items:

Type: string

minItems: 1

Description: List of language of the service content supplied by the SCEF.

readOnly: true

serviceNames:

Type: array

Items:

Type: string

minItems: 1

Description: List of Service Names supplied by the SCEF.

readOnly: true

receiveOnlyMode:

Type: boolean

Description: When set to 'true', the Content Provider indicates that the service is a Receive Only Mode service. This parameter is supplied by the SCEF.

readOnly: true

serviceAnnouncementMode:

Reference: '#/components/schemas/ServiceAnnouncementMode'

GMDViaMBMSByxMB

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'

mbmsLocArea:

Reference: '#/components/schemas/MbmsLocArea'

messageDeliveryStartTime:

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

messageDeliveryStopTime:

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:

- scsAsId

- notificationDestination

GMDByxMBNotification

Type: object

Properties:

transaction:

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

deliveryTriggerStatus:

Type: boolean

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

Required:

- transaction

- deliveryTriggerStatus

GMDViaMBMSByxMBPatch

Type: object

Properties:

mbmsLocArea:

Reference: '#/components/schemas/MbmsLocArea'

messageDeliveryStartTime:

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

messageDeliveryStopTime:

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.

ServiceAnnouncementMode

anyOf:

- type: string

This string provides forward-compatibility with future

extensions to the enumeration but is not used to encode

content defined in the present version of this API.

Possible values are

- SACH: BM-SC performs the service announcement for the current service using the SACH channel.

- CONTENT_PROVIDER: BM-SC provides the necessary service access information used by the Content Provider to create the service announcement information.

readOnly: true