> ## Documentation Index
> Fetch the complete documentation index at: https://docs.weve.cx/llms.txt
> Use this file to discover all available pages before exploring further.

# Chat da live

> As mensagens para quem chega no meio.



## OpenAPI

````yaml GET /v1/clubs/{clubId}/classroom/lives/{publicId}/messages
openapi: 3.0.3
info:
  title: weve API
  description: >
    Contrato entre a API Go e o dashboard. **Este arquivo é a fonte de
    verdade**:

    os tipos e a interface de servidor em Go, e o client TypeScript, são todos

    gerados daqui (`make openapi`). Handler que divergir da interface não
    compila.


    A superfície interna (`/internal/*`) fica de fora de propósito: é acesso de

    máquina, protegido por segredo dedicado, e não é contrato de cliente.
  version: 0.2.0
servers:
  - url: https://api.weve.cx
    description: produção
  - url: http://localhost:8080
    description: desenvolvimento
security: []
tags:
  - name: health
  - name: session
  - name: account
  - name: clubs
  - name: members
  - name: webhooks
  - name: outgoing-webhooks
  - name: sales-platforms
  - name: catalog
  - name: content
  - name: classroom
  - name: community
  - name: mentorships
  - name: agents
  - name: lives
  - name: students
  - name: auth
  - name: campaigns
  - name: workflows
  - name: email
paths:
  /v1/clubs/{clubId}/classroom/lives/{publicId}/messages:
    parameters:
      - $ref: '#/components/parameters/OrgId'
      - $ref: '#/components/parameters/PublicId'
    get:
      tags:
        - lives
      summary: O chat da live
      description: >
        As 200 mais recentes, para quem chega no meio. As seguintes chegam pela

        sala, no tópico `chat`: `{"type": "message", "message": LiveMessage}`,

        `{"type": "hidden", "id": "…"}` e `{"type": "shown", "message":
        LiveMessage}`.
      operationId: listClassroomLiveMessages
      responses:
        '200':
          description: As mensagens
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LiveMessageList'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - studentSession: []
components:
  parameters:
    OrgId:
      name: clubId
      in: path
      required: true
      description: >
        Id público da organização — o mesmo que `GET /v1/me` devolve em

        `organization_id`.


        Na URL o recurso se chama **club**; no contrato e no domínio,
        organization.

        A divergência é deliberada: `clubs` é a palavra do produto, e a URL é o
        que

        as pessoas leem.


        É o identificador do provedor de autenticação, e é assim de propósito:

        o cliente precisa nomear a organização ao pedir o token, e o token é o

        que prova o escopo. Um id só nosso obrigaria a traduzir um no outro

        antes de ter um token — e a tradução exigiria uma chamada escopada, que

        é justamente a que ainda não dá para fazer.


        O uuid interno da organização não aparece no contrato: ele é o que as

        chaves estrangeiras do domínio referenciam, e continua sendo nosso.
      schema:
        type: string
        format: uuid
    PublicId:
      name: publicId
      in: path
      required: true
      description: A chave curta da URL do classroom.
      schema:
        type: string
        minLength: 1
        maxLength: 32
  schemas:
    LiveMessageList:
      type: object
      required:
        - data
      properties:
        data:
          description: As mais recentes, na ordem de leitura (a mais velha primeiro).
          type: array
          items:
            $ref: '#/components/schemas/LiveMessage'
    LiveMessage:
      type: object
      required:
        - id
        - body
        - author_name
        - author_role
        - author_identity
        - hidden
        - created_at
      properties:
        id:
          type: string
          format: uuid
        body:
          description: Texto cru — quem desenha escapa.
          type: string
        author_name:
          type: string
        author_role:
          $ref: '#/components/schemas/LiveMessageAuthorRole'
        author_identity:
          description: >-
            A identidade de quem escreveu na sala (vazia se a pessoa da equipe
            saiu do club).
          type: string
        student_id:
          description: Só para a equipe, para silenciar quem escreveu.
          type: string
          format: uuid
        hidden:
          description: Oculta pela equipe. O aluno só a recebe quando é dele.
          type: boolean
        created_at:
          type: string
          format: date-time
    ErrorEnvelope:
      type: object
      description: >-
        Envelope único de erro da API. O `code` é o contrato com o cliente — a
        `message` é diagnóstico, e pode mudar.
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
          properties:
            code:
              type: string
            message:
              type: string
    LiveMessageAuthorRole:
      type: string
      enum:
        - student
        - host
      x-enum-varnames:
        - LiveAuthorStudent
        - LiveAuthorHost
  responses:
    Unauthorized:
      description: Sessão ausente, expirada ou revogada
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Forbidden:
      description: >
        A sessão é válida, mas não age nesta organização. É a mesma resposta
        para

        uma organização que não existe — distinguir as duas deixaria enumerar

        organizações alheias.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    NotFound:
      description: Recurso não encontrado
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    InternalError:
      description: >-
        Falha inesperada. O corpo nunca traz o erro real — ele fica no log e no
        rastreamento.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    studentSession:
      type: http
      scheme: bearer
      description: |
        Token OPACO de sessão de aluno, emitido por `/v1/auth/sign-in` e
        verificado contra a nossa tabela — não é JWT e não se lê nada dele.

        A ida ao banco não é custo novo: toda requisição autenticada já resolve
        o dono da sessão. Em troca, encerrar uma sessão vale no mesmo instante,
        sem lista de bloqueio nem janela de tolerância.

        O classroom o guarda em cookie **host-only**: um cookie de domínio o
        mandaria para os subdomínios dos outros clubs.

````

## Related topics

- [Chat da live (equipe)](/api-reference/lives/messages-list.md)
- [Lives](/essentials/lives.md)
- [Escrever no chat](/api-reference/lives/classroom-messages-create.md)
- [Marcar live](/api-reference/lives/create.md)
- [Ocultar mensagem](/api-reference/lives/messages-update.md)
