RingCentral API — RingOut

naftiko: 1.0.0-alpha2
info:
  label: RingCentral API — RingOut
  description: 'RingCentral API — RingOut. 3 operations. Lead operation: Make RingOut Call. Self-contained Naftiko capability
    covering one Ringcentral business surface.'
  tags:
  - Ringcentral
  - RingOut
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    RINGCENTRAL_API_KEY: RINGCENTRAL_API_KEY
capability:
  consumes:
  - type: http
    namespace: platform-ringout
    baseUri: https://platform.ringcentral.com
    description: RingCentral API — RingOut business capability. Self-contained, no shared references.
    resources:
    - name: restapi-v1.0-account-accountId-extension-extensionId-ring-out
      path: /restapi/v1.0/account/{accountId}/extension/{extensionId}/ring-out
      operations:
      - name: createringoutcall
        method: POST
        description: Make RingOut Call
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: restapi-v1.0-account-accountId-extension-extensionId-ring-out-ringoutId
      path: /restapi/v1.0/account/{accountId}/extension/{extensionId}/ring-out/{ringoutId}
      operations:
      - name: readringoutcallstatus
        method: GET
        description: Get RingOut Call Status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ringoutId
          in: path
          type: string
          description: Internal identifier of a RingOut call
          required: true
      - name: deleteringoutcall
        method: DELETE
        description: Cancel RingOut Call
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ringoutId
          in: path
          type: string
          description: Internal identifier of a RingOut call
          required: true
    authentication:
      type: bearer
      token: '{{env.RINGCENTRAL_API_KEY}}'
  exposes:
  - type: rest
    namespace: platform-ringout-rest
    port: 8080
    description: REST adapter for RingCentral API — RingOut. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/restapi/v1-0/account/{accountid}/extension/{extensionid}/ring-out
      name: restapi-v1-0-account-accountid-extension-extensionid-ring-out
      description: REST surface for restapi-v1.0-account-accountId-extension-extensionId-ring-out.
      operations:
      - method: POST
        name: createringoutcall
        description: Make RingOut Call
        call: platform-ringout.createringoutcall
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/restapi/v1-0/account/{accountid}/extension/{extensionid}/ring-out/{ringoutid}
      name: restapi-v1-0-account-accountid-extension-extensionid-ring-out-ringoutid
      description: REST surface for restapi-v1.0-account-accountId-extension-extensionId-ring-out-ringoutId.
      operations:
      - method: GET
        name: readringoutcallstatus
        description: Get RingOut Call Status
        call: platform-ringout.readringoutcallstatus
        with:
          ringoutId: rest.ringoutId
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteringoutcall
        description: Cancel RingOut Call
        call: platform-ringout.deleteringoutcall
        with:
          ringoutId: rest.ringoutId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: platform-ringout-mcp
    port: 9090
    transport: http
    description: MCP adapter for RingCentral API — RingOut. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: make-ringout-call
      description: Make RingOut Call
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: platform-ringout.createringoutcall
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-ringout-call-status
      description: Get RingOut Call Status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-ringout.readringoutcallstatus
      with:
        ringoutId: tools.ringoutId
      outputParameters:
      - type: object
        mapping: $.
    - name: cancel-ringout-call
      description: Cancel RingOut Call
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: platform-ringout.deleteringoutcall
      with:
        ringoutId: tools.ringoutId
      outputParameters:
      - type: object
        mapping: $.