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

# Get session details

> Recupera detalhes de uma sessão específica, incluindo informações opcionais de assinatura



## OpenAPI

````yaml api-reference/openapi.json get /session/{sessionId}
openapi: 3.0.0
info:
  title: Zappaz API
  description: API para envio de mensagens e gerenciamento de webhooks
  version: 1.0.0
servers:
  - url: https://api.zappaz.io/api/v1
    description: Servidor de API de Desenvolvimento
security:
  - bearerAuth: []
tags:
  - name: Sessions
    description: Operações de gerenciamento de sessões
  - name: Messages
    description: Operações de envio de mensagens
  - name: Webhooks
    description: Operações de gerenciamento de webhooks
  - name: Actions
    description: Ações do WhatsApp como gerenciamento de perfil e operações de contato
  - name: Groups
    description: Operações de gerenciamento de grupos do WhatsApp
  - name: Privacy
    description: Gerenciamento de configurações de privacidade
paths:
  /session/{sessionId}:
    parameters:
      - $ref: '#/components/parameters/sessionId'
    get:
      tags:
        - Sessions
      summary: Get session details
      description: >-
        Recupera detalhes de uma sessão específica, incluindo informações
        opcionais de assinatura
      parameters:
        - in: query
          name: includeSubscription
          required: false
          schema:
            type: boolean
            default: false
          description: Se deve incluir informações de assinatura na resposta
      responses:
        '200':
          description: Detalhes da sessão recuperados com sucesso
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Identificador único da sessão
                    example: 05f02fa6-d7b0-4120-9f08-f60cd7337c72
                  token:
                    type: string
                    description: Token JWT da sessão
                    example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
                  displayName:
                    type: string
                    description: Nome de exibição da sessão
                    example: Zappaz - Prod
                  status:
                    type: string
                    description: Status atual da sessão
                    example: open
                  jid:
                    type: string
                    description: JID do WhatsApp da sessão
                    example: 5519981979779@s.whatsapp.net
                  profilePictureUrl:
                    type: string
                    description: URL da foto de perfil do WhatsApp
                    example: https://pps.whatsapp.net/v/t61.24694-24/...
                  enabled:
                    type: boolean
                    description: Se a sessão está habilitada
                  archived:
                    type: boolean
                    description: Se a sessão está arquivada
                  disconnectedAt:
                    type: string
                    format: date-time
                    nullable: true
                    description: Data da última desconexão
                  connectedAt:
                    type: string
                    format: date-time
                    description: Data da última conexão
                  userId:
                    type: string
                    description: ID do usuário proprietário da sessão
                  workerNodeId:
                    type: string
                    nullable: true
                    description: ID do nó do worker
                  stripeSubscription:
                    $ref: '#/components/schemas/StripeSubscription'
                    description: >-
                      Informações da assinatura Stripe (apenas quando
                      includeSubscription=true)
                  config:
                    $ref: '#/components/schemas/SessionConfig'
                    description: Configurações da sessão
        '404':
          description: Sessão não encontrada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Erro interno do servidor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  parameters:
    sessionId:
      in: path
      name: sessionId
      required: true
      schema:
        type: string
      description: Identificador único da sessão
  schemas:
    StripeSubscription:
      type: object
      properties:
        id:
          type: string
          description: Identificador único da assinatura Stripe
        subscriptionId:
          type: string
          description: ID da assinatura no Stripe
        waSessionId:
          type: string
          description: ID da sessão do WhatsApp associada
        status:
          type: string
          description: Status da assinatura
        customerId:
          type: string
          description: ID do cliente no Stripe
        subscriptionItemId:
          type: string
          description: ID do item da assinatura no Stripe
        subscriptionItemAmount:
          type: number
          description: Valor da assinatura em centavos
        latestInvoice:
          type: string
          description: ID da última fatura
        description:
          type: string
          nullable: true
          description: Descrição da assinatura
        startDate:
          type: string
          format: date-time
          description: Data de início da assinatura
        trialEnd:
          type: string
          format: date-time
          description: Data de fim do período de teste
        currentPeriodEnd:
          type: string
          format: date-time
          description: Data de fim do período atual
        currentPeriodStart:
          type: string
          format: date-time
          description: Data de início do período atual
        createdAt:
          type: string
          format: date-time
          description: Data de criação da assinatura
        updatedAt:
          type: string
          format: date-time
          description: Data da última atualização
    SessionConfig:
      type: object
      properties:
        messageOnCall:
          type: string
          description: >-
            Uma mensagem a ser enviada quando uma chamada é recebida. Quando
            messageOnCall é definido, a chamada recebida será rejeitada e a
            mensagem será enviada para o chamador
        rejectCalls:
          type: boolean
          default: false
          description: Se deve rejeitar chamadas recebidas
        ignoreGroups:
          type: boolean
          default: false
          description: Se deve ignorar grupos
        syncFullHistory:
          type: boolean
          default: false
          description: Se deve sincronizar o histórico completo de um chat
        markOnlineOnConnect:
          type: boolean
          default: false
          description: >-
            Quando definido como true, assim que uma sessão é conectada, os
            contatos sempre verão o usuário como online
        clientConnectionName:
          type: string
          description: >-
            O nome da conexão do cliente. Este nome é mostrado na lista de
            clientes conectados
    ErrorResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - failed
        message:
          type: string
  securitySchemes:
    bearerAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Token de usuário ou sessão, passado diretamente como uma string no
        cabeçalho 'Authorization'. O token de usuário tem escopo sobre todas as
        sessões pertencentes ao usuário. O token de sessão é limitado à própria
        sessão.

````