Webex Cloud Calling — Location Call Settings: Voicemail

naftiko: 1.0.0-alpha2
info:
  label: 'Webex Cloud Calling — Location Call Settings:  Voicemail'
  description: 'Webex Cloud Calling — Location Call Settings:  Voicemail. 13 operations. Lead operation: Get VoicePortal.
    Self-contained Naftiko capability covering one Webex business surface.'
  tags:
  - Webex
  - 'Location Call Settings:  Voicemail'
  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-location-call-settings-voicemail
    baseUri: ''
    description: 'Webex Cloud Calling — Location Call Settings:  Voicemail business capability. Self-contained, no shared
      references.'
    resources:
    - name: telephony-config-locations-locationId-voicePortal
      path: /telephony/config/locations/{locationId}/voicePortal
      operations:
      - name: getvoiceportal
        method: GET
        description: Get VoicePortal
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Location to which the voice portal belongs.
          required: true
        - name: orgId
          in: query
          type: string
          description: Organization to which the voice portal belongs.
      - name: updatevoiceportal
        method: PUT
        description: Update VoicePortal
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Location to which the voice portal belongs.
          required: true
        - name: orgId
          in: query
          type: string
          description: Update voicemail rules for this organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-locations-locationId-voicePortal-availableNumbers
      path: /telephony/config/locations/{locationId}/voicePortal/availableNumbers
      operations:
      - name: getvoiceportalavailablephonenumbers
        method: GET
        description: Get VoicePortal Available Phone Numbers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Return the list of phone numbers for this location within the given organization. The maximum length
            is 36.
          required: true
        - name: orgId
          in: query
          type: string
          description: List numbers for this organization.
        - name: max
          in: query
          type: number
          description: Limit the number of phone numbers returned to this maximum count. The default is 2000.
        - name: start
          in: query
          type: number
          description: Start at the zero-based offset in the list of matching phone numbers. The default is 0.
        - name: phoneNumber
          in: query
          type: array
          description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array.
    - name: telephony-config-locations-locationId-voicePortal-passcodeRules
      path: /telephony/config/locations/{locationId}/voicePortal/passcodeRules
      operations:
      - name: getvoiceportalpasscoderule
        method: GET
        description: Get VoicePortal Passcode Rule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Retrieve voice portal passcode rules for this location.
          required: true
        - name: orgId
          in: query
          type: string
          description: Retrieve voice portal passcode rules for this organization.
    - name: telephony-config-locations-locationId-voicemail
      path: /telephony/config/locations/{locationId}/voicemail
      operations:
      - name: getlocationvoicemail
        method: GET
        description: Get Location Voicemail
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Retrieve voicemail settings for this location.
          required: true
        - name: orgId
          in: query
          type: string
          description: Retrieve voicemail settings for this organization.
      - name: updatelocationvoicemail
        method: PUT
        description: Update Location Voicemail
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Update voicemail settings for this location.
          required: true
        - name: orgId
          in: query
          type: string
          description: Update voicemail settings for this organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-locations-locationId-voicemailGroups
      path: /telephony/config/locations/{locationId}/voicemailGroups
      operations:
      - name: createanewvoicemailgroupforalocation
        method: POST
        description: Create a new Voicemail Group for a Location
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Create a new voice mail group for this location.
          required: true
        - name: orgId
          in: query
          type: string
          description: Create a new voice mail group for this organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-locations-locationId-voicemailGroups-availableNumbers
      path: /telephony/config/locations/{locationId}/voicemailGroups/availableNumbers
      operations:
      - name: getvoicemailgroupavailablephonenumbers
        method: GET
        description: Get Voicemail Group Available Phone Numbers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Return the list of phone numbers for this location within the given organization. The maximum length
            is 36.
          required: true
        - name: orgId
          in: query
          type: string
          description: List numbers for this organization.
        - name: max
          in: query
          type: number
          description: Limit the number of phone numbers returned to this maximum count. The default is 2000.
        - name: start
          in: query
          type: number
          description: Start at the zero-based offset in the list of matching phone numbers. The default is 0.
        - name: phoneNumber
          in: query
          type: array
          description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array.
    - name: telephony-config-locations-locationId-voicemailGroups-faxMessage-availableNumber
      path: /telephony/config/locations/{locationId}/voicemailGroups/faxMessage/availableNumbers
      operations:
      - name: getvoicemailgroupfaxmessageavailablephonenumbers
        method: GET
        description: Get Voicemail Group Fax Message Available Phone Numbers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Return the list of phone numbers for this location within the given organization. The maximum length
            is 36.
          required: true
        - name: orgId
          in: query
          type: string
          description: List numbers for this organization.
        - name: max
          in: query
          type: number
          description: Limit the number of phone numbers returned to this maximum count. The default is 2000.
        - name: start
          in: query
          type: number
          description: Start at the zero-based offset in the list of matching phone numbers. The default is 0.
        - name: phoneNumber
          in: query
          type: array
          description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array.
    - name: telephony-config-locations-locationId-voicemailGroups-voicemailGroupId
      path: /telephony/config/locations/{locationId}/voicemailGroups/{voicemailGroupId}
      operations:
      - name: getlocationvoicemailgroup
        method: GET
        description: Get Location Voicemail Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Retrieve voicemail group details for this location.
          required: true
        - name: voicemailGroupId
          in: path
          type: string
          description: Retrieve voicemail group details for this voicemail group ID.
          required: true
        - name: orgId
          in: query
          type: string
          description: Retrieve voicemail group details for a customer location.
      - name: modifylocationvoicemailgroup
        method: PUT
        description: Modify Location Voicemail Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Modifies the voicemail group details for this location.
          required: true
        - name: voicemailGroupId
          in: path
          type: string
          description: Modifies the voicemail group details for this voicemail group ID.
          required: true
        - name: orgId
          in: query
          type: string
          description: Modifies the voicemail group details for a customer location.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deleteavoicemailgroupforalocation
        method: DELETE
        description: Delete a Voicemail Group for a Location
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Location from which to delete a voicemail group.
          required: true
        - name: voicemailGroupId
          in: path
          type: string
          description: Delete the voicemail group with the matching ID.
          required: true
        - name: orgId
          in: query
          type: string
          description: Delete the voicemail group from this organization.
    - name: telephony-config-voicemailGroups
      path: /telephony/config/voicemailGroups
      operations:
      - name: listvoicemailgroup
        method: GET
        description: List VoicemailGroup
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: Organization to which the voicemail group belongs.
        - name: locationId
          in: query
          type: string
          description: Location to which the voicemail group belongs.
        - name: name
          in: query
          type: string
          description: Search (Contains) based on voicemail group name
        - name: phoneNumber
          in: query
          type: string
          description: Search (Contains) based on number or extension
        - name: max
          in: query
          type: number
          description: Limit the maximum number of events in the response. The maximum value is `200`.
        - name: start
          in: query
          type: number
          description: Offset from the first result that you want to fetch.
    authentication:
      type: bearer
      token: '{{env.WEBEX_API_KEY}}'
  exposes:
  - type: rest
    namespace: cloud-calling-location-call-settings-voicemail-rest
    port: 8080
    description: 'REST adapter for Webex Cloud Calling — Location Call Settings:  Voicemail. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.'
    resources:
    - path: /v1/telephony/config/locations/{locationid}/voiceportal
      name: telephony-config-locations-locationid-voiceportal
      description: REST surface for telephony-config-locations-locationId-voicePortal.
      operations:
      - method: GET
        name: getvoiceportal
        description: Get VoicePortal
        call: cloud-calling-location-call-settings-voicemail.getvoiceportal
        with:
          locationId: rest.locationId
          orgId: rest.orgId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatevoiceportal
        description: Update VoicePortal
        call: cloud-calling-location-call-settings-voicemail.updatevoiceportal
        with:
          locationId: rest.locationId
          orgId: rest.orgId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/telephony/config/locations/{locationid}/voiceportal/availablenumbers
      name: telephony-config-locations-locationid-voiceportal-availablenumbers
      description: REST surface for telephony-config-locations-locationId-voicePortal-availableNumbers.
      operations:
      - method: GET
        name: getvoiceportalavailablephonenumbers
        description: Get VoicePortal Available Phone Numbers
        call: cloud-calling-location-call-settings-voicemail.getvoiceportalavailablephonenumbers
        with:
          locationId: rest.locationId
          orgId: rest.orgId
          max: rest.max
          start: rest.start
          phoneNumber: rest.phoneNumber
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/telephony/config/locations/{locationid}/voiceportal/passcoderules
      name: telephony-config-locations-locationid-voiceportal-passcoderules
      description: REST surface for telephony-config-locations-locationId-voicePortal-passcodeRules.
      operations:
      - method: GET
        name: getvoiceportalpasscoderule
        description: Get VoicePortal Passcode Rule
        call: cloud-calling-location-call-settings-voicemail.getvoiceportalpasscoderule
        with:
          locationId: rest.locationId
          orgId: rest.orgId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/telephony/config/locations/{locationid}/voicemail
      name: telephony-config-locations-locationid-voicemail
      description: REST surface for telephony-config-locations-locationId-voicemail.
      operations:
      - method: GET
        name: getlocationvoicemail
        description: Get Location Voicemail
        call: cloud-calling-location-call-settings-voicemail.getlocationvoicemail
        with:
          locationId: rest.locationId
          orgId: rest.orgId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatelocationvoicemail
        description: Update Location Voicemail
        call: cloud-calling-location-call-settings-voicemail.updatelocationvoicemail
        with:
          locationId: rest.locationId
          orgId: rest.orgId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/telephony/config/locations/{locationid}/voicemailgroups
      name: telephony-config-locations-locationid-voicemailgroups
      description: REST surface for telephony-config-locations-locationId-voicemailGroups.
      operations:
      - method: POST
        name: createanewvoicemailgroupforalocation
        description: Create a new Voicemail Group for a Location
        call: cloud-calling-location-call-settings-voicemail.createanewvoicemailgroupforalocation
        with:
          locationId: rest.locationId
          orgId: rest.orgId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/telephony/config/locations/{locationid}/voicemailgroups/availablenumbers
      name: telephony-config-locations-locationid-voicemailgroups-availablenumbers
      description: REST surface for telephony-config-locations-locationId-voicemailGroups-availableNumbers.
      operations:
      - method: GET
        name: getvoicemailgroupavailablephonenumbers
        description: Get Voicemail Group Available Phone Numbers
        call: cloud-calling-location-call-settings-voicemail.getvoicemailgroupavailablephonenumbers
        with:
          locationId: rest.locationId
          orgId: rest.orgId
          max: rest.max
          start: rest.start
          phoneNumber: rest.phoneNumber
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/telephony/config/locations/{locationid}/voicemailgroups/faxmessage/availablenumbers
      name: telephony-config-locations-locationid-voicemailgroups-faxmessage-availablenumber
      description: REST surface for telephony-config-locations-locationId-voicemailGroups-faxMessage-availableNumber.
      operations:
      - method: GET
        name: getvoicemailgroupfaxmessageavailablephonenumbers
        description: Get Voicemail Group Fax Message Available Phone Numbers
        call: cloud-calling-location-call-settings-voicemail.getvoicemailgroupfaxmessageavailablephonenumbers
        with:
          locationId: rest.locationId
          orgId: rest.orgId
          max: rest.max
          start: rest.start
          phoneNumber: rest.phoneNumber
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/telephony/config/locations/{locationid}/voicemailgroups/{voicemailgroupid}
      name: telephony-config-locations-locationid-voicemailgroups-voicemailgroupid
      description: REST surface for telephony-config-locations-locationId-voicemailGroups-voicemailGroupId.
      operations:
      - method: GET
        name: getlocationvoicemailgroup
        description: Get Location Voicemail Group
        call: cloud-calling-location-call-settings-voicemail.getlocationvoicemailgroup
        with:
          locationId: rest.locationId
          voicemailGroupId: rest.voicemailGroupId
          orgId: rest.orgId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: modifylocationvoicemailgroup
        description: Modify Location Voicemail Group
        call: cloud-calling-location-call-settings-voicemail.modifylocationvoicemailgroup
        with:
          locationId: rest.locationId
          voicemailGroupId: rest.voicemailGroupId
          orgId: rest.orgId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteavoicemailgroupforalocation
        description: Delete a Voicemail Group for a Location
        call: cloud-calling-location-call-settings-voicemail.deleteavoicemailgroupforalocation
        with:
          locationId: rest.locationId
          voicemailGroupId: rest.voicemailGroupId
          orgId: rest.orgId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/telephony/config/voicemailgroups
      name: telephony-config-voicemailgroups
      description: REST surface for telephony-config-voicemailGroups.
      operations:
      - method: GET
        name: listvoicemailgroup
        description: List VoicemailGroup
        call: cloud-calling-location-call-settings-voicemail.listvoicemailgroup
        with:
          orgId: rest.orgId
          locationId: rest.locationId
          name: rest.name
          phoneNumber: rest.phoneNumber
          max: rest.max
          start: rest.start
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: cloud-calling-location-call-settings-voicemail-mcp
    port: 9090
    transport: http
    description: 'MCP adapter for Webex Cloud Calling — Location Call Settings:  Voicemail. One tool per consumed operation,
      routed inline through this capability''s consumes block.'
    tools:
    - name: get-voiceportal
      description: Get VoicePortal
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-calling-location-call-settings-voicemail.getvoiceportal
      with:
        locationId: tools.locationId
        orgId: tools.orgId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-voiceportal
      description: Update VoicePortal
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: cloud-calling-location-call-settings-voicemail.updatevoiceportal
      with:
        locationId: tools.locationId
        orgId: tools.orgId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-voiceportal-available-phone-numbers
      description: Get VoicePortal Available Phone Numbers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-calling-location-call-settings-voicemail.getvoiceportalavailablephonenumbers
      with:
        locationId: tools.locationId
        orgId: tools.orgId
        max: tools.max
        start: tools.start
        phoneNumber: tools.phoneNumber
      outputParameters:
      - type: object
        mapping: $.
    - name: get-voiceportal-passcode-rule
      description: Get VoicePortal Passcode Rule
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-calling-location-call-settings-voicemail.getvoiceportalpasscoderule
      with:
        locationId: tools.locationId
        orgId: tools.orgId
      outputParameters:
      - type: object
        mapping: $.
    - name: get-location-voicemail
      description: Get Location Voicemail
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-calling-location-call-settings-voicemail.getlocationvoicemail
      with:
        locationId: tools.locationId
        orgId: tools.orgId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-location-voicemail
      description: Update Location Voicemail
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: cloud-calling-location-call-settings-voicemail.updatelocationvoicemail
      with:
        locationId: tools.locationId
        orgId: tools.orgId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: create-new-voicemail-group-location
      description: Create a new Voicemail Group for a Location
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: cloud-calling-location-call-settings-voicemail.createanewvoicemailgroupforalocation
      with:
        locationId: tools.locationId
        orgId: tools.orgId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-voicemail-group-available-phone
      description: Get Voicemail Group Available Phone Numbers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-calling-location-call-settings-voicemail.getvoicemailgroupavailablephonenumbers
      with:
        locationId: tools.locationId
        orgId: tools.orgId
        max: tools.max
        start: tools.start
        phoneNumber: tools.phoneNumber
      outputParameters:
      - type: object
        mapping: $.
    - name: get-voicemail-group-fax-message
      description: Get Voicemail Group Fax Message Available Phone Numbers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-calling-location-call-settings-voicemail.getvoicemailgroupfaxmessageavailablephonenumbers
      with:
        locationId: tools.locationId
        orgId: tools.orgId
        max: tools.max
        start: tools.start
        phoneNumber: tools.phoneNumber
      outputParameters:
      - type: object
        mapping: $.
    - name: get-location-voicemail-group
      description: Get Location Voicemail Group
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-calling-location-call-settings-voicemail.getlocationvoicemailgroup
      with:
        locationId: tools.locationId
        voicemailGroupId: tools.voicemailGroupId
        orgId: tools.orgId
      outputParameters:
      - type: object
        mapping: $.
    - name: modify-location-voicemail-group
      description: Modify Location Voicemail Group
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: cloud-calling-location-call-settings-voicemail.modifylocationvoicemailgroup
      with:
        locationId: tools.locationId
        voicemailGroupId: tools.voicemailGroupId
        orgId: tools.orgId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-voicemail-group-location
      description: Delete a Voicemail Group for a Location
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: cloud-calling-location-call-settings-voicemail.deleteavoicemailgroupforalocation
      with:
        locationId: tools.locationId
        voicemailGroupId: tools.voicemailGroupId
        orgId: tools.orgId
      outputParameters:
      - type: object
        mapping: $.
    - name: list-voicemailgroup
      description: List VoicemailGroup
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-calling-location-call-settings-voicemail.listvoicemailgroup
      with:
        orgId: tools.orgId
        locationId: tools.locationId
        name: tools.name
        phoneNumber: tools.phoneNumber
        max: tools.max
        start: tools.start
      outputParameters:
      - type: object
        mapping: $.