1. WhatsApp oficial
Khal Docs
  • Raiz
    • CRM
      • CRM — Overview
      • Genérico (data)
        • CRM - Genérico
        • Listar/filtrar registros (qualquer tabela do CRM)
        • Criar/atualizar registros (qualquer tabela do CRM)
        • Hard-delete (não permitido para tabelas company)
      • Empresas Relacionadas
        • CRM - Empresas relacionadas
        • Listar relacionamentos de uma empresa (ambas as direções)
        • Tipos de relacionamento disponíveis
        • Criar relacionamento entre duas empresas
        • Alterar o tipo do relacionamento
        • Inativar relacionamento (reversível)
        • Excluir relacionamento (hard-delete)
      • Ticket ↔ Empresa
        • CRM - Ticket <-> Empresa
        • Empresas elegíveis para o ticket
        • Vincular / trocar a empresa do ticket
      • Templates
        • CRM - Templates
        • Listar templates do tenant (apenas IDs, sem fields)
        • Detalhe completo do template (com fields)
        • Pesquisa formatada por scope (CRMSearchResult)
      • Empresas do cliente
        • Listar tipos de relacionamento
        • Listar empresas de um cliente
        • Vincular empresa ao cliente
        • Trocar a empresa principal
        • Alterar tipo de relacionamento
        • Inativar vínculo
        • Reativar vínculo
        • Excluir vínculo
    • Workflow
      • Workflow - Overview
      • Tickets
        • Workflow - Tickets
        • Criar ticket com auto-vínculo / criação de customer via contato
        • Detalhe completo do ticket (mensagens, SLA, fases, customer, empresa, business)
        • Criar ticket (básico, com integração CRM opcional)
        • Movimentar ticket entre fases (ou finalizar)
        • Atualizar dados do ticket (nome, descrição, valor)
        • Vincular cliente CRM a um ticket existente
        • Adicionar nota ou mensagem ao ticket
        • Atribuir ou transferir o responsável do ticket
      • Workspaces & Workflows
        • Workflow - Workspaces & Workflows
        • Listar workspaces e workflows acessíveis ao usuário
        • Listar fases de um workflow
        • Listar tickets de uma ou mais fases (paginado)
    • Webhooks
      • Eventos
        • 📨 [Contrato] Evento entregue na sua URL
        • Catálogo de eventos disponíveis
      • Assinaturas
        • Listar webhooks cadastrados
        • Criar webhook (o secret aparece UMA única vez)
        • Testar conectividade de uma URL
        • Detalhar webhook
        • Atualizar webhook
        • Ativar/desativar webhook (toggle)
        • Remover webhook (soft delete)
      • Entregas
        • Log de entregas de uma assinatura
        • Reprocessar uma entrega
        • Reprocessar TODAS as entregas com falha
      • Integrações
        • Voz IA (ElevenLabs)
          • Criar ou atualizar a integração de Voz IA
          • Consultar a integração de Voz IA
          • Alterar a integração de Voz IA (secret, toggle, allowlist)
          • Remover a integração de Voz IA
          • Webhook pós-chamada (chamado pelo provedor de voz)
    • Configurações
      • Canais
        • WhatsApp oficial
          • Listar conexões de WhatsApp (a tela Canais › WhatsApp oficial)
          • Listar números disponíveis de uma WABA
          • Criar conexão de WhatsApp oficial
          • Conectar o número oficial (ativar a conexão)
        • Telefonia
          • Anexar gravação de ligação (telefonia de terceiros)
          • Registrar CSAT de ligação
          • Consultar status da gravação enviada
      • Templates
        • WhatsApp oficial
          • Listar templates HSM (a tela Templates › WhatsApp oficial)
            GET
          • Criar template HSM (+ Novo modelo)
            POST
          • Detalhar template
            GET
          • Atualizar template
            PUT
          • Excluir template
            DELETE
          • Sincronizar templates com a Meta
            POST
          • Upload de mídia para o header do template
            POST
        • RCS
          • Listar templates de RCS
      • Base de dados
        • Modelo de colunas do CSV
        • Importar base (CSV) para uma tabela do CRM
        • Acompanhar as importações (validar o resultado)
        • Erros de uma importação
        • Exportar os erros em planilha
    • Raiz
      • Workflow
        • Tarefas
          • Criar tarefa
          • Listar tarefas
          • Resumo de tarefas
          • Consultar tarefa
          • Editar tarefa
          • Concluir tarefa
          • Cancelar (excluir) tarefa
          • Silenciar alarme
          • Tarefas do ticket
  • Esquemas
    • LoginRequest
    • FilterOperator
    • WebhookSubscription
    • ClienteEmpresaTipo
    • LoginResponse
    • FilterCondition
    • WebhookSubscriptionResumo
    • ClienteEmpresa
    • Error
    • Pagination
    • WebhookDelivery
    • ErroRegra
    • FilterRequest
    • WebhookEventEnvelope
    • FilterResponse
    • SetMethod
    • SetRequest
    • DeleteRequest
    • SuccessEnvelope
    • ErrorEnvelope
    • Empresa
    • EmpresaResumo
    • EmpresaRelacionadaCreate
    • EmpresaRelacionada
    • TicketInfoResponse
  1. WhatsApp oficial

