Webex Contact Center — Dial Plan

naftiko: 1.0.0-alpha2
info:
  label: Webex Contact Center — Dial Plan
  description: 'Webex Contact Center — Dial Plan. 9 operations. Lead operation: List Dial Plan(s). Self-contained Naftiko
    capability covering one Webex business surface.'
  tags:
  - Webex
  - Dial Plan
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WEBEX_API_KEY: WEBEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: contact-center-dial-plan
    baseUri: ''
    description: Webex Contact Center — Dial Plan business capability. Self-contained, no shared references.
    resources:
    - name: organization-orgid-dial-plan
      path: /organization/{orgid}/dial-plan
      operations:
      - name: getallconfig8
        method: GET
        description: List Dial Plan(s)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgid
          in: path
          type: string
          description: Organization ID to be used for this operation. The specified security token must have permission to
            interact with the organization.
          required: true
        - name: filter
          in: query
          type: string
          description: 'Specify a filter based on which the results will be fetched. Supported filterable fields:  id. '
        - name: attributes
          in: query
          type: string
          description: Specify the attributes to be returned.Default all attributes are returned along with specified columns.
            All Attributes are supported
        - name: page
          in: query
          type: integer
          description: Defines the number of displayed page. The page number starts from 0.
        - name: pageSize
          in: query
          type: integer
          description: Defines the number of items to be displayed on a page. If the number specified is more than allowed
            max page size, the API will automatically adjust the page si
      - name: createconfig15
        method: POST
        description: Create a new Dial Plan
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgid
          in: path
          type: string
          description: Organization ID to be used for this operation. The specified security token must have permission to
            interact with the organization.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: organization-orgid-dial-plan-bulk
      path: /organization/{orgid}/dial-plan/bulk
      operations:
      - name: saveallconfig13
        method: POST
        description: Bulk save Dial Plan(s)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgid
          in: path
          type: string
          description: Organization ID to be used for this operation. The specified security token must have permission to
            interact with the organization.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: organization-orgid-dial-plan-bulk-export
      path: /organization/{orgid}/dial-plan/bulk-export
      operations:
      - name: bulkexport13
        method: GET
        description: Bulk export Dial Plan(s)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgid
          in: path
          type: string
          description: Organization ID to be used for this operation. The specified security token must have permission to
            interact with the organization.
          required: true
        - name: page
          in: query
          type: integer
          description: Defines the number of displayed page. The page number starts from 0.
        - name: pageSize
          in: query
          type: integer
          description: Defines the number of items to be displayed on a page. If the number specified is more than allowed
            max page size, the API will automatically adjust the page si
    - name: organization-orgid-dial-plan-id
      path: /organization/{orgid}/dial-plan/{id}
      operations:
      - name: getconfig16
        method: GET
        description: Get specific Dial Plan by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgid
          in: path
          type: string
          description: Organization ID to be used for this operation. The specified security token must have permission to
            interact with the organization.
          required: true
        - name: id
          in: path
          type: string
          description: Resource ID of the Dial Plan.
          required: true
      - name: updateconfig16
        method: PUT
        description: Update specific Dial Plan by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgid
          in: path
          type: string
          description: Organization ID to be used for this operation. The specified security token must have permission to
            interact with the organization.
          required: true
        - name: id
          in: path
          type: string
          description: Resource ID of the Dial Plan.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteconfig15
        method: DELETE
        description: Delete specific Dial Plan by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgid
          in: path
          type: string
          description: Organization ID to be used for this operation. The specified security token must have permission to
            interact with the organization.
          required: true
        - name: id
          in: path
          type: string
          description: Resource ID of the Dial Plan.
          required: true
    - name: organization-orgid-dial-plan-id-incoming-references
      path: /organization/{orgid}/dial-plan/{id}/incoming-references
      operations:
      - name: getincomingreferences12
        method: GET
        description: List references for a specific Dial Plan
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgid
          in: path
          type: string
          description: Organization ID to be used for this operation. The specified security token must have permission to
            interact with the organization.
          required: true
        - name: id
          in: path
          type: string
          description: ID of this contact center resource.
          required: true
        - name: type
          in: query
          type: string
          description: Entity type of the other entity that has a reference to this specific entity.
        - name: page
          in: query
          type: integer
          description: Defines the number of displayed page. The page number starts from 0.
        - name: pageSize
          in: query
          type: integer
          description: Defines the number of items to be displayed on a page. If the number specified is more than allowed
            max page size, the API will automatically adjust the page si
    - name: organization-orgid-v2-dial-plan
      path: /organization/{orgid}/v2/dial-plan
      operations:
      - name: getallconfigwithmetadata16
        method: GET
        description: List Dial Plan(s)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgid
          in: path
          type: string
          description: Organization ID to be used for this operation. The specified security token must have permission to
            interact with the organization.
          required: true
        - name: filter
          in: query
          type: string
          description: 'Specify a filter based on which the results will be fetched. All the fields are supported except:
            organizationId, createdTime, lastUpdatedTime '
        - name: attributes
          in: query
          type: string
          description: Specify the attributes to be returned.Default all attributes are returned along with specified columns.
            All Attributes are supported
        - name: search
          in: query
          type: string
          description: Filter data based on the search keyword.Supported search columns(name)
        - name: page
          in: query
          type: integer
          description: Defines the number of displayed page. The page number starts from 0.
        - name: pageSize
          in: query
          type: integer
          description: Defines the number of items to be displayed on a page. If the number specified is more than allowed
            max page size, the API will automatically adjust the page si
    authentication:
      type: bearer
      token: '{{env.WEBEX_API_KEY}}'
  exposes:
  - type: rest
    namespace: contact-center-dial-plan-rest
    port: 8080
    description: REST adapter for Webex Contact Center — Dial Plan. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/organization/{orgid}/dial-plan
      name: organization-orgid-dial-plan
      description: REST surface for organization-orgid-dial-plan.
      operations:
      - method: GET
        name: getallconfig8
        description: List Dial Plan(s)
        call: contact-center-dial-plan.getallconfig8
        with:
          orgid: rest.orgid
          filter: rest.filter
          attributes: rest.attributes
          page: rest.page
          pageSize: rest.pageSize
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createconfig15
        description: Create a new Dial Plan
        call: contact-center-dial-plan.createconfig15
        with:
          orgid: rest.orgid
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organization/{orgid}/dial-plan/bulk
      name: organization-orgid-dial-plan-bulk
      description: REST surface for organization-orgid-dial-plan-bulk.
      operations:
      - method: POST
        name: saveallconfig13
        description: Bulk save Dial Plan(s)
        call: contact-center-dial-plan.saveallconfig13
        with:
          orgid: rest.orgid
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organization/{orgid}/dial-plan/bulk-export
      name: organization-orgid-dial-plan-bulk-export
      description: REST surface for organization-orgid-dial-plan-bulk-export.
      operations:
      - method: GET
        name: bulkexport13
        description: Bulk export Dial Plan(s)
        call: contact-center-dial-plan.bulkexport13
        with:
          orgid: rest.orgid
          page: rest.page
          pageSize: rest.pageSize
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organization/{orgid}/dial-plan/{id}
      name: organization-orgid-dial-plan-id
      description: REST surface for organization-orgid-dial-plan-id.
      operations:
      - method: GET
        name: getconfig16
        description: Get specific Dial Plan by ID
        call: contact-center-dial-plan.getconfig16
        with:
          orgid: rest.orgid
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateconfig16
        description: Update specific Dial Plan by ID
        call: contact-center-dial-plan.updateconfig16
        with:
          orgid: rest.orgid
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteconfig15
        description: Delete specific Dial Plan by ID
        call: contact-center-dial-plan.deleteconfig15
        with:
          orgid: rest.orgid
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organization/{orgid}/dial-plan/{id}/incoming-references
      name: organization-orgid-dial-plan-id-incoming-references
      description: REST surface for organization-orgid-dial-plan-id-incoming-references.
      operations:
      - method: GET
        name: getincomingreferences12
        description: List references for a specific Dial Plan
        call: contact-center-dial-plan.getincomingreferences12
        with:
          orgid: rest.orgid
          id: rest.id
          type: rest.type
          page: rest.page
          pageSize: rest.pageSize
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organization/{orgid}/v2/dial-plan
      name: organization-orgid-v2-dial-plan
      description: REST surface for organization-orgid-v2-dial-plan.
      operations:
      - method: GET
        name: getallconfigwithmetadata16
        description: List Dial Plan(s)
        call: contact-center-dial-plan.getallconfigwithmetadata16
        with:
          orgid: rest.orgid
          filter: rest.filter
          attributes: rest.attributes
          search: rest.search
          page: rest.page
          pageSize: rest.pageSize
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: contact-center-dial-plan-mcp
    port: 9090
    transport: http
    description: MCP adapter for Webex Contact Center — Dial Plan. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-dial-plan-s
      description: List Dial Plan(s)
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: contact-center-dial-plan.getallconfig8
      with:
        orgid: tools.orgid
        filter: tools.filter
        attributes: tools.attributes
        page: tools.page
        pageSize: tools.pageSize
      outputParameters:
      - type: object
        mapping: $.
    - name: create-new-dial-plan
      description: Create a new Dial Plan
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: contact-center-dial-plan.createconfig15
      with:
        orgid: tools.orgid
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: bulk-save-dial-plan-s
      description: Bulk save Dial Plan(s)
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: contact-center-dial-plan.saveallconfig13
      with:
        orgid: tools.orgid
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: bulk-export-dial-plan-s
      description: Bulk export Dial Plan(s)
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: contact-center-dial-plan.bulkexport13
      with:
        orgid: tools.orgid
        page: tools.page
        pageSize: tools.pageSize
      outputParameters:
      - type: object
        mapping: $.
    - name: get-specific-dial-plan-id
      description: Get specific Dial Plan by ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: contact-center-dial-plan.getconfig16
      with:
        orgid: tools.orgid
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-specific-dial-plan-id
      description: Update specific Dial Plan by ID
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: contact-center-dial-plan.updateconfig16
      with:
        orgid: tools.orgid
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-specific-dial-plan-id
      description: Delete specific Dial Plan by ID
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: contact-center-dial-plan.deleteconfig15
      with:
        orgid: tools.orgid
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: list-references-specific-dial-plan
      description: List references for a specific Dial Plan
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: contact-center-dial-plan.getincomingreferences12
      with:
        orgid: tools.orgid
        id: tools.id
        type: tools.type
        page: tools.page
        pageSize: tools.pageSize
      outputParameters:
      - type: object
        mapping: $.
    - name: list-dial-plan-s-2
      description: List Dial Plan(s)
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: contact-center-dial-plan.getallconfigwithmetadata16
      with:
        orgid: tools.orgid
        filter: tools.filter
        attributes: tools.attributes
        search: tools.search
        page: tools.page
        pageSize: tools.pageSize
      outputParameters:
      - type: object
        mapping: $.