vnd.3gpp.ngap

Binary encoded payload, encoding NG Application Protocol (NGAP) IEs, as specified in clause 9.3 of 3GPP TS 38.413 [9] (ASN.1 encoded).

NOTE: Using 3GPP vendor content subtypes allows to describe the nature of the opaque payload (i.e. NGAP information) without having to rely on metadata in the JSON payload.

Broadcast MBS session contexts collection

/mbs-contexts

POST

ContextCreate

Individual broadcast MBS session context

/mbs-contexts/{mbsContextRef}/update

update

(POST)

ContextUpdate

/mbs-contexts/{mbsContextRef}

DELETE

ContextRelease

apiRoot

string

See clause 6.5.1

apiVersion

string

See clause 6.5.1.

n/a

ContextCreateReqData

M

1

Data within ContextCreate Request

ContextCreateRspData

M

1

201 Created

Successful creation of a broadcast MBS context

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set.

NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]).

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/namf-mbs-bc/<apiVersion>/mbs-contexts/{mbsContextRef}

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected

apiRoot

string

See clause 6.5.1

apiVersion

string

See clause 6.5.1

mbsContextRef

string

String identifying an individual broadcast MBS session context

n/a

n/a

n/a

204 No Content

Successful deletion of a broadcast MBS context

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set.

NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]).

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected

update

/mbscontexts/{mbsContextRef}/update

POST

ContextUpdate service operation

ContextUpdateReqData

M

1

Data within the ContextUpdate Request

ContextUpdateRspData

M

1

200 OK

Successful update of the broadcast MBS session context, with content in the response

n/a

204 No Content

Successful update of the broadcast MBS session context, without content in the response

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set.

NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]).

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected

Broadcast MBS Session Context Status Notification

{notifyUri}

POST

ContextStatusNotify

notifyUri

String formatted as URI with the Callback URI

ContextStatusNotification

M

1

Represents the notification to be delivered

n/a

204 No Content

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The NF service consumer shall generate a Location header field containing a URI pointing to the endpoint of another NF service consumer to which the notification should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The NF service consumer shall generate a Location header field containing a URI pointing to the endpoint of another NF service consumer to which the notification should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent.

NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]).

Location

string

M

1

A URI pointing to the endpoint of the NF service consumer to which the notification should be sent

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected

Location

string

M

1

A URI pointing to the endpoint of the NF service consumer to which the notification should be sent

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected

ContextCreateReqData

6.5.6.2.2

Data within ContextCreate Request

ContextCreateRspData

6.5.6.2.3

Data within ContextCreate Response

ContextStatusNotification

6.5.6.2.4

Data within ContextStatusNotify Request

ContextUpdateReqData

6.5.6.2.5

Data within ContextUpdate Request

ContextUpdateRspData

6.5.6.2.6

Data within ContextUpdate Response

N2MbsSmInfo

6.5.6.2.7

N2 MBS Session Management Information

OperationEvent

6.5.6.2.8

Operation Event

NgranFailureEvent

6.5.6.2.9

NG-RAN failure event

OperationStatus

6.5.6.3.3

Operation Status

NgapIeType

6.5.6.3.4

NGAP Information Element Type

OpEventType

6.5.6.3.5

Operation Event Type

NgranFailureIndication

6.5.6.3.6

Indication of a NG-RAN failure event

MbsSessionId

3GPP TS 29.571 [6]

MBS Session Id

AreaSessionId

3GPP TS 29.571 [6]

Area Session Id

MbsServiceArea

3GPP TS 29.571 [6]

MBS Service Area

RefToBinaryData

3GPP TS 29.571 [6]

Reference to binary body part

Uri

3GPP TS 29.571 [6]

URI

DurationSec

3GPP TS 29.571 [6]

Duration in seconds

MbsServiceAreaInfo

3GPP TS 29.571 [6]

MBS Service Area Information for a Location dependent MBS session

GlobalRanNodeId

3GPP TS 29.571 [6]

Global RAN Node Identifier

mbsSessionId

MbsSessionId

M

1

MBS Session ID

mbsServiceArea

MbsServiceArea

C

1

MBS Service Area

This IE shall be present if this is a Local broadcast MBS session.

(NOTE 1)

mbsServiceAreaInfoList

array(MbsServiceAreaInfo)

C

1..N

List of MBS service areas and their related Area Session IDs.

This IE shall be present if this is a Location dependent broadcast MBS service.

(NOTE 1)

n2MbsSmInfo

N2MbsSmInfo

M

1

