Webex Cloud Calling — Features: Customer Assist

naftiko: 1.0.0-alpha2
info:
  label: 'Webex Cloud Calling — Features: Customer Assist'
  description: 'Webex Cloud Calling — Features: Customer Assist. 12 operations. Lead operation: Read Wrap Up Reason Settings.
    Self-contained Naftiko capability covering one Webex business surface.'
  tags:
  - Webex
  - 'Features: Customer Assist'
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WEBEX_API_KEY: WEBEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: cloud-calling-features-customer-assist
    baseUri: ''
    description: 'Webex Cloud Calling — Features: Customer Assist business capability. Self-contained, no shared references.'
    resources:
    - name: telephony-config-cxEssentials-locations-locationId-queues-queueId-wrapup-setting
      path: /telephony/config/cxEssentials/locations/{locationId}/queues/{queueId}/wrapup/settings
      operations:
      - name: readwrapupreasonsettings
        method: GET
        description: Read Wrap Up Reason Settings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: The location ID.
          required: true
        - name: queueId
          in: path
          type: string
          description: The queue ID.
          required: true
      - name: updatewrapupreasonsettings
        method: PUT
        description: Update Wrap Up Reason Settings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: The location ID.
          required: true
        - name: queueId
          in: path
          type: string
          description: The queue ID.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-cxEssentials-wrapup-reasons
      path: /telephony/config/cxEssentials/wrapup/reasons
      operations:
      - name: listwrapupreasons
        method: GET
        description: List Wrap Up Reasons
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createwrapupreason
        method: POST
        description: Create Wrap Up Reason
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-cxEssentials-wrapup-reasons-actions-validateName-invoke
      path: /telephony/config/cxEssentials/wrapup/reasons/actions/validateName/invoke
      operations:
      - name: validatewrapupreason
        method: POST
        description: Validate Wrap Up Reason
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-cxEssentials-wrapup-reasons-wrapupReasonId
      path: /telephony/config/cxEssentials/wrapup/reasons/{wrapupReasonId}
      operations:
      - name: readwrapupreason
        method: GET
        description: Read Wrap Up Reason
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: wrapupReasonId
          in: path
          type: string
          description: Wrap-up reason ID.
          required: true
      - name: updatewrapupreason
        method: PUT
        description: Update Wrap Up Reason
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: wrapupReasonId
          in: path
          type: string
          description: Wrap-up reason ID.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deletewrapupreason
        method: DELETE
        description: Delete Wrap Up Reason
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: wrapupReasonId
          in: path
          type: string
          description: Wrap-up reason ID.
          required: true
    - name: telephony-config-cxEssentials-wrapup-reasons-wrapupReasonId-availableQueues
      path: /telephony/config/cxEssentials/wrapup/reasons/{wrapupReasonId}/availableQueues
      operations:
      - name: readavailablequeues
        method: GET
        description: Read Available Queues
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: wrapupReasonId
          in: path
          type: string
          description: Wrap-up reason ID.
          required: true
    - name: telephony-config-locations-locationId-cxEssentials-agents-availableAgents
      path: /telephony/config/locations/{locationId}/cxEssentials/agents/availableAgents
      operations:
      - name: listavailableagents
        method: GET
        description: List Available Agents
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Retrieve the list of avaiilable agents in this location.
          required: true
        - name: orgId
          in: query
          type: string
          description: The organization ID of the customer or partner's organization.
        - name: hasCxEssentials
          in: query
          type: boolean
          description: Returns only the list of available agents with Customer Assist license when `true`, otherwise returns
            the list of available agents with Customer Experience Basi
    - name: telephony-config-locations-locationId-queues-queueId-cxEssentials-screenPop
      path: /telephony/config/locations/{locationId}/queues/{queueId}/cxEssentials/screenPop
      operations:
      - name: readscreenpopconfiguration
        method: GET
        description: Read Screen Pop Configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: The location ID where the call queue resides.
          required: true
        - name: queueId
          in: path
          type: string
          description: The call queue ID for which screen pop configuration is modified.
          required: true
        - name: orgId
          in: query
          type: string
          description: The organization ID of the customer or partner's organization.
      - name: updatescreenpopconfiguration
        method: PUT
        description: Update Screen Pop Configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: The location ID where the call queue resides.
          required: true
        - name: queueId
          in: path
          type: string
          description: The call queue ID for which screen pop configuration is modified.
          required: true
        - name: orgId
          in: query
          type: string
          description: The organization ID of the customer or partner's organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: bearer
      token: '{{env.WEBEX_API_KEY}}'
  exposes:
  - type: rest
    namespace: cloud-calling-features-customer-assist-rest
    port: 8080
    description: 'REST adapter for Webex Cloud Calling — Features: Customer Assist. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.'
    resources:
    - path: /v1/telephony/config/cxessentials/locations/{locationid}/queues/{queueid}/wrapup/settings
      name: telephony-config-cxessentials-locations-locationid-queues-queueid-wrapup-setting
      description: REST surface for telephony-config-cxEssentials-locations-locationId-queues-queueId-wrapup-setting.
      operations:
      - method: GET
        name: readwrapupreasonsettings
        description: Read Wrap Up Reason Settings
        call: cloud-calling-features-customer-assist.readwrapupreasonsettings
        with:
          locationId: rest.locationId
          queueId: rest.queueId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatewrapupreasonsettings
        description: Update Wrap Up Reason Settings
        call: cloud-calling-features-customer-assist.updatewrapupreasonsettings
        with:
          locationId: rest.locationId
          queueId: rest.queueId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/telephony/config/cxessentials/wrapup/reasons
      name: telephony-config-cxessentials-wrapup-reasons
      description: REST surface for telephony-config-cxEssentials-wrapup-reasons.
      operations:
      - method: GET
        name: listwrapupreasons
        description: List Wrap Up Reasons
        call: cloud-calling-features-customer-assist.listwrapupreasons
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createwrapupreason
        description: Create Wrap Up Reason
        call: cloud-calling-features-customer-assist.createwrapupreason
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/telephony/config/cxessentials/wrapup/reasons/actions/validatename/invoke
      name: telephony-config-cxessentials-wrapup-reasons-actions-validatename-invoke
      description: REST surface for telephony-config-cxEssentials-wrapup-reasons-actions-validateName-invoke.
      operations:
      - method: POST
        name: validatewrapupreason
        description: Validate Wrap Up Reason
        call: cloud-calling-features-customer-assist.validatewrapupreason
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/telephony/config/cxessentials/wrapup/reasons/{wrapupreasonid}
      name: telephony-config-cxessentials-wrapup-reasons-wrapupreasonid
      description: REST surface for telephony-config-cxEssentials-wrapup-reasons-wrapupReasonId.
      operations:
      - method: GET
        name: readwrapupreason
        description: Read Wrap Up Reason
        call: cloud-calling-features-customer-assist.readwrapupreason
        with:
          wrapupReasonId: rest.wrapupReasonId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatewrapupreason
        description: Update Wrap Up Reason
        call: cloud-calling-features-customer-assist.updatewrapupreason
        with:
          wrapupReasonId: rest.wrapupReasonId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletewrapupreason
        description: Delete Wrap Up Reason
        call: cloud-calling-features-customer-assist.deletewrapupreason
        with:
          wrapupReasonId: rest.wrapupReasonId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/telephony/config/cxessentials/wrapup/reasons/{wrapupreasonid}/availablequeues
      name: telephony-config-cxessentials-wrapup-reasons-wrapupreasonid-availablequeues
      description: REST surface for telephony-config-cxEssentials-wrapup-reasons-wrapupReasonId-availableQueues.
      operations:
      - method: GET
        name: readavailablequeues
        description: Read Available Queues
        call: cloud-calling-features-customer-assist.readavailablequeues
        with:
          wrapupReasonId: rest.wrapupReasonId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/telephony/config/locations/{locationid}/cxessentials/agents/availableagents
      name: telephony-config-locations-locationid-cxessentials-agents-availableagents
      description: REST surface for telephony-config-locations-locationId-cxEssentials-agents-availableAgents.
      operations:
      - method: GET
        name: listavailableagents
        description: List Available Agents
        call: cloud-calling-features-customer-assist.listavailableagents
        with:
          locationId: rest.locationId
          orgId: rest.orgId
          hasCxEssentials: rest.hasCxEssentials
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/telephony/config/locations/{locationid}/queues/{queueid}/cxessentials/screenpop
      name: telephony-config-locations-locationid-queues-queueid-cxessentials-screenpop
      description: REST surface for telephony-config-locations-locationId-queues-queueId-cxEssentials-screenPop.
      operations:
      - method: GET
        name: readscreenpopconfiguration
        description: Read Screen Pop Configuration
        call: cloud-calling-features-customer-assist.readscreenpopconfiguration
        with:
          locationId: rest.locationId
          queueId: rest.queueId
          orgId: rest.orgId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatescreenpopconfiguration
        description: Update Screen Pop Configuration
        call: cloud-calling-features-customer-assist.updatescreenpopconfiguration
        with:
          locationId: rest.locationId
          queueId: rest.queueId
          orgId: rest.orgId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: cloud-calling-features-customer-assist-mcp
    port: 9090
    transport: http
    description: 'MCP adapter for Webex Cloud Calling — Features: Customer Assist. One tool per consumed operation, routed
      inline through this capability''s consumes block.'
    tools:
    - name: read-wrap-up-reason-settings
      description: Read Wrap Up Reason Settings
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-calling-features-customer-assist.readwrapupreasonsettings
      with:
        locationId: tools.locationId
        queueId: tools.queueId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-wrap-up-reason-settings
      description: Update Wrap Up Reason Settings
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: cloud-calling-features-customer-assist.updatewrapupreasonsettings
      with:
        locationId: tools.locationId
        queueId: tools.queueId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-wrap-up-reasons
      description: List Wrap Up Reasons
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-calling-features-customer-assist.listwrapupreasons
      outputParameters:
      - type: object
        mapping: $.
    - name: create-wrap-up-reason
      description: Create Wrap Up Reason
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: cloud-calling-features-customer-assist.createwrapupreason
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: validate-wrap-up-reason
      description: Validate Wrap Up Reason
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: cloud-calling-features-customer-assist.validatewrapupreason
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: read-wrap-up-reason
      description: Read Wrap Up Reason
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-calling-features-customer-assist.readwrapupreason
      with:
        wrapupReasonId: tools.wrapupReasonId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-wrap-up-reason
      description: Update Wrap Up Reason
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: cloud-calling-features-customer-assist.updatewrapupreason
      with:
        wrapupReasonId: tools.wrapupReasonId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-wrap-up-reason
      description: Delete Wrap Up Reason
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: cloud-calling-features-customer-assist.deletewrapupreason
      with:
        wrapupReasonId: tools.wrapupReasonId
      outputParameters:
      - type: object
        mapping: $.
    - name: read-available-queues
      description: Read Available Queues
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-calling-features-customer-assist.readavailablequeues
      with:
        wrapupReasonId: tools.wrapupReasonId
      outputParameters:
      - type: object
        mapping: $.
    - name: list-available-agents
      description: List Available Agents
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-calling-features-customer-assist.listavailableagents
      with:
        locationId: tools.locationId
        orgId: tools.orgId
        hasCxEssentials: tools.hasCxEssentials
      outputParameters:
      - type: object
        mapping: $.
    - name: read-screen-pop-configuration
      description: Read Screen Pop Configuration
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-calling-features-customer-assist.readscreenpopconfiguration
      with:
        locationId: tools.locationId
        queueId: tools.queueId
        orgId: tools.orgId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-screen-pop-configuration
      description: Update Screen Pop Configuration
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: cloud-calling-features-customer-assist.updatescreenpopconfiguration
      with:
        locationId: tools.locationId
        queueId: tools.queueId
        orgId: tools.orgId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.