Telnyx API — Number Settings

naftiko: 1.0.0-alpha2
info:
  label: Telnyx API — Number Settings
  description: 'Telnyx API — Number Settings. 5 operations. Lead operation: Bulk update phone number profiles. Self-contained
    Naftiko capability covering one Telnyx business surface.'
  tags:
  - Telnyx
  - Number Settings
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TELNYX_API_KEY: TELNYX_API_KEY
capability:
  consumes:
  - type: http
    namespace: telnyx-number-settings
    baseUri: https://api.telnyx.com/v2
    description: Telnyx API — Number Settings business capability. Self-contained, no shared references.
    resources:
    - name: messaging_numbers_bulk_updates
      path: /messaging_numbers_bulk_updates
      operations:
      - name: bulkupdatemessagingsettingsonphonenumbers
        method: POST
        description: Bulk update phone number profiles
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: messaging_numbers_bulk_updates-order_id
      path: /messaging_numbers_bulk_updates/{order_id}
      operations:
      - name: getbulkupdatemessagingsettingsonphonenumbersstatus
        method: GET
        description: Retrieve bulk update status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: order_id
          in: path
          type: string
          description: Order ID to verify bulk update status.
          required: true
    - name: phone_numbers-messaging
      path: /phone_numbers/messaging
      operations:
      - name: listphonenumberswithmessagingsettings
        method: GET
        description: List phone numbers with messaging settings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filter[messaging_profile_id]
          in: query
          type: string
          description: Filter by messaging profile ID.
        - name: filter[phone_number]
          in: query
          type: string
          description: Filter by exact phone number (supports comma-separated list).
        - name: filter[phone_number][contains]
          in: query
          type: string
          description: Filter by phone number substring.
        - name: filter[type]
          in: query
          type: string
          description: Filter by phone number type.
        - name: sort[phone_number]
          in: query
          type: string
          description: Sort by phone number.
    - name: phone_numbers-id-messaging
      path: /phone_numbers/{id}/messaging
      operations:
      - name: getphonenumbermessagingsettings
        method: GET
        description: Retrieve a phone number with messaging settings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Identifies the type of resource.
          required: true
      - name: updatephonenumbermessagingsettings
        method: PATCH
        description: Update the messaging profile and/or messaging product of a phone number
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The phone number to update.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.TELNYX_API_KEY}}'
  exposes:
  - type: rest
    namespace: telnyx-number-settings-rest
    port: 8080
    description: REST adapter for Telnyx API — Number Settings. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/messaging-numbers-bulk-updates
      name: messaging-numbers-bulk-updates
      description: REST surface for messaging_numbers_bulk_updates.
      operations:
      - method: POST
        name: bulkupdatemessagingsettingsonphonenumbers
        description: Bulk update phone number profiles
        call: telnyx-number-settings.bulkupdatemessagingsettingsonphonenumbers
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/messaging-numbers-bulk-updates/{order-id}
      name: messaging-numbers-bulk-updates-order-id
      description: REST surface for messaging_numbers_bulk_updates-order_id.
      operations:
      - method: GET
        name: getbulkupdatemessagingsettingsonphonenumbersstatus
        description: Retrieve bulk update status
        call: telnyx-number-settings.getbulkupdatemessagingsettingsonphonenumbersstatus
        with:
          order_id: rest.order_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/phone-numbers/messaging
      name: phone-numbers-messaging
      description: REST surface for phone_numbers-messaging.
      operations:
      - method: GET
        name: listphonenumberswithmessagingsettings
        description: List phone numbers with messaging settings
        call: telnyx-number-settings.listphonenumberswithmessagingsettings
        with:
          filter[messaging_profile_id]: rest.filter[messaging_profile_id]
          filter[phone_number]: rest.filter[phone_number]
          filter[phone_number][contains]: rest.filter[phone_number][contains]
          filter[type]: rest.filter[type]
          sort[phone_number]: rest.sort[phone_number]
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/phone-numbers/{id}/messaging
      name: phone-numbers-id-messaging
      description: REST surface for phone_numbers-id-messaging.
      operations:
      - method: GET
        name: getphonenumbermessagingsettings
        description: Retrieve a phone number with messaging settings
        call: telnyx-number-settings.getphonenumbermessagingsettings
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatephonenumbermessagingsettings
        description: Update the messaging profile and/or messaging product of a phone number
        call: telnyx-number-settings.updatephonenumbermessagingsettings
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: telnyx-number-settings-mcp
    port: 9090
    transport: http
    description: MCP adapter for Telnyx API — Number Settings. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: bulk-update-phone-number-profiles
      description: Bulk update phone number profiles
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-number-settings.bulkupdatemessagingsettingsonphonenumbers
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-bulk-update-status
      description: Retrieve bulk update status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-number-settings.getbulkupdatemessagingsettingsonphonenumbersstatus
      with:
        order_id: tools.order_id
      outputParameters:
      - type: object
        mapping: $.
    - name: list-phone-numbers-messaging-settings
      description: List phone numbers with messaging settings
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-number-settings.listphonenumberswithmessagingsettings
      with:
        filter[messaging_profile_id]: tools.filter[messaging_profile_id]
        filter[phone_number]: tools.filter[phone_number]
        filter[phone_number][contains]: tools.filter[phone_number][contains]
        filter[type]: tools.filter[type]
        sort[phone_number]: tools.sort[phone_number]
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-phone-number-messaging-settings
      description: Retrieve a phone number with messaging settings
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-number-settings.getphonenumbermessagingsettings
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-messaging-profile-and-messaging
      description: Update the messaging profile and/or messaging product of a phone number
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: telnyx-number-settings.updatephonenumbermessagingsettings
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.