RingCentral API — Chats

naftiko: 1.0.0-alpha2
info:
  label: RingCentral API — Chats
  description: 'RingCentral API — Chats. 6 operations. Lead operation: List Chats. Self-contained Naftiko capability covering
    one Ringcentral business surface.'
  tags:
  - Ringcentral
  - Chats
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    RINGCENTRAL_API_KEY: RINGCENTRAL_API_KEY
capability:
  consumes:
  - type: http
    namespace: platform-chats
    baseUri: https://platform.ringcentral.com
    description: RingCentral API — Chats business capability. Self-contained, no shared references.
    resources:
    - name: team-messaging-v1-chats
      path: /team-messaging/v1/chats
      operations:
      - name: listglipchatsnew
        method: GET
        description: List Chats
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: type
          in: query
          type: array
          description: Type of chats to be fetched. By default, all type of chats will be fetched
        - name: recordCount
          in: query
          type: integer
          description: Number of chats to be fetched by one request. The maximum value is 250, by default - 30.
        - name: pageToken
          in: query
          type: string
          description: Pagination token.
    - name: team-messaging-v1-chats-chatId
      path: /team-messaging/v1/chats/{chatId}
      operations:
      - name: readglipchatnew
        method: GET
        description: Get Chat
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: chatId
          in: path
          type: string
          description: Internal identifier of a chat. If tilde (~) is specified, then `/me` (Personal) chat will be returned
          required: true
    - name: team-messaging-v1-chats-chatId-favorite
      path: /team-messaging/v1/chats/{chatId}/favorite
      operations:
      - name: favoriteglipchatnew
        method: POST
        description: Add Chat to Favorites
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: chatId
          in: path
          type: string
          description: Internal identifier of a chat to add to favorite list.
          required: true
    - name: team-messaging-v1-chats-chatId-unfavorite
      path: /team-messaging/v1/chats/{chatId}/unfavorite
      operations:
      - name: unfavoriteglipchatnew
        method: POST
        description: Remove Chat from Favorites
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: chatId
          in: path
          type: string
          description: Internal identifier of a chat to remove from favorite list.
          required: true
    - name: team-messaging-v1-favorites
      path: /team-messaging/v1/favorites
      operations:
      - name: listfavoritechatsnew
        method: GET
        description: List Favorite Chats
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: recordCount
          in: query
          type: integer
          description: Max number of chats to be fetched by one request (Not more than 250).
    - name: team-messaging-v1-recent-chats
      path: /team-messaging/v1/recent/chats
      operations:
      - name: listrecentchatsnew
        method: GET
        description: List Recent Chats
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: type
          in: query
          type: array
          description: Type of chats to be fetched. By default, all chat types are returned
        - name: recordCount
          in: query
          type: integer
          description: Max number of chats to be fetched by one request (Not more than 250).
    authentication:
      type: bearer
      token: '{{env.RINGCENTRAL_API_KEY}}'
  exposes:
  - type: rest
    namespace: platform-chats-rest
    port: 8080
    description: REST adapter for RingCentral API — Chats. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/team-messaging/v1/chats
      name: team-messaging-v1-chats
      description: REST surface for team-messaging-v1-chats.
      operations:
      - method: GET
        name: listglipchatsnew
        description: List Chats
        call: platform-chats.listglipchatsnew
        with:
          type: rest.type
          recordCount: rest.recordCount
          pageToken: rest.pageToken
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/team-messaging/v1/chats/{chatid}
      name: team-messaging-v1-chats-chatid
      description: REST surface for team-messaging-v1-chats-chatId.
      operations:
      - method: GET
        name: readglipchatnew
        description: Get Chat
        call: platform-chats.readglipchatnew
        with:
          chatId: rest.chatId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/team-messaging/v1/chats/{chatid}/favorite
      name: team-messaging-v1-chats-chatid-favorite
      description: REST surface for team-messaging-v1-chats-chatId-favorite.
      operations:
      - method: POST
        name: favoriteglipchatnew
        description: Add Chat to Favorites
        call: platform-chats.favoriteglipchatnew
        with:
          chatId: rest.chatId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/team-messaging/v1/chats/{chatid}/unfavorite
      name: team-messaging-v1-chats-chatid-unfavorite
      description: REST surface for team-messaging-v1-chats-chatId-unfavorite.
      operations:
      - method: POST
        name: unfavoriteglipchatnew
        description: Remove Chat from Favorites
        call: platform-chats.unfavoriteglipchatnew
        with:
          chatId: rest.chatId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/team-messaging/v1/favorites
      name: team-messaging-v1-favorites
      description: REST surface for team-messaging-v1-favorites.
      operations:
      - method: GET
        name: listfavoritechatsnew
        description: List Favorite Chats
        call: platform-chats.listfavoritechatsnew
        with:
          recordCount: rest.recordCount
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/team-messaging/v1/recent/chats
      name: team-messaging-v1-recent-chats
      description: REST surface for team-messaging-v1-recent-chats.
      operations:
      - method: GET
        name: listrecentchatsnew
        description: List Recent Chats
        call: platform-chats.listrecentchatsnew
        with:
          type: rest.type
          recordCount: rest.recordCount
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: platform-chats-mcp
    port: 9090
    transport: http
    description: MCP adapter for RingCentral API — Chats. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-chats
      description: List Chats
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-chats.listglipchatsnew
      with:
        type: tools.type
        recordCount: tools.recordCount
        pageToken: tools.pageToken
      outputParameters:
      - type: object
        mapping: $.
    - name: get-chat
      description: Get Chat
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-chats.readglipchatnew
      with:
        chatId: tools.chatId
      outputParameters:
      - type: object
        mapping: $.
    - name: add-chat-favorites
      description: Add Chat to Favorites
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: platform-chats.favoriteglipchatnew
      with:
        chatId: tools.chatId
      outputParameters:
      - type: object
        mapping: $.
    - name: remove-chat-favorites
      description: Remove Chat from Favorites
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: platform-chats.unfavoriteglipchatnew
      with:
        chatId: tools.chatId
      outputParameters:
      - type: object
        mapping: $.
    - name: list-favorite-chats
      description: List Favorite Chats
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-chats.listfavoritechatsnew
      with:
        recordCount: tools.recordCount
      outputParameters:
      - type: object
        mapping: $.
    - name: list-recent-chats
      description: List Recent Chats
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-chats.listrecentchatsnew
      with:
        type: tools.type
        recordCount: tools.recordCount
      outputParameters:
      - type: object
        mapping: $.