This IE shall be present and shall contain N2 MBS Session Management related information.(see clause 6.5.6.4).

notifyUri

Uri

M

1

This IE shall contain the notification URI where to be notified about the status change of the broadcast MBS session context.

maxResponseTime

DurationSec

O

0..1

Maximum response time (in seconds) to receive information about the completion of the Broadcast MBS session establishment.

snssai

Snssai

M

1

This IE shall be included to indicate the S-NSSAI of the MBS session. (NOTE 2).

mbsmfId

NfInstanceId

O

0..1

This IE may be present to contain the NF Instance ID of the MB-SMF.

mbsmfServiceInstId

string

O

0..1

This IE may be present to contain the NF Service Instance ID within the NF Instance of the MB-SMF.

NOTE 1: Either the mbsServiceAreaInfoList IE or the mbsServiceArea IE shall be present.

NOTE 2: If an MB-SMF does not receive the S-NSSAI from the NEF/MBSF, the MB-SMF shall include a pre-configured default SNSSAI.

mbsSessionId

MbsSessionId

M

1

MBS session identifier.

n2MbsSmInfoList

array(N2MbsSmInfo)

O

1..10

When present, this IE shall contain N2 MBS Session Management related information.(see clause 6.5.6.4).

operationStatus

OperationStatus

C

0..1

This IE shall be present and indicate the completion of the MBS session start operation, if the AMF received the NG-RAN responses from all involved NG-RAN(s). (NOTE)

NOTE: If this IE is not present, it indicates either of the following conditions (a) not all response are received from NG-RANs, while the maximum response timer is still running, or (b) the AMF has not received the maximum response timer in the request from the MB-SMF and not all response are received from NG-RANs.

mbsSessionId

MbsSessionId

M

1

MBS Session ID

areaSessionId

AreaSessionId

C

0..1

Area Session ID

This IE shall be present if this is a Location dependent broadcast MBS service.

n2MbsSmInfoList

array(N2MbsSmInfo)

O

1..10

When present, this IE shall contain N2 MBS Session Management related information.(see clause 6.5.6.4).

operationStatus

OperationStatus

C

0..1

This IE shall be present and indicate the completion of the MBS session start or update operation, if the NF Service Consumer has requested to establish or update the Broadcast MBS session context and a response has been received from all NG-RANs.

This IE shall be present and indicate the incompletion of the MBS session start or update operation, if the NF Service Consumer has requested to establish or update the Broadcast MBS session context within a maximum response time and the AMF has not received responses from all NG-RANs before the maximum response time elapses.

(NOTE)

operationEvents

array(operationEvent)

O

1..N

This IE may be present to report a list of operation events related to the Broadcast MB Session.

NOTE: If this IE is not present, it indicates either of the following conditions (a) not all response are received from NG-RANs, while the maximum response timer is still running, or (b) the AMF has not received the maximum response timer in the request from the MB-SMF and not all response are received from NG-RANs.

mbsServiceArea

MbsServiceArea

O

0..1

MBS Service Area

This IE may be present for a Location independent broadcast MBS session.

(NOTE)

mbsServiceAreaInfoList

array(MbsServiceAreaInfo)

O

1..N

List of MBS service areas and their related Area Session IDs.

This IE may be present for a Local broadcast MBS service.

(NOTE)

n2MbsSmInfo

N2MbsSmInfo

O

0..1

When present, this IE shall contain N2 MBS Session Management related information.(see clause 6.5.6.4).

ranIdList

array(GlobalRanNodeId)

O

1..N

This IE may be included when the MBS session update is to be performed only in a list of specific NG-RAN(s) as specified in clause 8.3.2.3 of 3GPP TS 23.527 [33]).

noNgapSignallingInd

boolean

O

0..1

This IE may be present during the restoration procedure to select an alternative AMF for a Broadcast MBS Session at AMF failure as specified in clause 8.3.2.4 of 3GPP TS 23.527 [33]).

When present, this IE shall be set as following:

– true: the AMF may consider to not trigger a NGAP signaling message to any NG-RAN.

notifyUri

Uri

O

0..1

When present, this IE shall contain the notification URI where to be notified about the status change of the broadcast MBS session context.

maxResponseTime

DurationSec

O

0..1

Maximum response time (in seconds) to receive information about the completion of the Broadcast MBS session update.

n2MbsInfoChangeInd

boolean

O

0..1

When present, this IE shall indicate whether the information within the N2 MBS Session Management container has changed or not, as follows:

– true: the information has changed;

– false: the information has not changed.

NOTE: Either the mbsServiceAreaInfoList IE or the mbsServiceArea IE may be present.

