openapi: 3.0.0
info:
  title: SAP API
  version: 1.0.0
servers:
- url: http://localhost:8080
paths:
  /rfc/OUTGOING_CALL_PROCESS:
    post:
      tags:
      - PHON
      summary: Screen for initiating call, incl. display and exit possibility
      operationId: /rfc/OUTGOING_CALL_PROCESS
      requestBody:
        content:
          application/json:
            schema:
              properties:
                ACTION:
                  type: string
                  default: D
                  maxLength: 1
                  description: 'Action for execute w/o dialog: D=Dial, E=Hang up'
                ADDRESS_NUMBER:
                  type: object
                  properties:
                    ADDRNUMBER:
                      type: string
                      maxLength: 10
                      description: Address number
                    PERSNUMBER:
                      type: string
                      maxLength: 10
                      description: Person number
                    ADDR_TYPE:
                      type: string
                      maxLength: 1
                      description: 'Address type (1=Organization, 2=Person, 3=Contact person)  enumValues: 1=Organization, Company,2=Private address,3=Contact person (in company)'
                      enum:
                      - '1'
                      - '2'
                      - '3'
                    ADDRHANDLE:
                      type: string
                      maxLength: 140
                      description: Handle for Creating Addresses/Persons (Bus. Addr. Services)
                    PERSHANDLE:
                      type: string
                      maxLength: 140
                      description: Handle for Creating Addresses/Persons (Bus. Addr. Services)
                BUTTON_TEXT:
                  type: string
                  maxLength: 20
                  description: Text for optional button
                CALLBACK_FUNCTION:
                  type: string
                  default: ' '
                  maxLength: 30
                  description: Function to be executed by optional button
                COMPANY_IN:
                  type: string
                  maxLength: 55
                  description: Name of call recipient
                COUNTRY_TO:
                  type: string
                  maxLength: 3
                  description: Country code of call recipient
                DISPLAY_POPUP:
                  type: string
                  default: X
                  maxLength: 1
                  description: Flag indicating whether dialog is to be displayed
                HANDLE_IN:
                  type: string
                  maxLength: 32
                  description: Name of call recipient
                ITS_MODE:
                  type: string
                  default: ' '
                  maxLength: 1
                  description: Name of call recipient
                NAME_IN:
                  type: string
                  maxLength: 55
                  description: Name of call recipient
                POPUP_MODE:
                  type: string
                  default: ' '
                  maxLength: 1
                  description: Dialog box for dialing instead of directly calling SAPphone
                POPUP_TITLE:
                  type: string
                  maxLength: 20
                  description: Dialog box title
                REMARK_IN:
                  type: string
                  maxLength: 55
                  description: Name of call recipient
                TEL_NUMBER:
                  type: string
                  maxLength: 30
                  description: Telephone number split according to prefic and main number
                TEST_MODE:
                  type: string
                  default: ' '
                  maxLength: 1
                  description: Execution in test mode (RFC test, display)
                ADDR_LIST:
                  type: array
                  items:
                    type: object
                    properties:
                      ADDRNUMBER:
                        type: string
                        maxLength: 10
                        description: Address number
                      PERSNUMBER:
                        type: string
                        maxLength: 10
                        description: Person number
                      ADDR_TYPE:
                        type: string
                        maxLength: 1
                        description: 'Address type (1=Organization, 2=Person, 3=Contact person)  enumValues: 1=Organization, Company,2=Private address,3=Contact person (in company)'
                        enum:
                        - '1'
                        - '2'
                        - '3'
                      ADDRHANDLE:
                        type: string
                        maxLength: 140
                        description: Handle for Creating Addresses/Persons (Bus. Addr. Services)
                      PERSHANDLE:
                        type: string
                        maxLength: 140
                        description: Handle for Creating Addresses/Persons (Bus. Addr. Services)
                EXCLUDED:
                  type: array
                  items:
                    type: object
                    properties:
                      FCODE:
                        type: string
                        maxLength: 20
                        description: Function Code
                EXTCALLS:
                  type: array
                  items:
                    type: object
                    properties:
                      HANDLE:
                        type: string
                        maxLength: 32
                        description: Call identifier assigned by WS software
                      STATE:
                        type: integer
                        format: int64
                        description: 'SAPphone: Call status  enumValues: 01=Initiated,00=Unknown,03=Connected,04=On hold,06=Failed,02=Ringing,05=In queue,07=Offered'
                        enum:
                        - '01'
                        - '00'
                        - '03'
                        - '04'
                        - '06'
                        - '02'
                        - '05'
                        - '07'
                      PARTY:
                        type: string
                        maxLength: 30
                        description: Telephone number
                      PTYPE:
                        type: string
                        maxLength: 1
                        description: 'SAPphone: Type of call partner (internal/external)  enumValues: I=Internal,E=External'
                        enum:
                        - I
                        - E
                      DNIS:
                        type: string
                        maxLength: 30
                        description: Telephone number
                EXTCALLS_PER_EXTENSION:
                  type: array
                  items:
                    type: object
                    properties:
                      TELNO:
                        type: string
                        maxLength: 10
                        description: 'SAPphone: Extension (Part of a Telephone Number)'
                      SERVER:
                        type: string
                        maxLength: 6
                        description: 'SAPphone: Telephony Server Key'
                      HANDLE:
                        type: string
                        maxLength: 32
                        description: Call identifier assigned by WS software
                      STATE:
                        type: integer
                        format: int64
                        description: 'SAPphone: Call status  enumValues: 01=Initiated,00=Unknown,03=Connected,04=On hold,06=Failed,02=Ringing,05=In queue,07=Offered'
                        enum:
                        - '01'
                        - '00'
                        - '03'
                        - '04'
                        - '06'
                        - '02'
                        - '05'
                        - '07'
                      PARTY:
                        type: string
                        maxLength: 30
                        description: Telephone number
                      PTYPE:
                        type: string
                        maxLength: 1
                        description: 'SAPphone: Type of call partner (internal/external)  enumValues: I=Internal,E=External'
                        enum:
                        - I
                        - E
                      DNIS:
                        type: string
                        maxLength: 30
                        description: Telephone number
                FIELDS:
                  type: array
                  items:
                    type: object
                    properties:
                      NAME:
                        type: string
                        maxLength: 20
                        description: 'SAPphone: Parameter name'
                      VALUE:
                        type: string
                        maxLength: 55
                        description: 'SAPphone: Parameter value (length 55)'
                TELNO_LIST:
                  type: array
                  items:
                    type: object
                    properties:
                      TELNO:
                        type: string
                        maxLength: 30
                        description: Telephone number
                      COUNTRY:
                        type: string
                        maxLength: 3
                        description: Country Key
                      NAME:
                        type: string
                        maxLength: 55
                        description: 'SAPphone: Name of a person'
                      COMPANY:
                        type: string
                        maxLength: 55
                        description: 'SAPphone: Company'
                      REMARK:
                        type: string
                        maxLength: 55
                        description: 'SAPphone: Comments'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  COMPANY_OUT:
                    type: string
                    maxLength: 55
                    description: Company of call recipient
                  DIAL_BUTTON_PRESSED:
                    type: string
                    maxLength: 1
                    description: Dial button was activated
                  HANDLE_OUT:
                    type: string
                    maxLength: 32
                    description: Call ID
                  NAME_OUT:
                    type: string
                    maxLength: 55
                    description: Name of call recipient
                  NUMBER_CALLED:
                    type: string
                    maxLength: 30
                    description: (Converted) number dialed
                  OPT_BUTTON_PRESSED:
                    type: string
                    maxLength: 1
                    description: Optional button was pressed
                  REMARK_OUT:
                    type: string
                    maxLength: 55
                    description: Company of call recipient
                  ADDR_LIST:
                    type: array
                    items:
                      type: object
                      properties:
                        ADDRNUMBER:
                          type: string
                          maxLength: 10
                          description: Address number
                        PERSNUMBER:
                          type: string
                          maxLength: 10
                          description: Person number
                        ADDR_TYPE:
                          type: string
                          maxLength: 1
                          description: 'Address type (1=Organization, 2=Person, 3=Contact person)  enumValues: 1=Organization, Company,2=Private address,3=Contact person (in company)'
                          enum:
                          - '1'
                          - '2'
                          - '3'
                        ADDRHANDLE:
                          type: string
                          maxLength: 140
                          description: Handle for Creating Addresses/Persons (Bus. Addr. Services)
                        PERSHANDLE:
                          type: string
                          maxLength: 140
                          description: Handle for Creating Addresses/Persons (Bus. Addr. Services)
                  EXCLUDED:
                    type: array
                    items:
                      type: object
                      properties:
                        FCODE:
                          type: string
                          maxLength: 20
                          description: Function Code
                  EXTCALLS:
                    type: array
                    items:
                      type: object
                      properties:
                        HANDLE:
                          type: string
                          maxLength: 32
                          description: Call identifier assigned by WS software
                        STATE:
                          type: integer
                          format: int64
                          description: 'SAPphone: Call status  enumValues: 01=Initiated,00=Unknown,03=Connected,04=On hold,06=Failed,02=Ringing,05=In queue,07=Offered'
                          enum:
                          - '01'
                          - '00'
                          - '03'
                          - '04'
                          - '06'
                          - '02'
                          - '05'
                          - '07'
                        PARTY:
                          type: string
                          maxLength: 30
                          description: Telephone number
                        PTYPE:
                          type: string
                          maxLength: 1
                          description: 'SAPphone: Type of call partner (internal/external)  enumValues: I=Internal,E=External'
                          enum:
                          - I
                          - E
                        DNIS:
                          type: string
                          maxLength: 30
                          description: Telephone number
                  EXTCALLS_PER_EXTENSION:
                    type: array
                    items:
                      type: object
                      properties:
                        TELNO:
                          type: string
                          maxLength: 10
                          description: 'SAPphone: Extension (Part of a Telephone Number)'
                        SERVER:
                          type: string
                          maxLength: 6
                          description: 'SAPphone: Telephony Server Key'
                        HANDLE:
                          type: string
                          maxLength: 32
                          description: Call identifier assigned by WS software
                        STATE:
                          type: integer
                          format: int64
                          description: 'SAPphone: Call status  enumValues: 01=Initiated,00=Unknown,03=Connected,04=On hold,06=Failed,02=Ringing,05=In queue,07=Offered'
                          enum:
                          - '01'
                          - '00'
                          - '03'
                          - '04'
                          - '06'
                          - '02'
                          - '05'
                          - '07'
                        PARTY:
                          type: string
                          maxLength: 30
                          description: Telephone number
                        PTYPE:
                          type: string
                          maxLength: 1
                          description: 'SAPphone: Type of call partner (internal/external)  enumValues: I=Internal,E=External'
                          enum:
                          - I
                          - E
                        DNIS:
                          type: string
                          maxLength: 30
                          description: Telephone number
                  FIELDS:
                    type: array
                    items:
                      type: object
                      properties:
                        NAME:
                          type: string
                          maxLength: 20
                          description: 'SAPphone: Parameter name'
                        VALUE:
                          type: string
                          maxLength: 55
                          description: 'SAPphone: Parameter value (length 55)'
                  TELNO_LIST:
                    type: array
                    items:
                      type: object
                      properties:
                        TELNO:
                          type: string
                          maxLength: 30
                          description: Telephone number
                        COUNTRY:
                          type: string
                          maxLength: 3
                          description: Country Key
                        NAME:
                          type: string
                          maxLength: 55
                          description: 'SAPphone: Name of a person'
                        COMPANY:
                          type: string
                          maxLength: 55
                          description: 'SAPphone: Company'
                        REMARK:
                          type: string
                          maxLength: 55
                          description: 'SAPphone: Comments'
        '400':
          description: Bad request.
        5XX:
          description: Unexpected error.
