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

# Listar modelos de mensagem

> Modelos de mensagem da empresa. Os modelos valem para a empresa toda, e não por número: `phone_number_id` é aceito por compatibilidade e não altera o resultado.

Enviar modelo não faz parte desta API — a lista serve para conferência e para montar campanhas no painel.



## OpenAPI

````yaml /openapi.json get /whatsapp/templates
openapi: 3.1.0
info:
  title: API WizeBot
  version: 3.0.0
  description: >-
    A API da WizeBot tem duas camadas sobre a **mesma base**
    `https://api.wizebot.com.br/v1`.


    **Contrato multicanal** — a camada neutra. Os mesmos endpoints falam com
    WhatsApp, com Telegram e com os canais que vierem depois. O canal não
    aparece na URL nem no corpo: ele vem da conta escolhida como remetente.
    Campos, códigos e mensagens em inglês.


    **API de WhatsApp** — a camada específica do canal, com o que só o WhatsApp
    tem. Continua existindo e não muda; quem já integrou com ela não precisa
    migrar.


    Toda requisição se autentica por cabeçalho. Não há autenticação por corpo
    nem por query string.
servers:
  - url: https://api.wizebot.com.br/v1
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Canais
    description: Contas de canal conectadas e o que cada uma aceita.
  - name: Mensagens
    description: Envio e status pelo contrato neutro, em qualquer canal.
  - name: WhatsApp · Mensagens
    description: Envio, status e modelos na camada específica de WhatsApp.
  - name: WhatsApp · Contatos
    description: Contatos e campos personalizados.
  - name: WhatsApp · Etiquetas
    description: Etiquetas e sua atribuição a contatos.
  - name: WhatsApp · Sequências
    description: Sequências agendadas de um contato.
  - name: WhatsApp · Conta
    description: Verificação da chave de API.
paths:
  /whatsapp/templates:
    get:
      tags:
        - WhatsApp · Mensagens
      summary: Listar modelos de mensagem
      description: >-
        Modelos de mensagem da empresa. Os modelos valem para a empresa toda, e
        não por número: `phone_number_id` é aceito por compatibilidade e não
        altera o resultado.


        Enviar modelo não faz parte desta API — a lista serve para conferência e
        para montar campanhas no painel.
      operationId: whatsappListarModelos
      parameters:
        - name: phone_number_id
          in: query
          required: false
          schema:
            type: string
          description: Aceito por compatibilidade; os modelos são da empresa inteira.
          example: '102938475610293'
      responses:
        '200':
          description: Lista de modelos.
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                  - timestamp
                properties:
                  success:
                    type: boolean
                    description: Sempre `true` nas respostas de sucesso.
                  data:
                    type: object
                    properties:
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            template_id:
                              type:
                                - string
                                - 'null'
                            template_name:
                              type: string
                            template_type:
                              type: string
                              description: >-
                                Categoria: `MARKETING`, `UTILITY` ou
                                `AUTHENTICATION`.
                            locale:
                              type: string
                            status:
                              type: string
                            template_json:
                              type:
                                - array
                                - object
                                - 'null'
                  timestamp:
                    type: string
                    format: date-time
              example:
                success: true
                data:
                  items:
                    - id: 0b3d9f21-77aa-4c55-9e10-3f8b1c2d4e56
                      template_id: '1234567890123456'
                      template_name: confirmacao_pedido
                      template_type: UTILITY
                      locale: pt_BR
                      status: APPROVED
                      template_json:
                        - type: BODY
                          text: Olá {{1}}, seu pedido foi confirmado.
                timestamp: '2026-09-09T17:15:20.453Z'
        '401':
          description: '`UNAUTHORIZED` — Invalid or missing API key.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErroDaApi'
              examples:
                UNAUTHORIZED:
                  summary: UNAUTHORIZED
                  value:
                    success: false
                    statusCode: 401
                    timestamp: '2026-09-09T17:15:20.453Z'
                    path: /api/v1/whatsapp/templates
                    method: GET
                    message:
                      error: UNAUTHORIZED
                      message: Invalid or missing API key.
                    errorId: ERR-MTUD0DBO-KKRMP8
        '429':
          description: '`RATE_LIMITED` — Too many requests.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErroDaApi'
              examples:
                RATE_LIMITED:
                  summary: RATE_LIMITED
                  value:
                    success: false
                    statusCode: 429
                    timestamp: '2026-09-09T17:15:20.453Z'
                    path: /api/v1/whatsapp/templates
                    method: GET
                    message:
                      error: RATE_LIMITED
                      message: Too many requests.
                    errorId: ERR-MTUD0DBO-KKRMP8
components:
  schemas:
    ErroDaApi:
      type: object
      description: >-
        Corpo de erro da API. `message` é um **objeto** com o código nomeado —
        não uma string.
      required:
        - success
        - statusCode
        - message
      properties:
        success:
          type: boolean
          description: Sempre `false`.
        statusCode:
          type: integer
        timestamp:
          type: string
          format: date-time
        path:
          type: string
          description: >-
            Caminho interno da requisição. Traz o prefixo `/api/v1` mesmo quando
            você chamou por `/v1`: o apelido é reescrito antes do roteamento.
        method:
          type: string
        message:
          type: object
          required:
            - error
            - message
          properties:
            error:
              type: string
              description: >-
                Código nomeado. É por ele que se trata o erro em código, nunca
                pelo texto.
            message:
              type: string
              description: Descrição em inglês, para leitura humana.
            details:
              type: object
              additionalProperties: true
              description: >-
                Contexto estruturado, presente nos códigos que o emitem —
                `CHANNEL_MISMATCH`, `NO_OPEN_CONVERSATION`,
                `RECIPIENT_NOT_ON_CHANNEL` e `UNSUPPORTED_CAPABILITY`.
        errorId:
          type: string
          description: Identificador do erro. Cite-o ao falar com o suporte.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Chave de API no cabeçalho `Authorization: Bearer SUA-CHAVE`.


        A API também aceita `x-api-key: SUA-CHAVE` e `Authorization: ApiKey
        SUA-CHAVE` — as três formas são equivalentes, inclusive para o limite de
        requisições.


        A chave dá acesso total à conta e é de servidor para servidor: não a use
        em navegador ou aplicativo móvel.

````