API docs by Redocly

Namf_Communication (1.3.2)

Download OpenAPI specification:

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

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

Individual ueContext (Document)

Namf_Communication CreateUEContext service Operation

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
ueContextId
required
string^(5g-guti-[0-9]{5,6}[0-9a-fA-F]{14}|imsi-[0-9...

UE Context Identifier

Request Body schema: multipart/related
required
object (UeContextCreateData)

Data within a request to create an individual ueContext resource

binaryDataN2Information
string <binary>
binaryDataN2InformationExt1
string <binary>
binaryDataN2InformationExt2
string <binary>
binaryDataN2InformationExt3
string <binary>
binaryDataN2InformationExt4
string <binary>
binaryDataN2InformationExt5
string <binary>
binaryDataN2InformationExt6
string <binary>
binaryDataN2InformationExt7
string <binary>
binaryDataN2InformationExt8
string <binary>
binaryDataN2InformationExt9
string <binary>
binaryDataN2InformationExt10
string <binary>
binaryDataN2InformationExt11
string <binary>
binaryDataN2InformationExt12
string <binary>
binaryDataN2InformationExt13
string <binary>
binaryDataN2InformationExt14
string <binary>
binaryDataN2InformationExt15
string <binary>
binaryDataN2InformationExt16
string <binary>
binaryDataN2InformationExt17
string <binary>

Responses

Callbacks

Response samples

Content type
{
  • "ueContext": {
    },
  • "targetToSourceData": {
    },
  • "pduSessionList": [
    ],
  • "failedSessionList": [
    ],
  • "supportedFeatures": "string",
  • "pcfReselectedInd": true,
  • "analyticsNotUsedList": [
    ]
}

Callback payload samples

Callback
POST: Namf_Communication N2 Info Notify (UE Specific) service Operation
Content type
application/json
{
  • "n2NotifySubscriptionId": "string",
  • "n2InfoContainer": {
    },
  • "toReleaseSessionList": [
    ],
  • "lcsCorrelationId": "string",
  • "notifyReason": "HANDOVER_COMPLETED",
  • "smfChangeInfoList": [
    ],
  • "ranNodeId": {
    },
  • "initialAmfName": "string",
  • "anN2IPv4Addr": "198.51.100.1",
  • "anN2IPv6Addr": "2001:db8:85a3::8a2e:370:7334",
  • "guami": {
    },
  • "notifySourceNgRan": false,
  • "notifCorrelationId": "string",
  • "toReleaseSessionInfo": [
    ]
}

Namf_Communication ReleaseUEContext service Operation

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
ueContextId
required
string^(5g-guti-[0-9]{5,6}[0-9a-fA-F]{14}|imsi-[0-9...

UE Context Identifier

Request Body schema: application/json
required
supi
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

String identifying a Supi that shall contain either an IMSI, a network specific identifier, a Global Cable Identifier (GCI) or a Global Line Identifier (GLI) as specified in clause 2.2A of 3GPP TS 23.003. It shall be formatted as follows

  • for an IMSI "imsi-", where shall be formatted according to clause 2.2 of 3GPP TS 23.003 that describes an IMSI.
  • for a network specific identifier "nai-, where shall be formatted according to clause 28.7.2 of 3GPP TS 23.003 that describes an NAI.
  • for a GCI "gci-", where shall be formatted according to clause 28.15.2 of 3GPP TS 23.003.
  • for a GLI "gli-", where shall be formatted according to clause 28.16.2 of 3GPP TS 23.003.To enable that the value is used as part of an URI, the string shall only contain characters allowed according to the "lower-with-hyphen" naming convention defined in 3GPP TS 29.501.
unauthenticatedSupi
boolean
Default: false
required
object (NgApCause)

Represents the NGAP cause.

Responses

Request samples

Content type
application/json
{
  • "supi": "string",
  • "unauthenticatedSupi": false,
  • "ngapCause": {
    }
}

Response samples

Content type
application/json
{
  • "cause": "string",
  • "targetScp": "string",
  • "targetSepp": "string"
}

Namf_Communication EBI Assignment service Operation

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
ueContextId
required
string^(5g-guti-[0-9]{5,6}[0-9a-fA-F]{14}|imsi-[0-9...

UE Context Identifier

Request Body schema: application/json
required
pduSessionId
required
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.

Array of objects (Arp) non-empty
releasedEbiList
Array of integers (EpsBearerId) non-empty [ items [ 0 .. 15 ] ]
object (Guami)

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

Array of objects (EbiArpMapping) non-empty

Responses

Request samples

Content type
application/json
{
  • "pduSessionId": 255,
  • "arpList": [
    ],
  • "releasedEbiList": [
    ],
  • "oldGuami": {
    },
  • "modifiedEbiList": [
    ]
}

Response samples

Content type
application/json
{
  • "pduSessionId": 255,
  • "assignedEbiList": [
    ],
  • "failedArpList": [
    ],
  • "releasedEbiList": [
    ],
  • "modifiedEbiList": [
    ]
}

Namf_Communication UEContextTransfer service Operation

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
ueContextId
required
string^(5g-guti-[0-9]{5,6}[0-9a-fA-F]{14}|imsi-[0-9...

UE Context Identifier

Request Body schema:
required
required
string or string (TransferReason)

Indicates UE Context Transfer Reason

accessType
required
string (AccessType)
Enum: "3GPP_ACCESS" "NON_3GPP_ACCESS"

Indicates whether the access is via 3GPP or via non-3GPP.

object (PlmnIdNid)

Contains the serving core network operator PLMN ID and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN.

object (N1MessageContainer)

N1 Message container

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

Request samples

Content type
{
  • "reason": "INIT_REG",
  • "accessType": "3GPP_ACCESS",
  • "plmnId": {
    },
  • "regRequest": {
    },
  • "supportedFeatures": "string"
}

Response samples

Content type
{
  • "ueContext": {
    },
  • "ueRadioCapability": {
    },
  • "ueRadioCapabilityForPaging": {
    },
  • "ueNbiotRadioCapability": {
    },
  • "supportedFeatures": "string",
  • "xrDeviceWith2Rx": true
}

Namf_Communication RegistrationStatusUpdate service Operation

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
ueContextId
required
string^(5g-guti-[0-9]{5,6}[0-9a-fA-F]{14}|imsi-[0-9...

UE Context Identifier

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

Describes the status of an individual ueContext resource in UE Context Transfer procedures

toReleaseSessionList
Array of integers (PduSessionId) non-empty [ items [ 0 .. 255 ] ]
pcfReselectedInd
boolean
Array of objects (SmfChangeInfo) non-empty
analyticsNotUsedList
Array of strings (Uri) non-empty
Array of objects (ReleaseSessionInfo) non-empty

Responses

Request samples

Content type
application/json
{
  • "transferStatus": "TRANSFERRED",
  • "toReleaseSessionList": [
    ],
  • "pcfReselectedInd": true,
  • "smfChangeInfoList": [
    ],
  • "analyticsNotUsedList": [
    ],
  • "toReleaseSessionInfo": [
    ]
}

Response samples

Content type
application/json
{
  • "regStatusTransferComplete": true
}

Namf_Communication RelocateUEContext service Operation

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
ueContextId
required
string^(5g-guti-[0-9]{5,6}[0-9a-fA-F]{14}|imsi-[0-9...

UE Context Identifier

Request Body schema: multipart/related
required
object (UeContextRelocateData)

Data within a Relocate UE Context request

binaryDataForwardRelocationRequest
string <binary>
binaryDataN2Information
string <binary>
binaryDataN2InformationExt1
string <binary>
binaryDataN2InformationExt2
string <binary>
binaryDataN2InformationExt3
string <binary>
binaryDataN2InformationExt4
string <binary>
binaryDataN2InformationExt5
string <binary>
binaryDataN2InformationExt6
string <binary>
binaryDataN2InformationExt7
string <binary>
binaryDataN2InformationExt8
string <binary>
binaryDataN2InformationExt9
string <binary>
binaryDataN2InformationExt10
string <binary>
binaryDataN2InformationExt11
string <binary>
binaryDataN2InformationExt12
string <binary>
binaryDataN2InformationExt13
string <binary>
binaryDataN2InformationExt14
string <binary>
binaryDataN2InformationExt15
string <binary>
binaryDataN2InformationExt16
string <binary>

Responses

Response samples

Content type
application/json
{
  • "ueContext": {
    }
}

Namf_Communication CancelRelocateUEContext service Operation

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
ueContextId
required
string^(5g-guti-[0-9]{5,6}[0-9a-fA-F]{14}|imsi-[0-9...

UE Context Identifier

Request Body schema: multipart/related
required
object (UeContextCancelRelocateData)

Data structure used for cancellation of UE Context Relocation

binaryDataGtpcMessage
string <binary>

Responses

Response samples

Content type
application/json
{
  • "cause": "string",
  • "targetScp": "string",
  • "targetSepp": "string"
}

n1N2Message collection (Collection)

Namf_Communication N1N2 Message Transfer (UE Specific) service Operation

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

UE Context Identifier

Request Body schema:
required
object (N1MessageContainer)

N1 Message container

object (N2InfoContainer)

N2 information container

object (RefToBinaryData)

This parameter provides information about the referenced binary body data.

skipInd
boolean
Default: false
lastMsgIndication
boolean
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.

lcsCorrelationId
string (CorrelationID) [ 1 .. 255 ] characters

LCS Correlation ID.

ppi
integer (Ppi) [ 0 .. 7 ]

Paging Policy Indicator

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.

n1n2FailureTxfNotifURI
string (Uri)

String providing an URI formatted according to RFC 3986.

smfReallocationInd
boolean
Default: false
object (AreaOfValidity)

Area of validity information for N2 information transfer

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.

maAcceptedInd
boolean
Default: false
extBufSupport
boolean
Default: false
targetAccess
string (AccessType)
Enum: "3GPP_ACCESS" "NON_3GPP_ACCESS"

Indicates whether the access is via 3GPP or via non-3GPP.

nfId
string <uuid> (NfInstanceId)

String uniquely identifying a NF instance. The format of the NF Instance ID shall be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.

pruInd
boolean
Value: true
pduSessionPrio
integer (PduSessionPriority)

The priority of the PDU session

Responses

Callbacks

Request samples

Content type
{
  • "n1MessageContainer": {
    },
  • "n2InfoContainer": {
    },
  • "mtData": {
    },
  • "skipInd": false,
  • "lastMsgIndication": true,
  • "pduSessionId": 255,
  • "lcsCorrelationId": "string",
  • "ppi": 7,
  • "arp": {
    },
  • "5qi": 255,
  • "n1n2FailureTxfNotifURI": "string",
  • "smfReallocationInd": false,
  • "areaOfValidity": {
    },
  • "supportedFeatures": "string",
  • "oldGuami": {
    },
  • "maAcceptedInd": false,
  • "extBufSupport": false,
  • "targetAccess": "3GPP_ACCESS",
  • "nfId": "7c5b7ce3-5afd-4cea-83ab-84f87a407e62",
  • "pruInd": true,
  • "pduSessionPrio": 0
}

Response samples

Content type
application/json
{
  • "cause": "ATTEMPTING_TO_REACH_UE",
  • "supportedFeatures": "string"
}

Callback payload samples

Callback
POST: Namf_Communication N1N2Transfer Failure Notification service Operation
Content type
application/json
{
  • "cause": "ATTEMPTING_TO_REACH_UE",
  • "n1n2MsgDataUri": "string",
  • "retryAfter": 0
}

N1N2 Subscriptions Collection for Individual UE Contexts (Collection)

Namf_Communication N1N2 Message Subscribe (UE Specific) service Operation

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

UE Context Identifier

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

Enumeration for N2 Information Class

n2NotifyCallbackUri
string (Uri)

String providing an URI formatted according to RFC 3986.

string or string (N1MessageClass)

Enumeration for N1 Message Class

n1NotifyCallbackUri
string (Uri)

String providing an URI formatted according to RFC 3986.

nfId
string <uuid> (NfInstanceId)

String uniquely identifying a NF instance. The format of the NF Instance ID shall be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.

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.

Responses

Callbacks

Request samples

Content type
application/json
{
  • "n2InformationClass": "SM",
  • "n2NotifyCallbackUri": "string",
  • "n1MessageClass": "5GMM",
  • "n1NotifyCallbackUri": "string",
  • "nfId": "7c5b7ce3-5afd-4cea-83ab-84f87a407e62",
  • "supportedFeatures": "string",
  • "oldGuami": {
    }
}

Response samples

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

N1N2 Individual Subscription (Document)

Namf_Communication N1N2 Message UnSubscribe (UE Specific) service Operation

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

UE Context Identifier

subscriptionId
required
string

Subscription Identifier

Responses

Response samples

Content type
application/json
{
  • "cause": "string",
  • "targetScp": "string",
  • "targetSepp": "string"
}

Non UE N2Messages collection (Collection)

Namf_Communication Non UE N2 Message Transfer service Operation

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
Request Body schema:
required
Array of objects (Tai) non-empty
string or string (RatSelector)

Indicates the RAT type for the transfer of N2 information

Array of objects or objects or objects or objects or objects or objects (GlobalRanNodeId) non-empty
required
object (N2InfoContainer)

N2 information container

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

Request samples

Content type
{
  • "taiList": [
    ],
  • "ratSelector": "E-UTRA",
  • "globalRanNodeList": [
    ],
  • "n2Information": {
    },
  • "supportedFeatures": "string"
}

Response samples

Content type
{
  • "result": "N2_INFO_TRANSFER_INITIATED",
  • "pwsRspData": {
    },
  • "supportedFeatures": "string",
  • "tssRspPerNgranList": [
    ]
}

Non UE N2Messages Subscriptions collection (Collection)

Namf_Communication Non UE N2 Info Subscribe service Operation

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
Request Body schema: application/json
required
Array of objects or objects or objects or objects or objects or objects (GlobalRanNodeId) non-empty
anTypeList
Array of strings (AccessType) non-empty
Items Enum: "3GPP_ACCESS" "NON_3GPP_ACCESS"
required
string or string (N2InformationClass)

Enumeration for N2 Information Class

n2NotifyCallbackUri
required
string (Uri)

String providing an URI formatted according to RFC 3986.

nfId
string <uuid> (NfInstanceId)

String uniquely identifying a NF instance. The format of the NF Instance ID shall be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.

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.

notifCorrelationId
string

Responses

Callbacks

Request samples

Content type
application/json
{
  • "globalRanNodeList": [
    ],
  • "anTypeList": [
    ],
  • "n2InformationClass": "SM",
  • "n2NotifyCallbackUri": "string",
  • "nfId": "7c5b7ce3-5afd-4cea-83ab-84f87a407e62",
  • "supportedFeatures": "string",
  • "notifCorrelationId": "string"
}

Response samples

Content type
application/json
{
  • "n2NotifySubscriptionId": "string",
  • "supportedFeatures": "string",
  • "n2InformationClass": "SM"
}

Callback payload samples

Callback
POST: Namf_Communication Non UE N2 Info Notify service Operation
Content type
{
  • "n2NotifySubscriptionId": "string",
  • "n2InfoContainer": {
    },
  • "toReleaseSessionList": [
    ],
  • "lcsCorrelationId": "string",
  • "notifyReason": "HANDOVER_COMPLETED",
  • "smfChangeInfoList": [
    ],
  • "ranNodeId": {
    },
  • "initialAmfName": "string",
  • "anN2IPv4Addr": "198.51.100.1",
  • "anN2IPv6Addr": "2001:db8:85a3::8a2e:370:7334",
  • "guami": {
    },
  • "notifySourceNgRan": false,
  • "notifCorrelationId": "string",
  • "toReleaseSessionInfo": [
    ]
}

Non UE N2 Message Notification Individual Subscription (Document)

Namf_Communication Non UE N2 Info UnSubscribe service Operation

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
n2NotifySubscriptionId
required
string

N2 info Subscription Identifier

Responses

Response samples

Content type
application/json
{
  • "cause": "string",
  • "targetScp": "string",
  • "targetSepp": "string"
}

subscriptions collection (Collection)

Namf_Communication AMF Status Change Subscribe service Operation

Authorizations:
NoneoAuth2ClientCredentials
Request Body schema: application/json
required
amfStatusUri
required
string (Uri)

String providing an URI formatted according to RFC 3986.

Array of objects (Guami) non-empty

Responses

Callbacks

Request samples

Content type
application/json
{
  • "amfStatusUri": "string",
  • "guamiList": [
    ]
}

Response samples

Content type
application/json
{
  • "amfStatusUri": "string",
  • "guamiList": [
    ]
}

Callback payload samples

Callback
POST: Amf Status Change Notify service Operation
Content type
application/json
{
  • "amfStatusInfoList": [
    ]
}

individual subscription (Document)

Namf_Communication AMF Status Change UnSubscribe service Operation

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
subscriptionId
required
string

AMF Status Change Subscription Identifier

Responses

Response samples

Content type
application/json
{
  • "cause": "string",
  • "targetScp": "string",
  • "targetSepp": "string"
}

Namf_Communication AMF Status Change Subscribe Modify service Operation

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
subscriptionId
required
string

AMF Status Change Subscription Identifier

Request Body schema: application/json
required
amfStatusUri
required
string (Uri)

String providing an URI formatted according to RFC 3986.

Array of objects (Guami) non-empty

Responses

Callbacks

Request samples

Content type
application/json
{
  • "amfStatusUri": "string",
  • "guamiList": [
    ]
}

Response samples

Content type
application/json
{
  • "amfStatusUri": "string",
  • "guamiList": [
    ]
}

Callback payload samples

Callback
POST: Amf Status Change Notify service Operation
Content type
application/json
{
  • "amfStatusInfoList": [
    ]
}