Telnyx API — Rooms

naftiko: 1.0.0-alpha2
info:
  label: Telnyx API — Rooms
  description: 'Telnyx API — Rooms. 6 operations. Lead operation: View a list of rooms.. Self-contained Naftiko capability
    covering one Telnyx business surface.'
  tags:
  - Telnyx
  - Rooms
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TELNYX_API_KEY: TELNYX_API_KEY
capability:
  consumes:
  - type: http
    namespace: telnyx-rooms
    baseUri: https://api.telnyx.com/v2
    description: Telnyx API — Rooms business capability. Self-contained, no shared references.
    resources:
    - name: rooms
      path: /rooms
      operations:
      - name: listrooms
        method: GET
        description: View a list of rooms.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: include_sessions
          in: query
          type: boolean
          description: To decide if room sessions should be included in the response.
        - name: filter
          in: query
          type: object
          description: 'Consolidated filter parameter (deepObject style). Originally: filter[date_created_at][eq], filter[date_created_at][gte],
            filter[date_created_at][lte], filter[da'
      - name: createroom
        method: POST
        description: Create a room.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rooms-room_id
      path: /rooms/{room_id}
      operations:
      - name: deleteroom
        method: DELETE
        description: Delete a room.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: room_id
          in: path
          type: string
          description: The unique identifier of a room.
          required: true
      - name: viewroom
        method: GET
        description: View a room.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: room_id
          in: path
          type: string
          description: The unique identifier of a room.
          required: true
        - name: include_sessions
          in: query
          type: boolean
          description: To decide if room sessions should be included in the response.
      - name: updateroom
        method: PATCH
        description: Update a room.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: room_id
          in: path
          type: string
          description: The unique identifier of a room.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rooms-room_id-sessions
      path: /rooms/{room_id}/sessions
      operations:
      - name: retrievelistroomsessions
        method: GET
        description: View a list of room sessions.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: room_id
          in: path
          type: string
          description: The unique identifier of a room.
          required: true
        - name: include_participants
          in: query
          type: boolean
          description: To decide if room participants should be included in the response.
        - name: filter
          in: query
          type: object
          description: 'Consolidated filter parameter (deepObject style). Originally: filter[date_created_at][eq], filter[date_created_at][gte],
            filter[date_created_at][lte], filter[da'
    authentication:
      type: bearer
      token: '{{env.TELNYX_API_KEY}}'
  exposes:
  - type: rest
    namespace: telnyx-rooms-rest
    port: 8080
    description: REST adapter for Telnyx API — Rooms. One Spectral-compliant resource per consumed operation, prefixed with
      /v1.
    resources:
    - path: /v1/rooms
      name: rooms
      description: REST surface for rooms.
      operations:
      - method: GET
        name: listrooms
        description: View a list of rooms.
        call: telnyx-rooms.listrooms
        with:
          include_sessions: rest.include_sessions
          filter: rest.filter
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createroom
        description: Create a room.
        call: telnyx-rooms.createroom
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/rooms/{room-id}
      name: rooms-room-id
      description: REST surface for rooms-room_id.
      operations:
      - method: DELETE
        name: deleteroom
        description: Delete a room.
        call: telnyx-rooms.deleteroom
        with:
          room_id: rest.room_id
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: viewroom
        description: View a room.
        call: telnyx-rooms.viewroom
        with:
          room_id: rest.room_id
          include_sessions: rest.include_sessions
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateroom
        description: Update a room.
        call: telnyx-rooms.updateroom
        with:
          room_id: rest.room_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/rooms/{room-id}/sessions
      name: rooms-room-id-sessions
      description: REST surface for rooms-room_id-sessions.
      operations:
      - method: GET
        name: retrievelistroomsessions
        description: View a list of room sessions.
        call: telnyx-rooms.retrievelistroomsessions
        with:
          room_id: rest.room_id
          include_participants: rest.include_participants
          filter: rest.filter
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: telnyx-rooms-mcp
    port: 9090
    transport: http
    description: MCP adapter for Telnyx API — Rooms. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: view-list-rooms
      description: View a list of rooms.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-rooms.listrooms
      with:
        include_sessions: tools.include_sessions
        filter: tools.filter
      outputParameters:
      - type: object
        mapping: $.
    - name: create-room
      description: Create a room.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-rooms.createroom
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-room
      description: Delete a room.
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: telnyx-rooms.deleteroom
      with:
        room_id: tools.room_id
      outputParameters:
      - type: object
        mapping: $.
    - name: view-room
      description: View a room.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-rooms.viewroom
      with:
        room_id: tools.room_id
        include_sessions: tools.include_sessions
      outputParameters:
      - type: object
        mapping: $.
    - name: update-room
      description: Update a room.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: telnyx-rooms.updateroom
      with:
        room_id: tools.room_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: view-list-room-sessions
      description: View a list of room sessions.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-rooms.retrievelistroomsessions
      with:
        room_id: tools.room_id
        include_participants: tools.include_participants
        filter: tools.filter
      outputParameters:
      - type: object
        mapping: $.