Telnyx API — Hosted Numbers

naftiko: 1.0.0-alpha2
info:
  label: Telnyx API — Hosted Numbers
  description: 'Telnyx API — Hosted Numbers. 9 operations. Lead operation: List messaging hosted number orders. Self-contained
    Naftiko capability covering one Telnyx business surface.'
  tags:
  - Telnyx
  - Hosted Numbers
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TELNYX_API_KEY: TELNYX_API_KEY
capability:
  consumes:
  - type: http
    namespace: telnyx-hosted-numbers
    baseUri: https://api.telnyx.com/v2
    description: Telnyx API — Hosted Numbers business capability. Self-contained, no shared references.
    resources:
    - name: messaging_hosted_number_orders
      path: /messaging_hosted_number_orders
      operations:
      - name: listmessaginghostednumberorders
        method: GET
        description: List messaging hosted number orders
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createmessaginghostednumberorder
        method: POST
        description: Create a messaging hosted number order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: messaging_hosted_number_orders-eligibility_numbers_check
      path: /messaging_hosted_number_orders/eligibility_numbers_check
      operations:
      - name: checkeligibilitynumbers
        method: POST
        description: Check hosted messaging eligibility
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: messaging_hosted_number_orders-id
      path: /messaging_hosted_number_orders/{id}
      operations:
      - name: deletemessaginghostednumberorder
        method: DELETE
        description: Delete a messaging hosted number order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Identifies the messaging hosted number order to delete.
          required: true
      - name: getmessaginghostednumberorder
        method: GET
        description: Retrieve a messaging hosted number order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Identifies the type of resource.
          required: true
    - name: messaging_hosted_number_orders-id-actions-file_upload
      path: /messaging_hosted_number_orders/{id}/actions/file_upload
      operations:
      - name: uploadmessaginghostednumberorderfile
        method: POST
        description: Upload hosted number document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Identifies the type of resource.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: messaging_hosted_number_orders-id-validation_codes
      path: /messaging_hosted_number_orders/{id}/validation_codes
      operations:
      - name: validateverificationcodesformessaginghostednumberorder
        method: POST
        description: Validate hosted number codes
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Order ID related to the validation codes.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: messaging_hosted_number_orders-id-verification_codes
      path: /messaging_hosted_number_orders/{id}/verification_codes
      operations:
      - name: createverificationcodesformessaginghostednumberorder
        method: POST
        description: Create hosted number verification codes
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Order ID to have a verification code created.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: messaging_hosted_numbers-id
      path: /messaging_hosted_numbers/{id}
      operations:
      - name: deletemessaginghostednumber
        method: DELETE
        description: Delete a messaging hosted number
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Identifies the type of resource.
          required: true
    authentication:
      type: bearer
      token: '{{env.TELNYX_API_KEY}}'
  exposes:
  - type: rest
    namespace: telnyx-hosted-numbers-rest
    port: 8080
    description: REST adapter for Telnyx API — Hosted Numbers. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/messaging-hosted-number-orders
      name: messaging-hosted-number-orders
      description: REST surface for messaging_hosted_number_orders.
      operations:
      - method: GET
        name: listmessaginghostednumberorders
        description: List messaging hosted number orders
        call: telnyx-hosted-numbers.listmessaginghostednumberorders
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createmessaginghostednumberorder
        description: Create a messaging hosted number order
        call: telnyx-hosted-numbers.createmessaginghostednumberorder
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/messaging-hosted-number-orders/eligibility-numbers-check
      name: messaging-hosted-number-orders-eligibility-numbers-check
      description: REST surface for messaging_hosted_number_orders-eligibility_numbers_check.
      operations:
      - method: POST
        name: checkeligibilitynumbers
        description: Check hosted messaging eligibility
        call: telnyx-hosted-numbers.checkeligibilitynumbers
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/messaging-hosted-number-orders/{id}
      name: messaging-hosted-number-orders-id
      description: REST surface for messaging_hosted_number_orders-id.
      operations:
      - method: DELETE
        name: deletemessaginghostednumberorder
        description: Delete a messaging hosted number order
        call: telnyx-hosted-numbers.deletemessaginghostednumberorder
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getmessaginghostednumberorder
        description: Retrieve a messaging hosted number order
        call: telnyx-hosted-numbers.getmessaginghostednumberorder
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/messaging-hosted-number-orders/{id}/actions/file-upload
      name: messaging-hosted-number-orders-id-actions-file-upload
      description: REST surface for messaging_hosted_number_orders-id-actions-file_upload.
      operations:
      - method: POST
        name: uploadmessaginghostednumberorderfile
        description: Upload hosted number document
        call: telnyx-hosted-numbers.uploadmessaginghostednumberorderfile
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/messaging-hosted-number-orders/{id}/validation-codes
      name: messaging-hosted-number-orders-id-validation-codes
      description: REST surface for messaging_hosted_number_orders-id-validation_codes.
      operations:
      - method: POST
        name: validateverificationcodesformessaginghostednumberorder
        description: Validate hosted number codes
        call: telnyx-hosted-numbers.validateverificationcodesformessaginghostednumberorder
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/messaging-hosted-number-orders/{id}/verification-codes
      name: messaging-hosted-number-orders-id-verification-codes
      description: REST surface for messaging_hosted_number_orders-id-verification_codes.
      operations:
      - method: POST
        name: createverificationcodesformessaginghostednumberorder
        description: Create hosted number verification codes
        call: telnyx-hosted-numbers.createverificationcodesformessaginghostednumberorder
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/messaging-hosted-numbers/{id}
      name: messaging-hosted-numbers-id
      description: REST surface for messaging_hosted_numbers-id.
      operations:
      - method: DELETE
        name: deletemessaginghostednumber
        description: Delete a messaging hosted number
        call: telnyx-hosted-numbers.deletemessaginghostednumber
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: telnyx-hosted-numbers-mcp
    port: 9090
    transport: http
    description: MCP adapter for Telnyx API — Hosted Numbers. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-messaging-hosted-number-orders
      description: List messaging hosted number orders
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-hosted-numbers.listmessaginghostednumberorders
      outputParameters:
      - type: object
        mapping: $.
    - name: create-messaging-hosted-number-order
      description: Create a messaging hosted number order
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-hosted-numbers.createmessaginghostednumberorder
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: check-hosted-messaging-eligibility
      description: Check hosted messaging eligibility
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: telnyx-hosted-numbers.checkeligibilitynumbers
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-messaging-hosted-number-order
      description: Delete a messaging hosted number order
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: telnyx-hosted-numbers.deletemessaginghostednumberorder
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-messaging-hosted-number-order
      description: Retrieve a messaging hosted number order
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-hosted-numbers.getmessaginghostednumberorder
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: upload-hosted-number-document
      description: Upload hosted number document
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-hosted-numbers.uploadmessaginghostednumberorderfile
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: validate-hosted-number-codes
      description: Validate hosted number codes
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: telnyx-hosted-numbers.validateverificationcodesformessaginghostednumberorder
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: create-hosted-number-verification-codes
      description: Create hosted number verification codes
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-hosted-numbers.createverificationcodesformessaginghostednumberorder
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-messaging-hosted-number
      description: Delete a messaging hosted number
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: telnyx-hosted-numbers.deletemessaginghostednumber
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.