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

# Status do AR-WhatsApp



## OpenAPI

````yaml /openapi.yaml get /gw/whatsapp/{idEmail}
openapi: 3.0.3
info:
  title: AR Online API Gateway
  version: '1.0'
  description: >
    API de notificações multicanal da AR Online. Um único `POST /gw/email` pode
    disparar e-mail, SMS, WhatsApp, voz e carta. O processamento é assíncrono: a
    resposta retorna um `idEmail` usado para consultar o status posteriormente.
servers:
  - url: https://api.ar-online.com.br
    description: Produção
security:
  - tokenAuth: []
tags:
  - name: Envio
    description: Envio de notificações
  - name: Status
    description: Consulta de status e provas
  - name: Templates
    description: Gerenciamento de templates
paths:
  /gw/whatsapp/{idEmail}:
    get:
      tags:
        - Status
      summary: Status do AR-WhatsApp
      parameters:
        - $ref: '#/components/parameters/idEmail'
      responses:
        '200':
          description: Status do WhatsApp
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusWhatsapp'
        '404':
          $ref: '#/components/responses/Erro404Status'
components:
  parameters:
    idEmail:
      name: idEmail
      in: path
      required: true
      description: ID único retornado no envio (UUID).
      schema:
        type: string
  schemas:
    StatusWhatsapp:
      type: object
      properties:
        description:
          type: string
        dateSent:
          type: string
        dateDelivery:
          type: string
        dateResponse:
          type: string
        dateAccessLink:
          type: string
        error:
          type: boolean
        failureReason:
          type: string
          nullable: true
        customID:
          type: string
          nullable: true
        idEmail:
          type: string
    Erro:
      type: object
      properties:
        statusCode:
          type: integer
        message:
          type: string
        error:
          type: string
  responses:
    Erro404Status:
      description: Sem status
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Erro'
          example:
            statusCode: 404
            message: Email sem status!
  securitySchemes:
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >
        Token JWT enviado no cabeçalho `Authorization`, **sem** o prefixo
        `Bearer`. Solicite o token de produção ao suporte
        (suporte@ar-online.com.br).

````