Commit 82870d4c authored by dongwwei's avatar dongwwei
Browse files

Update TS29392_MMTel_DCAppCall.yaml after CT3#145

parent b4b45eed
Loading
Loading
Loading
Loading
Loading
+64 −96
Original line number Diff line number Diff line
openapi: 3.0.0

info:
  title: MMTel_DCAppCall
  version: 1.0.0
  title: MMTel_DCAppCall API
  version: 1.0.1
  description: |
    MMTel Enabler Server DC Application Call Service.  
    © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  
    © 2026, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  
    All rights reserved.

externalDocs:
  description: |
    3GPP TS 29.392 V19.0.0; 
    3GPP TS 29.392 V19.1.0; 
    Application layer support for MMTel; MMTel Enabler Server Services; Stage 3.
  url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.392/

@@ -23,16 +23,15 @@ servers:

security:
  - {}
  - oAuth2ClientCredentials:
    - mmtel-dcappcall
  - oAuth2ClientCredentials: []

paths:
  /dccall:
    post:
      summary: Request to Establish a call with DC capability.
      operationId: DcCallRequest
      tags:
        - Custom Operation (No Resource)
      operationId: createDcCall
        - DC Call Establishment Request
      requestBody:
        required: true
        content:
@@ -42,29 +41,15 @@ paths:
      responses:
        '200':
          description: >
            Call establishment successful
            OK. The requested DC Call information is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DcCallResp'
        '307':
          description: Temporary Redirect
          headers:
            Location:
              description: Resource URI of the alternative MMTel Enabler Server
              schema:
                type: string
                format: uri
          content: {}
          $ref: 'TS29122_CommonData.yaml#/components/responses/307'
        '308':
          description: Permanent Redirect
          headers:
            Location:
              description: Resource URI of the alternative MMTel Enabler Server
              schema:
                type: string
                format: uri
          content: {}  
          $ref: 'TS29122_CommonData.yaml#/components/responses/308'
        '400':
          $ref: 'TS29122_CommonData.yaml#/components/responses/400'
        '401':
@@ -102,7 +87,8 @@ paths:
              responses:
                '200':
                  description: >
                    Call establishment successful
                    OK. The DC Media Notification is successfully received and DC Media related
                    information is returned in the response body.
                  content:
                    application/json:
                      schema:
@@ -137,9 +123,9 @@ paths:
  /update-dc-media:
    post:
      summary: Update DC media of an existing session.
      operationId: DcMediaUpdateRequest
      tags:
        - Custom Operation (No Resource)
      operationId: updateDcMedia
        - DC Media Update Request
      requestBody:
        required: true
        content:
@@ -149,29 +135,15 @@ paths:
      responses:
        '200':
          description: >
            Call establishment successful
            OK. The requested DC Media update information is successfully returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DcMediaUpdateResp'
        '307':
          description: Temporary Redirect
          headers:
            Location:
              description: Resource URI of the alternative MMTel Enabler Server
              schema:
                type: string
                format: uri
          content: {}
          $ref: 'TS29122_CommonData.yaml#/components/responses/307'
        '308':
          description: Permanent Redirect
          headers:
            Location:
              description: Resource URI of the alternative MMTel Enabler Server
              schema:
                type: string
                format: uri
          content: {}  
          $ref: 'TS29122_CommonData.yaml#/components/responses/308'
        '400':
          $ref: 'TS29122_CommonData.yaml#/components/responses/400'
        '401':
@@ -198,7 +170,6 @@ paths:
          $ref: 'TS29122_CommonData.yaml#/components/responses/default'



components:
  securitySchemes:
    oAuth2ClientCredentials:
@@ -210,18 +181,13 @@ components:

  schemas:

    # DC call establishment request
    DcCallReq:
      type: object
      required:
        - terminatingId
        - notificationInfo
        - callType
      properties:
        originatingId:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
          $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
        terminatingId:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
          $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
        mediaInfo:
          type: array
          items:
