OpenAPI
OpenAPI Version: 3.0.0
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
Namf_MT service allows a NF to request information related to capabilities to send MT signaling or data to a target UE. The following are the key functionalities of this NF service.
Paging UE if UE is in IDLE state and respond other NF after the UE enters CM-CONNECTED state.
Response to the requester NF if UE is in CONNECTED state.
Providing the terminating domain selection information for IMS voice to the consumer NF
OpenAPI Version: 3.0.0
Version: 1.0.2
Title: Namf_MT
Description: |
AMF Mobile Termination Service
© 2019, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
URL: '{apiRoot}/namf-mt/v1'
Variables:
API Root:
Default: https://example.com
Description: apiRoot as defined in subclause subclause 4.4 of 3GPP TS 29.501
- {}
- oAuth2ClientCredentials:
- namf-mt
'/ue-contexts/{ueContextId}':
get:
Summary: Namf_MT Provide Domain Selection Info service Operation
Tags:
- ueContext (Document)
Operation ID: Provide Domain Selection Info
Parameters:
- Name: ueContextId
In: path
Description: UE Context Identifier
Required/Optional: true
Schema:
Type: string
pattern: '^(imsi-[0-9]{5,15}|nai-.+|.+)$'
- Name: info-class
In: query
Description: UE Context Information Class
Schema:
Reference: '#/components/schemas/UeContextInfoClass'
- Name: supported-features
In: query
Description: Supported Features
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
Responses:
'200':
Description: Requested UE Context Information returned
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/UeContextInfo'
'307':
Description: Temporary Redirect
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
Headers:
Location:
Description: 'The URI of the resource located on the target NF Service Consumer (e.g. AMF) to which the request is redirected'
Required/Optional: true
Schema:
Type: string
'400':
Reference: 'TS29571_CommonData.yaml#/components/responses/400'
'403':
Reference: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
Reference: 'TS29571_CommonData.yaml#/components/responses/404'
'414':
Reference: 'TS29571_CommonData.yaml#/components/responses/414'
'429':
Reference: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
Reference: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29571_CommonData.yaml#/components/responses/503'
Default:
Description: Unexpected error
put:
Summary: Namf_MT EnableUEReachability service Operation
Tags:
- ueReachInd (Document)
Operation ID: EnableUeReachability
Parameters:
- Name: ueContextId
In: path
Description: UE Context Identifier
Required/Optional: true
Schema:
Type: string
Request Body:
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/EnableUeReachabilityReqData'
Required/Optional: true
Responses:
'200':
Description: UE has become reachable as desired
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/EnableUeReachabilityRspData'
'307':
Description: Temporary Redirect
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
Headers:
Location:
Description: 'The URI of the resource located on the target NF Service Consumer (e.g. AMF) to which the request is redirected'
Required/Optional: true
Schema:
Type: string
'400':
Reference: 'TS29571_CommonData.yaml#/components/responses/400'
'403':
Reference: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
Reference: 'TS29571_CommonData.yaml#/components/responses/404'
'411':
Reference: 'TS29571_CommonData.yaml#/components/responses/411'
'413':
Reference: 'TS29571_CommonData.yaml#/components/responses/413'
'415':
Reference: 'TS29571_CommonData.yaml#/components/responses/415'
'429':
Reference: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
Reference: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29571_CommonData.yaml#/components/responses/503'
'504':
Reference: 'TS29571_CommonData.yaml#/components/responses/504'
Default:
Description: Unexpected error
securitySchemes:
oAuth2ClientCredentials:
Type: oauth2
Flows:
clientCredentials:
tokenUrl: '{nrfApiRoot}/oauth2/token'
scopes:
namf-mt: Access to the Namf_MT API
schemas:
EnableUeReachabilityReqData:
Type: object
Properties:
reachability:
Reference: 'TS29518_Namf_EventExposure.yaml#/components/schemas/UeReachability'
supportedFeatures:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
Required:
- reachability
EnableUeReachabilityRspData:
Type: object
Properties:
reachability:
Reference: 'TS29518_Namf_EventExposure.yaml#/components/schemas/UeReachability'
supportedFeatures:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
Required:
- reachability
UeContextInfo:
Type: object
Properties:
supportVoPS:
Type: boolean
supportVoPSn3gpp:
Type: boolean
lastActTime:
Reference: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
accessType:
Reference: 'TS29571_CommonData.yaml#/components/schemas/AccessType'
ratType:
Reference: 'TS29571_CommonData.yaml#/components/schemas/RatType'
supportedFeatures:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
UeContextInfoClass:
anyOf:
- type: string
enum:
- TADS
- type: string
Description: 3GPP TS 29.518 V15.3.0; 5G System; Access and Mobility Management Services
URL: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.518/'