> ## 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.

# Entrar na sala do encontro

> A credencial do aluno inscrito no encontro.



## OpenAPI

````yaml POST /v1/clubs/{clubId}/classroom/mentorships/{publicId}/sessions/{sessionId}/join
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/mentorships/{publicId}/sessions/{sessionId}/join:
    parameters:
      - $ref: '#/components/parameters/OrgId'
      - $ref: '#/components/parameters/PublicId'
      - $ref: '#/components/parameters/MentorshipSessionId'
    post:
      tags:
        - mentorships
      summary: Entra na sala do encontro
      description: >
        Quem está inscrito e não desmarcou. A sala abre quinze minutos antes
        (409

        `too_early`) e fecha trinta minutos depois do fim (409 `too_late`);

        `room_opens_at` e `room_closes_at` na sessão dizem quando. Só quando o

        encontro é na sala nossa (409 `meeting_is_link`).
      operationId: joinClassroomMentorshipSession
      responses:
        '200':
          description: A credencial de entrada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoomAccessResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
        '501':
          $ref: '#/components/responses/NotConfigured'
      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
    MentorshipSessionId:
      name: sessionId
      in: path
      required: true
      schema:
        type: string
        format: uuid
  schemas:
    RoomAccessResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/RoomAccess'
    RoomAccess:
      type: object
      required:
        - server_url
        - token
        - room
        - identity
        - role
        - expires_at
      properties:
        server_url:
          description: O endereço do servidor de vídeo (`wss://`).
          type: string
        token:
          description: >
            A credencial de ENTRADA. Vale por poucos minutos para conectar;
            depois

            de conectada, a sala a renova sozinha. Peça outra a cada entrada.
          type: string
        room:
          type: string
        identity:
          description: >-
            A identidade na sala — é por ela que a tela reconhece a própria
            mensagem.
          type: string
        role:
          $ref: '#/components/schemas/RoomRole'
        expires_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
    RoomRole:
      description: >
        `host` apresenta e manda na sala. `speaker` é o aluno chamado ao palco:

        publica câmera, microfone e tela. `audience` assiste. `participant` é
        quem

        está num encontro de mentoria, onde todo mundo fala.
      type: string
      enum:
        - host
        - speaker
        - audience
        - participant
      x-enum-varnames:
        - RoomRoleHost
        - RoomRoleSpeaker
        - RoomRoleAudience
        - RoomRoleParticipant
  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'
    Conflict:
      description: >-
        Conflito com o estado atual. O `code` diz qual; a descrição da operação
        lista os possíveis.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    TooManyRequests:
      description: Teto por IP atingido
      headers:
        Retry-After:
          schema:
            type: integer
      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'
    NotConfigured:
      description: |
        O ambiente não tem o que a operação precisa (`not_configured`): o
        provedor de autenticação nas rotas de sessão, o e-mail nas que
        enviam link, a chave de cifra nos webhooks.
      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

- [Entrar na sala do encontro (equipe)](/api-reference/mentorships/session-join.md)
- [Entrar na live](/api-reference/lives/classroom-join.md)
- [Entrar para apresentar](/api-reference/lives/join.md)
- [Lives](/essentials/lives.md)
- [Entrar](/api-reference/account/sign-in.md)
