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

# Listar templates do canal

> Lista os templates (modelos de mensagem) aprovados que o canal pode enviar, consultados na hora no provedor. Só o WhatsApp Cloud com conta de negócio (`waba_id`) tem templates — o canal informa isso em `capabilities.templates`; veja [Integrações](https://docs.olie.ai/guides/integrations/overview). O campo `parameters` diz o que o envio precisa: os marcadores de cabeçalho e corpo (posicionais `{{1}}` ou nomeados `{{nome}}`) e os botões de URL dinâmica. Ficam de fora templates com cabeçalho de mídia ou localização e com botão que pede outro tipo de parâmetro (copiar código, senha, flow).



## OpenAPI

````yaml /api-reference/openapi.json get /api/management/channels/{channel}/templates
openapi: 3.0.0
info:
  title: Olie API
  version: 1.0.0
  description: >
    # Introdução 👋


    Olá! Esta é a documentação oficial da API da [olie.ai](https://olie.ai/).
    Aqui você encontra as referências e exemplos de uso dos nossos endpoints.


    Para uma visão completa, recomendamos fortemente que você leia a
    [documentação oficial](https://docs.olie.ai/api-reference/introduction). Lá
    estão detalhados tópicos essenciais como
    [autenticação](https://docs.olie.ai/api-reference/introduction/authentication),
    [estrutura de
    respostas](https://docs.olie.ai/api-reference/general/response-structure),
    [paginação](https://docs.olie.ai/api-reference/general/pagination) e outros
    guias de integração.


    No Postman, esta coleção foca nas informações específicas de cada requisição
    (endpoints, parâmetros e exemplos), servindo como apoio rápido para testes e
    desenvolvimento.
servers:
  - url: https://api.olie.ai
security:
  - BearerAuth: []
paths:
  /api/management/channels/{channel}/templates:
    parameters:
      - name: channel
        in: path
        required: true
        description: ID (UUID) do canal.
        schema:
          type: string
        example: ''
    get:
      tags:
        - channels
      summary: Listar templates do canal
      description: >-
        Lista os templates (modelos de mensagem) aprovados que o canal pode
        enviar, consultados na hora no provedor. Só o WhatsApp Cloud com conta
        de negócio (`waba_id`) tem templates — o canal informa isso em
        `capabilities.templates`; veja
        [Integrações](https://docs.olie.ai/guides/integrations/overview). O
        campo `parameters` diz o que o envio precisa: os marcadores de cabeçalho
        e corpo (posicionais `{{1}}` ou nomeados `{{nome}}`) e os botões de URL
        dinâmica. Ficam de fora templates com cabeçalho de mídia ou localização
        e com botão que pede outro tipo de parâmetro (copiar código, senha,
        flow).
      responses:
        '200':
          description: Sucesso
          content:
            application/json:
              schema:
                description: Resposta com os templates que o canal pode enviar.
                type: object
                properties:
                  response:
                    type: boolean
                    description: Sempre `true` em caso de sucesso.
                  templates:
                    type: array
                    description: >-
                      Templates aprovados e enviáveis pelo canal; lista vazia
                      quando não há nenhum.
                    items:
                      description: Template aprovado que o canal pode enviar.
                      type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            Nome do template no provedor; é o `name` usado no
                            envio.
                        language:
                          type: string
                          description: >-
                            Código do idioma do template (ex.: `pt_BR`); é o
                            `language` usado no envio.
                        category:
                          type: string
                          description: >-
                            Categoria do template no provedor (`UTILITY`,
                            `MARKETING` ou `AUTHENTICATION`).
                        status:
                          type: string
                          enum:
                            - APPROVED
                          description: >-
                            Situação do template no provedor; sempre `APPROVED`,
                            pois só aprovados são listados.
                        components:
                          type: array
                          description: >-
                            Componentes do template como o provedor os descreve
                            (cabeçalho, corpo, rodapé e botões).
                          items:
                            description: Componente do template.
                            type: object
                            properties:
                              type:
                                type: string
                                description: >-
                                  Tipo do componente: `HEADER`, `BODY`, `FOOTER`
                                  ou `BUTTONS`.
                              format:
                                type: string
                                description: >-
                                  Formato do cabeçalho; sempre `TEXT` nos
                                  templates listados.
                              text:
                                type: string
                                description: >-
                                  Texto do componente, com os marcadores
                                  (`{{1}}` ou `{{nome}}`).
                              buttons:
                                type: array
                                description: >-
                                  Botões do template. Só o botão de URL pode ter
                                  marcador (`{{1}}` no fim da URL).
                                items:
                                  description: Botão do template.
                                  type: object
                                  properties:
                                    type:
                                      type: string
                                      description: >-
                                        Tipo do botão: `QUICK_REPLY`,
                                        `PHONE_NUMBER` ou `URL`.
                                    text:
                                      type: string
                                      description: Texto do botão.
                                    url:
                                      type: string
                                      description: >-
                                        Endereço do botão de URL; com `{{1}}`
                                        quando o fim do endereço é preenchido no
                                        envio.
                        parameter_format:
                          type: string
                          enum:
                            - POSITIONAL
                            - NAMED
                          description: >-
                            Formato dos marcadores: `POSITIONAL` (`{{1}}`,
                            `{{2}}`…) ou `NAMED` (`{{nome}}`).
                        header_text:
                          type: string
                          description: >-
                            Texto do cabeçalho com os marcadores; `null` quando
                            o template não tem cabeçalho.
                        body_text:
                          type: string
                          description: Texto do corpo com os marcadores.
                        footer_text:
                          type: string
                          description: >-
                            Texto do rodapé; `null` quando o template não tem
                            rodapé.
                        parameters:
                          type: object
                          description: >-
                            O que o envio precisa informar em cada parte do
                            template.
                          properties:
                            header:
                              type: integer
                              description: >-
                                Quantidade de valores de `parameters.header` no
                                envio (0 ou 1).
                            body:
                              type: integer
                              description: >-
                                Quantidade de valores de `parameters.body` no
                                envio.
                            header_names:
                              type: array
                              description: >-
                                Marcadores do cabeçalho, na ordem em que os
                                valores vão em lista. Posicional: `"1"`, `"2"`…
                              items:
                                type: string
                                description: Nome do marcador.
                            body_names:
                              type: array
                              description: >-
                                Marcadores do corpo, na ordem em que os valores
                                vão em lista: primeira aparição no texto
                                (nomeado) ou numérica (posicional).
                              items:
                                type: string
                                description: Nome do marcador.
                            buttons:
                              type: array
                              description: >-
                                Botões de URL dinâmica; cada um pede um valor em
                                `parameters.buttons` no envio.
                              items:
                                type: object
                                description: Botão de URL dinâmica.
                                properties:
                                  index:
                                    type: integer
                                    description: >-
                                      Posição do botão no template (a partir de
                                      0); é o `index` usado no envio.
                                  text:
                                    type: string
                                    description: Texto do botão.
                                  url:
                                    type: string
                                    description: >-
                                      Endereço do botão, com `{{1}}` no ponto
                                      preenchido pelo envio.
              example:
                response: true
                templates:
                  - name: pedido_enviado
                    language: pt_BR
                    category: UTILITY
                    status: APPROVED
                    components:
                      - type: HEADER
                        format: TEXT
                        text: Pedido {{1}}
                      - type: BODY
                        text: >-
                          Olá, {{1}}! Seu pedido {{2}} foi enviado e chega até
                          {{3}}.
                      - type: FOOTER
                        text: Equipe Exemplo
                      - type: BUTTONS
                        buttons:
                          - type: QUICK_REPLY
                            text: Recebi
                    parameter_format: POSITIONAL
                    header_text: Pedido {{1}}
                    body_text: >-
                      Olá, {{1}}! Seu pedido {{2}} foi enviado e chega até
                      {{3}}.
                    footer_text: Equipe Exemplo
                    parameters:
                      header: 1
                      body: 3
                      header_names:
                        - '1'
                      body_names:
                        - '1'
                        - '2'
                        - '3'
                      buttons: []
                  - name: inscricao_confirmada
                    language: pt_BR
                    category: UTILITY
                    status: APPROVED
                    components:
                      - type: HEADER
                        format: TEXT
                        text: Inscrição confirmada
                      - type: BODY
                        text: >-
                          Olá, {{nome}}! Sua inscrição em {{evento}} está
                          confirmada para {{data}}.
                      - type: FOOTER
                        text: Equipe Exemplo
                      - type: BUTTONS
                        buttons:
                          - type: URL
                            text: Ver evento
                            url: https://exemplo.com/evento/{{1}}
                          - type: QUICK_REPLY
                            text: Recebi
                    parameter_format: NAMED
                    header_text: Inscrição confirmada
                    body_text: >-
                      Olá, {{nome}}! Sua inscrição em {{evento}} está confirmada
                      para {{data}}.
                    footer_text: Equipe Exemplo
                    parameters:
                      header: 0
                      body: 3
                      header_names: []
                      body_names:
                        - nome
                        - evento
                        - data
                      buttons:
                        - index: 0
                          text: Ver evento
                          url: https://exemplo.com/evento/{{1}}
        '404':
          description: Não encontrado
          content:
            application/json:
              schema:
                type: object
                description: Resposta de erro quando o canal não existe nesta conta.
                properties:
                  response:
                    type: boolean
                    description: Sempre `false` em caso de erro.
                  message:
                    type: string
                    description: >-
                      Identificador do erro (slug); é o campo a ser tratado pelo
                      cliente.
                  error:
                    type: string
                    description: Descrição legível do erro.
              example:
                response: false
                message: channel_model_not_found
                error: >-
                  No query results for model [App\Models\Channel]
                  9b2a1c3e-4d5f-6789-abcd-ef0123456789
        '422':
          description: Canal sem templates
          content:
            application/json:
              schema:
                type: object
                description: Resposta de erro quando o canal não oferece o recurso pedido.
                properties:
                  response:
                    type: boolean
                    description: Sempre `false` em caso de erro.
                  message:
                    type: string
                    description: >-
                      Identificador do erro (slug); é o campo a ser tratado pelo
                      cliente.
                  error:
                    type: string
                    description: Descrição legível do erro.
                  capability:
                    type: string
                    description: Recurso que o canal não oferece; aqui, `templates`.
                    enum:
                      - templates
                      - typing
              example:
                response: false
                message: channel_capability_not_supported
                error: This channel does not support templates.
                capability: templates
        '424':
          description: Provedor não listou os templates
          content:
            application/json:
              schema:
                type: object
                description: >-
                  Resposta de erro quando o provedor recusa a consulta dos
                  templates; tente de novo mais tarde.
                properties:
                  response:
                    type: boolean
                    description: Sempre `false` em caso de erro.
                  message:
                    type: string
                    description: >-
                      Identificador do erro (slug); é o campo a ser tratado pelo
                      cliente.
                  error:
                    type: string
                    description: Descrição legível do erro.
              example:
                response: false
                message: channel_templates_unavailable
                error: The provider did not list the templates.
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.