Telnyx API — Opt-Out Management

naftiko: 1.0.0-alpha2
info:
  label: Telnyx API — Opt-Out Management
  description: 'Telnyx API — Opt-Out Management. 6 operations. Lead operation: List opt-outs. Self-contained Naftiko capability
    covering one Telnyx business surface.'
  tags:
  - Telnyx
  - Opt-Out Management
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TELNYX_API_KEY: TELNYX_API_KEY
capability:
  consumes:
  - type: http
    namespace: telnyx-opt-out-management
    baseUri: https://api.telnyx.com/v2
    description: Telnyx API — Opt-Out Management business capability. Self-contained, no shared references.
    resources:
    - name: messaging_optouts
      path: /messaging_optouts
      operations:
      - name: listoptouts
        method: GET
        description: List opt-outs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: redaction_enabled
          in: query
          type: string
          description: If receiving address (+E.164 formatted phone number) should be redacted
        - name: filter
          in: query
          type: object
          description: 'Consolidated filter parameter (deepObject style). Originally: filter[messaging_profile_id], filter[from]'
        - name: created_at
          in: query
          type: object
          description: 'Consolidated created_at parameter (deepObject style). Originally: created_at[gte], created_at[lte]'
    - name: messaging_profiles-profile_id-autoresp_configs
      path: /messaging_profiles/{profile_id}/autoresp_configs
      operations:
      - name: getautorespconfigs
        method: GET
        description: List Auto-Response Settings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: profile_id
          in: path
          type: string
          required: true
        - name: country_code
          in: query
          type: string
        - name: created_at
          in: query
          type: object
          description: 'Consolidated created_at parameter (deepObject style). Originally: created_at[gte], created_at[lte]'
        - name: updated_at
          in: query
          type: object
          description: 'Consolidated updated_at parameter (deepObject style). Originally: updated_at[gte], updated_at[lte]'
      - name: createautorespconfig
        method: POST
        description: Create auto-response setting
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: profile_id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: messaging_profiles-profile_id-autoresp_configs-autoresp_cfg_id
      path: /messaging_profiles/{profile_id}/autoresp_configs/{autoresp_cfg_id}
      operations:
      - name: deleteautorespconfig
        method: DELETE
        description: Delete Auto-Response Setting
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: profile_id
          in: path
          type: string
          required: true
        - name: autoresp_cfg_id
          in: path
          type: string
          required: true
      - name: getautorespconfig
        method: GET
        description: Get Auto-Response Setting
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: profile_id
          in: path
          type: string
          required: true
        - name: autoresp_cfg_id
          in: path
          type: string
          required: true
      - name: updateautorespconfig
        method: PUT
        description: Update Auto-Response Setting
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: profile_id
          in: path
          type: string
          required: true
        - name: autoresp_cfg_id
          in: path
          type: string
          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-opt-out-management-rest
    port: 8080
    description: REST adapter for Telnyx API — Opt-Out Management. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/messaging-optouts
      name: messaging-optouts
      description: REST surface for messaging_optouts.
      operations:
      - method: GET
        name: listoptouts
        description: List opt-outs
        call: telnyx-opt-out-management.listoptouts
        with:
          redaction_enabled: rest.redaction_enabled
          filter: rest.filter
          created_at: rest.created_at
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/messaging-profiles/{profile-id}/autoresp-configs
      name: messaging-profiles-profile-id-autoresp-configs
      description: REST surface for messaging_profiles-profile_id-autoresp_configs.
      operations:
      - method: GET
        name: getautorespconfigs
        description: List Auto-Response Settings
        call: telnyx-opt-out-management.getautorespconfigs
        with:
          profile_id: rest.profile_id
          country_code: rest.country_code
          created_at: rest.created_at
          updated_at: rest.updated_at
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createautorespconfig
        description: Create auto-response setting
        call: telnyx-opt-out-management.createautorespconfig
        with:
          profile_id: rest.profile_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/messaging-profiles/{profile-id}/autoresp-configs/{autoresp-cfg-id}
      name: messaging-profiles-profile-id-autoresp-configs-autoresp-cfg-id
      description: REST surface for messaging_profiles-profile_id-autoresp_configs-autoresp_cfg_id.
      operations:
      - method: DELETE
        name: deleteautorespconfig
        description: Delete Auto-Response Setting
        call: telnyx-opt-out-management.deleteautorespconfig
        with:
          profile_id: rest.profile_id
          autoresp_cfg_id: rest.autoresp_cfg_id
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getautorespconfig
        description: Get Auto-Response Setting
        call: telnyx-opt-out-management.getautorespconfig
        with:
          profile_id: rest.profile_id
          autoresp_cfg_id: rest.autoresp_cfg_id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateautorespconfig
        description: Update Auto-Response Setting
        call: telnyx-opt-out-management.updateautorespconfig
        with:
          profile_id: rest.profile_id
          autoresp_cfg_id: rest.autoresp_cfg_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: telnyx-opt-out-management-mcp
    port: 9090
    transport: http
    description: MCP adapter for Telnyx API — Opt-Out Management. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-opt-outs
      description: List opt-outs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-opt-out-management.listoptouts
      with:
        redaction_enabled: tools.redaction_enabled
        filter: tools.filter
        created_at: tools.created_at
      outputParameters:
      - type: object
        mapping: $.
    - name: list-auto-response-settings
      description: List Auto-Response Settings
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-opt-out-management.getautorespconfigs
      with:
        profile_id: tools.profile_id
        country_code: tools.country_code
        created_at: tools.created_at
        updated_at: tools.updated_at
      outputParameters:
      - type: object
        mapping: $.
    - name: create-auto-response-setting
      description: Create auto-response setting
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-opt-out-management.createautorespconfig
      with:
        profile_id: tools.profile_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-auto-response-setting
      description: Delete Auto-Response Setting
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: telnyx-opt-out-management.deleteautorespconfig
      with:
        profile_id: tools.profile_id
        autoresp_cfg_id: tools.autoresp_cfg_id
      outputParameters:
      - type: object
        mapping: $.
    - name: get-auto-response-setting
      description: Get Auto-Response Setting
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-opt-out-management.getautorespconfig
      with:
        profile_id: tools.profile_id
        autoresp_cfg_id: tools.autoresp_cfg_id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-auto-response-setting
      description: Update Auto-Response Setting
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: telnyx-opt-out-management.updateautorespconfig
      with:
        profile_id: tools.profile_id
        autoresp_cfg_id: tools.autoresp_cfg_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.