@@ -229,25 +195,24 @@ components:
          minItems: 1
        dcMediaInfo:
          type: boolean
          description: Indicator of whether DC media is to be used
          description: Indicates whether the DC Media is expected to be used or not.
            true indicates that the DC Media is expected to be used.
            false (default) indicates that the DC Media is not expected to be used.
        appProfileRequested:
          $ref: 'TS29392_MMTel_DCAppManagement.yaml#/components/schemas/DcAppUpdateParameters'
        notificationInfo:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
          $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
        callType:
          $ref: '#/components/schemas/CallType'
    # DC call establishment response
    DcCallResp:
      type: object
      required:
        - callResult
        - terminatingId
        - notificationInfo
        - callType
    DcCallResp:
      type: object
      properties:
        callResult:
          type: string
          enum: [SUCCESS, FAILED]
          description: Result of call establishment
          $ref: 'TS29392_MMTel_DCAppManagement.yaml#/components/schemas/Status'
        sessionId:
          type: string
          description: Call session identifier, maps to callSessionId in OMA Third Party Call API
@@ -255,9 +220,9 @@ components:
          type: string
          description: Cause of call establishment failure
        originatingId:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
          $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
        terminatingId:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
          $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
        mediaInfo:
          type: array
          items:
@@ -271,13 +236,12 @@ components:
          $ref: 'TS29392_MMTel_DCAppManagement.yaml#/components/schemas/DcAppUpdateParameters'
        callType:
          $ref: '#/components/schemas/CallType'
    # DC media update request
      required:
        - callResult
        - terminatingId
        - callType
    DcMediaUpdateReq:
      type: object
      required:
        - dcAppId
        - sessionId
        - notificationInfo
      properties:
        dcAppId:
          type: string
@@ -291,31 +255,29 @@ components:
        appProfileRequested:
          $ref: 'TS29392_MMTel_DCAppManagement.yaml#/components/schemas/DcAppUpdateParameters'
        notificationInfo:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
          $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
        mediaDirection:
          $ref: '#/components/schemas/AdcType'
    # DC media update response
    DcMediaUpdateResp:
      type: object
      required:
        - dcAppId
        - sessionId
        - result
        - notificationInfo
    DcMediaUpdateResp:
      type: object
      properties:
        sessionId:
          type: string
          description: Session identifier
        result:
          type: string
          description: Result of the update request
          $ref: 'TS29392_MMTel_DCAppManagement.yaml#/components/schemas/Status'
        cause:
          type: string
          description: Cause of update request failure
    # DC media notification request
    DcMediaNotifyReq:
      type: object
      required:
        - sessionId
        - mediaResourceInfo
        - result
    DcMediaNotifyReq:
      type: object
      properties:
        sessionId:
          type: string
@@ -325,22 +287,23 @@ components:
          description: Media information transmitted via the Data Channel
        mediaDirection:
          $ref: '#/components/schemas/AdcType'
    # DC media notification response
    DcMediaNotifyResp:
      type: object
      required:
        - sessionId
        - result
        - mediaResourceInfo
    DcMediaNotifyResp:
      type: object
      properties:
        sessionId:
          type: string
          description: Session identifier
        result:
          type: string
          description: Result of notification receipt
          $ref: 'TS29392_MMTel_DCAppManagement.yaml#/components/schemas/Status'
        cause:
          type: string
          description: Cause of notification processing failure
      required:
        - sessionId
        - result

#
# SIMPLE DATA TYPES
@@ -351,11 +314,6 @@ components:
#

    AdcType:
      description: >
        The type of the data channel media direction.
        Possible values are:
        - A2P: Presenting Data Channel initiated by Application.
        - P2P: Presenting Data Channel initiated by UE.
      anyOf:
        - type: string
          enum:
@@ -365,13 +323,15 @@ components:
          description: >
            This string provides forward-compatibility with future extensions to the enumeration
            and is not used to encode content defined in the present version of this API.
      description: |
        Represents the type of the data channel media direction.  
        Possible values are:
        - A2P: Indicates that the type of the data channel media direction is a Data Channel
          initiated by the Application.
        - P2P: Indicates that the type of the data channel media direction is a Data Channel
          initiated by the UE.

    CallType:
      description: >
        Indicate the type of established call.
        Possible values are:
        - A2P: Presenting the call as Application call initiated by Application to UE.
        - P2P: Presenting the call as Third Party call established between two UEs.
      anyOf:
        - type: string
          enum:
@@ -381,3 +341,11 @@ components:
          description: >
            This string provides forward-compatibility with future extensions to the enumeration
            and is not used to encode content defined in the present version of this API.
      description: |
        Represents the established call type.  
        Possible values are:
        - A2P: Indicates that the established call type is an Application call initiated by the
          Application towards the UE.
        - P2P: Indicates that the established call type is a Third Party call established between
          two UEs.