Listar templates HSM (a tela Templates › WhatsApp oficial)

GET
/api/v3/settings/channels-gateway/manager/templates
Lista paginada dos templates do tenant — é o que popula a tela
Configurações › Templates › WhatsApp oficial.
O retorno é o envelope { items, total, offset, limit } (não é array puro).
Cada item traz o conteúdo completo do HSM em content.components, então dá pra
renderizar o preview sem uma segunda chamada.
Mapa tela → campo:
Coluna da telaCampo
Nomename
Categoriacontent.category
WABAwabaName
Criado emcreatedAt
Atualizado emupdatedAt
Qualidadeanalytics.quality_score
Statusstatus
Use pra:
Montar a listagem de modelos aprovados antes de disparar campanha
Achar o id de um template pra usar em envio ativo
Auditar o que está rejected / in-review na Meta
Para a tela de WhatsApp oficial, filtre sempre por
channel=whatsapp&contentType=hsm — sem isso vêm também templates de RCS e SMS.
Este endpoint também atende RCS. Use channel=rcs e o contentType
correspondente (text, rich-card ou carousel) — o formato do content muda
conforme o tipo. Veja Configurações › Templates › RCS.

Requisição

Parâmetros de Consulta

Parâmetros Header

Respostas

🟢200OK
application/json
Página de templates.
Bodyapplication/json