n2MbsSmInfoList

array(N2MbsSmInfo)

O

1..10

When present, this IE shall contain N2 MBS Session Management related information.(see clause 6.5.6.4).

operationStatus

OperationStatus

C

0..1

This IE shall be present and indicate the completion of the MBS session start operation, if the AMF received the NG-RAN responses from all involved NG-RAN(s). (NOTE)

NOTE: If this IE is not present, it indicates either of the following conditions (a) not all response are received from NG-RANs, while the maximum response timer is still running, or (b) the AMF has not received the maximum response timer in the request from the MB-SMF and not all response are received from NG-RANs.

ngapIeType

NgapIeType

M

1

This IE shall indicate the NGAP IE type of the ngapData as specified in clause 6.5.6.3.4.

ngapData

RefToBinaryData

M

1

This IE shall contain the reference to the binary data part carrying the NGAP data.

ranId

GlobalRanNodeId

M

1

This IE shall indicate the Global RAN ID of the gNB that generated the N2 MBS Session Management related information.

opEventType

OpEventType

M

1

Indicates the event type of an operation event related to the Broadcast MBS Session.

amfId

NfInstanceId

C

0..1

This IE shall be present to contain the NF Instance ID of the AMF sending the Context Status Notify Request message if the operation event type indicates an AMF change event.

ngranFailureEventList

array(NgranFailureEvent)

C

1..N

This IE shall be present if the event type is related to a NG-RAN.

ngranId

GlobalRanNodeId

M

1

Indicates the identity of the RAN node. The IE shall contain the gNB ID.

ngranFailureIndication

NgranFailureIndication

M

1

This IE shall contain the information related to the NG-RAN failure.

"MBS_SESSION_START_COMPLETE"

This value indicates the completion of the Broadcast MBS session establishment, i.e. that the AMF has received a response from all NG-RANs.

" MBS_SESSION_START_INCOMPLETE"

This value indicates the incompletion of the Broadcast MBS session establishment because the AMF has not received responses from all NG-RANs before the maximum response time that was indicated in the request elapses.

"MBS_SESSION_UPDATE_COMPLETE"

This value indicates the completion of the Broadcast MBS session update, i.e. that the AMF has received a response from all NG-RANs.

" MBS_SESSION_UPDATE_INCOMPLETE"

This value indicates incompletion of the Broadcast MBS session update because the AMF has not received responses from all NG-RANs before the maximum response time that was indicated in the request elapses.

"MBS_SES_REQ"

MBS Session Setup or Modification Request Transfer

"MBS_SES_RSP"

MBS Session Setup or Modification Response Transfer

"MBS_SES_FAIL"

MBS Session Setup or Modification Failure Transfer

"MBS_SES_REL_RSP"

MBS Session Release Response Transfer

"AMF_CHANGE"

This value indicates that the AMF has taken over of the Broadcast MBS Session.

"NG_RAN_EVENT"

This value indicates that an event related to a NG-RAN for the Broadcast MBS Session has taken place.

"NG_RAN_RESTART_OR_START"

This value indicates that the AMF has detected a (re)start of a NG-RAN.

"NG_RAN_FAILURE_WITHOUT_RESTART"

This value indicates that the AMF has detected a NG-RAN failure without a restart.

"NG_RAN_NOT_REACHABLE"

This value indicates that the AMF has failed to reach the NG-RAN when sending a NGAP MBS Session Setup/Modification/Release Request message.

N2 Information

6.5.6.4.3

vnd.3gpp.ngap

MBS Session Setup or Modification Request Transfer

9.3.5.3

BROADCAST SESSION SETUP REQUEST

BROADCAST SESSION MODIFICATION REQUEST

MBS Session Setup or Modification Response Transfer

9.3.5.5

BROADCAST SESSION SETUP RESPONSE

BROADCAST SESSION MODIFICATION RESPONSE

MBS Session Setup or Modification Failure Transfer

9.3.5.6

BROADCAST SESSION SETUP FAILURE

BROADCAST SESSION MODIFICATION FAILURE

MBS Session Release Response Transfer

9.3.5.14

BROADCAST SESSION RELEASE RESPONSE

(NOTE)

NOTE: An MBS Session Release Response Transfer IE shall only be sent to the MB-SMF during a Broadcast MBS Session Release Require procedure (see clause 7.3.6 of 3GPP TS 23.247 [55]), when unicast transport applies over N3mb, to transfer the DL F-TEID of the NG-RAN node in which the MBS session has been released and towards which the delivery of MBS data shall be stopped.