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

# Consultar chamada WhatsApp

> Consulta status, duração, motivo de encerramento e (opcional) eventos da chamada.



## OpenAPI

````yaml /whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/calls/{id}
openapi: 3.0.3
info:
  title: Notifique API — WhatsApp
  description: >-
    Envie mensagens WhatsApp e gerencie conexões. Autentique com `Authorization:
    Bearer sk_live_...` ou `x-api-key`.
  version: 1.0.0
servers:
  - url: https://api.notifique.dev
    description: Produção
security:
  - ntfWaBearerAuth: []
  - ntfWaApiKeyHeader: []
tags:
  - name: Mensagens
    description: Enviar, listar, editar e cancelar mensagens
  - name: Instâncias
    description: >-
      Cadastre e gerencie os números de WhatsApp conectados — cada número é uma
      **instância** (o telefone por onde entram e saem as mensagens).
  - name: Grupos
    description: Grupos (só conexão não oficial)
  - name: Chamadas
    description: Ligar e falar no WhatsApp (conexão não oficial hoje; oficial em breve)
  - name: Sending pools
    description: Balanceamento de instâncias WhatsApp
paths:
  /v1/whatsapp/calls/{id}:
    get:
      tags:
        - Chamadas
      summary: Consultar chamada WhatsApp
      description: >-
        Consulta status, duração, motivo de encerramento e (opcional) eventos da
        chamada.
      operationId: ntfWa_getV1WhatsappCallById
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: includeEvents
          in: query
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
          description: Se `true`, inclui `events` na resposta.
      responses:
        '200':
          description: Detalhe da chamada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfWa_WhatsAppCallDetailEnvelope'
              example:
                success: true
        '401':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfWa_ErrorResponse'
              example:
                success: false
                error: Bad Request
                code: VALIDATION_ERROR
                message: Campo inválido ou ausente.
        '403':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfWa_ErrorResponse'
              example:
                success: false
                error: Bad Request
                code: VALIDATION_ERROR
                message: Campo inválido ou ausente.
        '404':
          description: Chamada não encontrada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfWa_ErrorResponse'
              example:
                success: false
                error: Bad Request
                code: VALIDATION_ERROR
                message: Campo inválido ou ausente.
components:
  schemas:
    NtfWa_WhatsAppCallDetailEnvelope:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          allOf:
            - $ref: '#/components/schemas/NtfWa_WhatsAppCall'
            - type: object
              properties:
                events:
                  type: array
                  items:
                    $ref: '#/components/schemas/NtfWa_WhatsAppCallEvent'
      example:
        success: true
    NtfWa_ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          description: 'Rótulo HTTP do erro (ex.: Unauthorized, Bad Request, Not Found).'
        message:
          type: string
          description: >-
            Mensagem legível para exibir ao usuário (localizada via
            Accept-Language / x-locale quando aplicável).
        code:
          type: string
          description: >-
            Código estável da API v1 (enum). Sempre presente em erros. Use com o
            status HTTP para decidir retry ou correção. Ver [Respostas de
            erro](/guides/conceitos/resposta-de-erros).
        details:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
        note:
          type: string
      required:
        - success
        - error
        - message
        - code
      example:
        success: false
        error: string
        message: string
        code: string
        details:
          - field: string
            message: string
        note: string
    NtfWa_WhatsAppCall:
      type: object
      properties:
        id:
          type: string
        workspaceId:
          type: string
        instanceId:
          type: string
        connectionKind:
          type: string
        direction:
          type: string
          enum:
            - OUTBOUND
            - INBOUND
        to:
          type: string
        status:
          type: string
          enum:
            - QUEUED
            - INITIATED
            - RINGING
            - ANSWERED
            - PLAYING
            - COMPLETED
            - NO_ANSWER
            - FAILED
            - REJECTED
            - CANCELLED
        type:
          type: string
          enum:
            - speak
            - play
        speakText:
          type: string
          nullable: true
        playAudioUrl:
          type: string
          nullable: true
        providerCallId:
          type: string
          nullable: true
        answeredAt:
          type: string
          format: date-time
          nullable: true
        endedAt:
          type: string
          format: date-time
          nullable: true
        durationSecs:
          type: integer
          nullable: true
        hangupReason:
          type: string
          nullable: true
        errorCode:
          type: string
          nullable: true
        errorMessage:
          type: string
          nullable: true
        clientState:
          type: string
          nullable: true
        metadata:
          type: object
          nullable: true
          additionalProperties: true
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      example:
        id: clxx...
        workspaceId: clxx...
        instanceId: clxx...
        connectionKind: string
        direction: OUTBOUND
        to: '5511999999999'
        status: QUEUED
        type: speak
        speakText: string
        playAudioUrl: string
        providerCallId: clxx...
        answeredAt: '2025-02-10T14:00:00.000Z'
        endedAt: '2025-02-10T14:00:00.000Z'
        durationSecs: 1
        hangupReason: string
        errorCode: string
        errorMessage: string
        clientState: string
        metadata: {}
        createdAt: '2025-02-10T14:00:00.000Z'
        updatedAt: '2025-02-10T14:00:00.000Z'
    NtfWa_WhatsAppCallEvent:
      type: object
      properties:
        id:
          type: string
        eventType:
          type: string
        payload:
          nullable: true
        occurredAt:
          type: string
          format: date-time
      example:
        id: clxx...
        eventType: string
        occurredAt: '2025-02-10T14:00:00.000Z'
  securitySchemes:
    ntfWaBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        API Key no header Authorization. Exemplo: `Authorization: Bearer
        sk_live_xxxxx`
    ntfWaApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: API Key no header x-api-key.

````