🟠401Não Autorizado
🟠403Proibido
🔴500Erro Interno
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/v3/settings/channels-gateway/manager/templates?channel=whatsapp&contentType=hsm&status=active&channelConfigId=undefined&offset=0&limit=8' \
--header 'api-key: {{api-key}}'
Response Response Example
200 - Primeira página com 3 modelos (48 no total)
{
    "items": [
        {
            "id": "d41a8c76-3b52-4e09-9f18-6c7b204ea351",
            "name": "continuacao_conversa",
            "description": null,
            "companyToken": "9f3c1a7e5d2b48c0a1e6f70b2c4d8e91",
            "externalId": "600000000000001",
            "appId": "800000000000001",
            "wabaId": "900000000000001",
            "status": "active",
            "channel": "whatsapp",
            "contentType": "hsm",
            "content": {
                "type": "hsm",
                "category": "marketing",
                "language": "pt_BR",
                "components": [
                    {
                        "text": "Olá! Tudo bem?\n\nMeu nome é {{agente}} e faço parte da equipe.\n\nA partir de agora, vou dar continuidade ao seu atendimento.\n\nPodemos continuar a conversa?",
                        "type": "body",
                        "variables": [
                            {
                                "example": "João",
                                "parameterName": "agente"
                            }
                        ]
                    }
                ],
                "parameterFormat": "named"
            },
            "variables": [
                {
                    "type": "body",
                    "default": "João",
                    "parameterName": "agente"
                }
            ],
            "reason": null,
            "analytics": {},
            "activeAt": "2026-07-30T20:39:03.404Z",
            "archivedAt": null,
            "deletedAt": null,
            "inactiveAt": null,
            "inReviewAt": null,
            "rejectedAt": null,
            "flaggedAt": null,
            "pausedAt": null,
            "lockedAt": null,
            "inAppealAt": null,
            "limitExceededAt": null,
            "pendingDeletionAt": null,
            "reinstatedAt": null,
            "createdAt": "2026-07-30T20:30:31.938Z",
            "updatedAt": "2026-07-30T20:39:03.406Z",
            "wabaName": "Atendimento Comercial"
        },
        {
            "id": "f0928d15-6a34-4b7c-8e51-93df20a6b478",
            "name": "boletim_mensal",
            "description": null,
            "companyToken": "9f3c1a7e5d2b48c0a1e6f70b2c4d8e91",
            "externalId": "600000000000002",
            "appId": "800000000000001",
            "wabaId": "900000000000002",
            "status": "active",
            "channel": "whatsapp",
            "contentType": "hsm",
            "content": {
                "type": "hsm",
                "category": "marketing",
                "language": "pt_BR",
                "components": [
                    {
                        "type": "header",
                        "example": "4::aW1hZ2UvanBlZw==:EXEMPLO_HANDLE_DE_MIDIA_DA_META",
                        "subType": "image",
                        "fileName": "boletim.jpg"
                    },
                    {
                        "text": "No boletim deste mês reunimos conteúdos estratégicos para apoiar decisões que impactam a sua operação.\n⭐ Acesse agora os destaques.",
                        "type": "body"
                    },
                    {
                        "type": "buttons",
                        "buttons": [
                            {
                                "url": "https://links.suaempresa.com.br/r/{{1}}",
                                "text": "Acessar o Boletim",
                                "type": "url",
                                "example": "https://links.suaempresa.com.br/r/exemplo",
                                "redirectId": "7e21b940-8c53-4f6a-b018-2d5934ea7c61"
                            }
                        ]
                    }
                ],
                "parameterFormat": "named"
            },
            "variables": [
                {
                    "type": "header",
                    "default": "https://storage.example.com/ms-channels-gateway/exemplo/media.jpeg",
                    "subType": "image"
                },
                {
                    "type": "button",
                    "index": 0,
                    "default": "https://links.suaempresa.com.br/r/",
                    "subType": "url",
                    "redirectId": "7e21b940-8c53-4f6a-b018-2d5934ea7c61"
                }
            ],
            "reason": null,
            "analytics": {},
            "activeAt": "2026-07-30T13:23:34.823Z",
            "archivedAt": null,
            "deletedAt": null,
            "inactiveAt": null,
            "inReviewAt": null,
            "rejectedAt": null,
            "flaggedAt": null,
            "pausedAt": null,
            "lockedAt": null,
            "inAppealAt": null,
            "limitExceededAt": null,
            "pendingDeletionAt": null,
            "reinstatedAt": null,
            "createdAt": "2026-07-29T14:11:31.612Z",
            "updatedAt": "2026-07-30T13:23:34.823Z",
            "wabaName": "Marketing"
        },
        {
            "id": "a35c7e10-42b8-4d96-8071-5eb3f9ca2d64",
            "name": "pesquisa_satisfacao",
            "description": null,
            "companyToken": "9f3c1a7e5d2b48c0a1e6f70b2c4d8e91",
            "externalId": "600000000000003",
            "appId": "800000000000001",
            "wabaId": "900000000000001",
            "status": "active",
            "channel": "whatsapp",
            "contentType": "hsm",
            "content": {
                "id": "600000000000003",
                "name": "pesquisa_satisfacao",
                "type": "hsm",
                "category": "marketing",
                "language": "pt_BR",
                "components": [
                    {
                        "text": "Obrigado por escolher a {{1}}. Avaliando seu último atendimento em {{2}}, numa escala de 0 a 10, o quanto você nos indicaria a um amigo?",
                        "type": "body",
                        "variables": [
                            "Empresa Exemplo",
                            "São Paulo"
                        ]
                    },
                    {
                        "type": "buttons",
                        "buttons": [
                            {
                                "text": "Sim",
                                "type": "quick_reply",
                                "index": 0
                            },
                            {
                                "text": "Não",
                                "type": "quick_reply",
                                "index": 1
                            }
                        ]
                    }
                ],
                "parameterFormat": "positional"
            },
            "variables": [
                {
                    "type": "body",
                    "default": "Empresa Exemplo"
                },
                {
                    "type": "body",
                    "default": "São Paulo"
                }
            ],
            "reason": null,
            "analytics": {
                "quality_score": "UNKNOWN"
            },
            "activeAt": "2026-07-20T12:55:41.548Z",
            "archivedAt": null,
            "deletedAt": null,
            "inactiveAt": null,
            "inReviewAt": null,
            "rejectedAt": null,
            "flaggedAt": null,
            "pausedAt": null,
            "lockedAt": null,
            "inAppealAt": null,
            "limitExceededAt": null,
            "pendingDeletionAt": null,
            "reinstatedAt": null,
            "createdAt": "2025-10-25T12:14:31.606Z",
            "updatedAt": "2026-07-20T12:55:41.551Z",
            "wabaName": "Atendimento Comercial"
        }
    ],
    "total": 48,
    "offset": 0,
    "limit": 8
}
Modificado em 2026-11-04 02:53:16
Página anterior
Consultar status da gravação enviada
Próxima página
Criar template HSM (+ Novo modelo)
Built with