Sinch Numbers API — Active Numbers

naftiko: 1.0.0-alpha2
info:
  label: Sinch Numbers API — Active Numbers
  description: 'Sinch Numbers API — Active Numbers. 4 operations. Lead operation: List Active Numbers. Self-contained Naftiko
    capability covering one Sinch business surface.'
  tags:
  - Sinch
  - Active Numbers
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SINCH_API_KEY: SINCH_API_KEY
capability:
  consumes:
  - type: http
    namespace: numbers-active-numbers
    baseUri: https://numbers.api.sinch.com
    description: Sinch Numbers API — Active Numbers business capability. Self-contained, no shared references.
    resources:
    - name: v1-projects-project_id-activeNumbers
      path: /v1/projects/{project_id}/activeNumbers
      operations:
      - name: listactivenumbers
        method: GET
        description: List Active Numbers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: regionCode
          in: query
          type: string
          description: The ISO 3166-1 alpha-2 country code
          required: true
        - name: type
          in: query
          type: string
          description: The number type
          required: true
        - name: numberPattern.pattern
          in: query
          type: string
          description: Pattern to search for
        - name: capabilities
          in: query
          type: array
          description: Filter by capabilities
        - name: pageSize
          in: query
          type: integer
          description: Number of results per page
        - name: pageToken
          in: query
          type: string
          description: Pagination token for the next page
    - name: v1-projects-project_id-activeNumbers-phone_number
      path: /v1/projects/{project_id}/activeNumbers/{phone_number}
      operations:
      - name: getactivenumber
        method: GET
        description: Get an Active Number
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateactivenumber
        method: PATCH
        description: Update an Active Number
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-projects-project_id-activeNumbers-phone_number}:release
      path: /v1/projects/{project_id}/activeNumbers/{phone_number}:release
      operations:
      - name: releasenumber
        method: POST
        description: Release an Active Number
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.SINCH_API_KEY}}'
  exposes:
  - type: rest
    namespace: numbers-active-numbers-rest
    port: 8080
    description: REST adapter for Sinch Numbers API — Active Numbers. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/projects/{project-id}/activenumbers
      name: v1-projects-project-id-activenumbers
      description: REST surface for v1-projects-project_id-activeNumbers.
      operations:
      - method: GET
        name: listactivenumbers
        description: List Active Numbers
        call: numbers-active-numbers.listactivenumbers
        with:
          regionCode: rest.regionCode
          type: rest.type
          numberPattern.pattern: rest.numberPattern.pattern
          capabilities: rest.capabilities
          pageSize: rest.pageSize
          pageToken: rest.pageToken
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/projects/{project-id}/activenumbers/{phone-number}
      name: v1-projects-project-id-activenumbers-phone-number
      description: REST surface for v1-projects-project_id-activeNumbers-phone_number.
      operations:
      - method: GET
        name: getactivenumber
        description: Get an Active Number
        call: numbers-active-numbers.getactivenumber
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateactivenumber
        description: Update an Active Number
        call: numbers-active-numbers.updateactivenumber
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/projects/{project-id}/activenumbers/phone-number-release
      name: v1-projects-project-id-activenumbers-phone-number-release
      description: REST surface for v1-projects-project_id-activeNumbers-phone_number}:release.
      operations:
      - method: POST
        name: releasenumber
        description: Release an Active Number
        call: numbers-active-numbers.releasenumber
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: numbers-active-numbers-mcp
    port: 9090
    transport: http
    description: MCP adapter for Sinch Numbers API — Active Numbers. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-active-numbers
      description: List Active Numbers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: numbers-active-numbers.listactivenumbers
      with:
        regionCode: tools.regionCode
        type: tools.type
        numberPattern.pattern: tools.numberPattern.pattern
        capabilities: tools.capabilities
        pageSize: tools.pageSize
        pageToken: tools.pageToken
      outputParameters:
      - type: object
        mapping: $.
    - name: get-active-number
      description: Get an Active Number
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: numbers-active-numbers.getactivenumber
      outputParameters:
      - type: object
        mapping: $.
    - name: update-active-number
      description: Update an Active Number
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: numbers-active-numbers.updateactivenumber
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: release-active-number
      description: Release an Active Number
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: numbers-active-numbers.releasenumber
      outputParameters:
      - type: object
        mapping: $.