API docs by Redocly

Namf_MT (1.3.0)

Download OpenAPI specification:

AMF Mobile Terminated Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.

3GPP TS 29.518 V18.6.0; 5G System; Access and Mobility Management Services

ueContext (Document)

Namf_MT Provide Domain Selection Info service Operation

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
ueContextId
required
string^(imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|.+)$

UE Context Identifier

query Parameters
string or string (UeContextInfoClass)

UE Context Information Class

supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

object (Guami)

Old GUAMI

Responses

Response samples

Content type
application/json
{
  • "supportVoPS": true,
  • "supportVoPSn3gpp": true,
  • "lastActTime": "2019-08-24T14:15:22Z",
  • "accessType": "3GPP_ACCESS",
  • "ratType": "NR",
  • "supportedFeatures": "string"
}

ueReachInd (Document)

Namf_MT EnableUEReachability service Operation

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
ueContextId
required
string

UE Context Identifier

Request Body schema: application/json
required
required
string or string (UeReachability)

Describes the reachability of the UE

supportedFeatures
string (SupportedFeatures) ^[A-Fa-f0-9]*$

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

object (Guami)

Globally Unique AMF Identifier constructed out of PLMN, Network and AMF identity.

extBufSupport
boolean
Default: false
Array of objects (QosFlowInfo) non-empty
pduSessionId
integer (PduSessionId) [ 0 .. 255 ]

Unsigned integer identifying a PDU session, within the range 0 to 255, as specified in clause 11.2.3.1b, bits 1 to 8, of 3GPP TS 24.007. If the PDU Session ID is allocated by the Core Network for UEs not supporting N1 mode, reserved range 64 to 95 is used. PDU Session ID within the reserved range is only visible in the Core Network.

Responses

Request samples

Content type
application/json
{
  • "reachability": "UNREACHABLE",
  • "supportedFeatures": "string",
  • "oldGuami": {
    },
  • "extBufSupport": false,
  • "qosFlowInfoList": [
    ],
  • "pduSessionId": 255
}

Response samples

Content type
application/json
{
  • "reachability": "UNREACHABLE",
  • "supportedFeatures": "string"
}

ueContexts (collection)

Namf_MT EnableGroupReachability service Operation

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
Request Body schema: application/json
required

list of UEs requested to be made reachable for the related TMGI

required
Array of objects (UeInfo) non-empty
required
object (Tmgi)

Temporary Mobile Group Identity

reachabilityNotifyUri
string (Uri)

String providing an URI formatted according to RFC 3986.

object or object (MbsServiceArea)

MBS Service Area

Array of objects (MbsServiceAreaInfo) non-empty
object (Arp)

Contains Allocation and Retention Priority information.

5qi
integer (5Qi) [ 0 .. 255 ]

Unsigned integer representing a 5G QoS Identifier (see clause 5.7.2.1 of 3GPP TS 23.501, within the range 0 to 255.

supportedFeatures
string (SupportedFeatures) ^[A-Fa-f0-9]*$

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Responses

Callbacks

Request samples

Content type
application/json
{
  • "ueInfoList": [
    ],
  • "tmgi": {
    },
  • "reachabilityNotifyUri": "string",
  • "mbsServiceArea": {
    },
  • "mbsServiceAreaInfoList": [
    ],
  • "arp": {
    },
  • "5qi": 255,
  • "supportedFeatures": "string"
}

Response samples

Content type
application/json
{
  • "ueConnectedList": [
    ],
  • "supportedFeatures": "string"
}

Callback payload samples

Callback
POST: {$request.body#/reachabilityNotifyUri}
Content type
application/json
{
  • "reachableUeList": [
    ],
  • "unreachableUeList": [
    ]
}