> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.callix.dev.br/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.callix.dev.br/_mcp/server.

# Usando a API para consultar templates de WhatsApp

Para consultar templates de WhatsApp usando a API é preciso utilizar a interface do sistema para gerar um\
[token de acesso](/introducao/visao-geral#autenticação) da API.

Cumprindo esse requisito, siga os passos descritos abaixo:

## 1. Listar todos os templates

Este endpoint retorna todos os templates de WhatsApp cadastrados no sistema.

#### Exemplo de chamada:

```bash
curl -X GET "https://sua-conta.callix.com.br/api/v1/chat_outbound_templates" \
  -H "Authorization: Bearer SEU_TOKEN"
```

#### Exemplo de resposta:

```json
{
  "data": [
    {
      "id": 1,
      "type": "chat_outbound_templates",
      "attributes": {
        "name": "template_exemplo",
        "category": "MARKETING",
        "status": "approved",
        "is_configured": true
      }
    },
    {
      "id": 2,
      "type": "chat_outbound_templates",
      "attributes": {
        "name": "template_utilidade",
        "category": "UTILITY",
        "status": "approved",
        "is_configured": true
      }
    }
  ]
}
```

A resposta inclui um array com todos os templates cadastrados e suas informações.

## 2. Consultar um template específico

Este endpoint retorna informações detalhadas de um template específico usando seu ID.

#### Exemplo de chamada:

```bash
curl -X GET "https://sua-conta.callix.com.br/api/v1/chat_outbound_templates/1" \
  -H "Authorization: Bearer SEU_TOKEN"
```

#### Exemplo de resposta:

```json
{
  "data": {
    "id": 1,
    "type": "chat_outbound_templates",
    "attributes": {
      "name": "template_exemplo",
      "category": "MARKETING",
      "status": "approved",
      "is_configured": true
    }
  }
}
```

## Atributos

| Atributo        | Tipo    | Descrição                                  |
| --------------- | ------- | ------------------------------------------ |
| `name`          | string  | Nome do template                           |
| `category`      | enum    | Categoria do template (veja tabela abaixo) |
| `status`        | enum    | Status do template (veja tabela abaixo)    |
| `is_configured` | boolean | Define se o template está configurado      |

### Valores possíveis para `category`:

| Valor            | Descrição    |
| ---------------- | ------------ |
| `UTILITY`        | Utilidade    |
| `MARKETING`      | Marketing    |
| `AUTHENTICATION` | Autenticação |

### Valores possíveis para `status`:

| Valor              | Descrição            |
| ------------------ | -------------------- |
| `in_analysis`      | Em análise           |
| `approved`         | Aprovado             |
| `disapproved`      | Reprovado            |
| `in_appeal`        | Em apelação          |
| `pending_deletion` | Exclusão pendente    |
| `deleted`          | Excluído no provedor |
| `disabled`         | Inativo              |
| `paused`           | Pausado              |
| `limit_exceeded`   | Limite excedido      |
| `error`            | Erro                 |

> **Note**
>
> Apenas templates com status `approved` (aprovado) podem ser utilizados para envio de mensagens.