Digitalk Developers
  1. WhatsApp oficial
Raiz
  • 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
      • Tipos de relacionamento disponíveis
      • Listar relacionamentos de uma empresa (ambas as direções)
      • 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)
  • Workflow
    • Workflow - Overview
    • Tickets
      • Workflow - Tickets
      • Detalhe completo do ticket (mensagens, SLA, fases, customer, empresa, business)
      • Criar ticket (básico, com integração CRM opcional)
      • Criar ticket com auto-vínculo / criação de customer via contato
      • 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
    • 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
      • Catálogo de eventos disponíveis
      • 📨 [Contrato] Evento entregue na sua URL
    • 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
  • Configurações
    • Canais
      • WhatsApp oficial
        • Listar conexões de WhatsApp (a tela Canais › WhatsApp oficial)
          GET
        • Listar números disponíveis de uma WABA
          GET
        • Criar conexão de WhatsApp oficial
          POST
        • Conectar o número oficial (ativar a conexão)
          POST
      • 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)
        • Criar template HSM (+ Novo modelo)
        • Detalhar template
        • Atualizar template
        • Excluir template
        • Sincronizar templates com a Meta
        • Upload de mídia para o header do template
      • 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
  1. WhatsApp oficial

Listar conexões de WhatsApp (a tela Canais › WhatsApp oficial)

GET
{{baseURL}}/api/v3/settings/channels-gateway/whatsapp
Última modificação:2026-08-14 20:09:25
Retorna as conexões de WhatsApp do tenant — é exatamente o que popula a tela
Configurações › Canais › WhatsApp oficial.
Cada item traz a configuração do canal (status, createdAt), a conta WhatsApp
(number, phoneAnalytics, ids da Meta em pontalTechWhatsAppAccount) e, quando
houver, os departamentos/bots vinculados em links — o api-core resolve o nome de
cada vínculo a partir do referenceId.
Use pra:
Descobrir quais números oficiais estão cadastrados e conectados
Pegar o id (channelConfigId) pra usar em /whatsapp/official/connect e no sync de templates
Pegar o wabaId pra filtrar templates ou listar números da WABA
Checar saúde do número (phoneAnalytics.qualityRating, status)
Filtre por broker=pontal-tech para ver só as contas oficiais. Sem o filtro,
vêm também as conexões não-oficiais (broker bee-app).

Requisição

Parâmetros de Consulta

Parâmetros Header

Códigos de solicitação

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --globoff 'https://api-{tenant}.digitalk.com.br/api/v3/settings/channels-gateway/whatsapp?broker=pontal-tech&channel=whatsapp' \
--header 'api-key: API_TOKEN (disponível no database da plataforma)'

Respostas

🟢200OK
application/json
Conexões de WhatsApp do tenant.
Bodyapplication/json

Exemplo
[
    {
        "id": "3f2a91c4-7b60-4d15-9a2e-1c8d5e0b7411",
        "name": "Atendimento Comercial",
        "description": null,
        "broker": "pontal-tech",
        "channel": "whatsapp",
        "status": "active",
        "bannedAt": null,
        "restrictedAt": null,
        "createdAt": "2026-04-28T12:14:38.446Z",
        "inactivatedAt": null,
        "companyToken": "9f3c1a7e5d2b48c0a1e6f70b2c4d8e91",
        "links": [
            {
                "id": "5a1e73c9-84b2-4f60-93d7-6e0b1a2c8d94",
                "referenceId": "c14b8e07-3f52-4a91-8d60-7b2e5c9a1f38",
                "direction": "active",
                "channelConfigId": "3f2a91c4-7b60-4d15-9a2e-1c8d5e0b7411",
                "name": "Vendas"
            },
            {
                "id": "9d6f2b41-0c85-47e3-a129-4f8b3d7e6015",
                "referenceId": "20",
                "direction": "receptive",
                "channelConfigId": "3f2a91c4-7b60-4d15-9a2e-1c8d5e0b7411",
                "name": "Bot de triagem"
            }
        ],
        "whatsappAccount": {
            "id": "b7c40e28-5d13-49af-8e61-2f9a0c364d52",
            "referenceId": "3f2a91c4-7b60-4d15-9a2e-1c8d5e0b7411",
            "channelConfigId": "3f2a91c4-7b60-4d15-9a2e-1c8d5e0b7411",
            "broker": "pontal-tech",
            "number": "5511999990000",
            "phoneAnalytics": {
                "status": "CONNECTED",
                "nameStatus": "APPROVED",
                "qualityScore": "GREEN",
                "qualityRating": "GREEN",
                "throughputLevel": "STANDARD"
            },
            "wabaAnalytics": null,
            "pontalTechWhatsAppAccount": {
                "appId": "800000000000001",
                "wabaId": "900000000000001",
                "phoneNumberId": "700000000000001",
                "whatsAppAccountId": "b7c40e28-5d13-49af-8e61-2f9a0c364d52",
                "whatsappAccountType": "official",
                "coexistenceMode": false,
                "coexistenceHistoryMs": null
            }
        }
    },
    {
        "id": "8c5d0a37-2e94-41b6-b70f-5d3a9c1e8206",
        "name": "Número em cadastro",
        "description": null,
        "broker": "pontal-tech",
        "channel": "whatsapp",
        "status": "disconnected",
        "bannedAt": null,
        "restrictedAt": null,
        "createdAt": "2026-07-31T13:55:23.248Z",
        "inactivatedAt": null,
        "companyToken": "9f3c1a7e5d2b48c0a1e6f70b2c4d8e91",
        "whatsappAccount": {
            "id": "2b8e6f10-9a45-4c72-8531-0e7d4b2a9f63",
            "referenceId": "8c5d0a37-2e94-41b6-b70f-5d3a9c1e8206",
            "channelConfigId": "8c5d0a37-2e94-41b6-b70f-5d3a9c1e8206",
            "broker": "pontal-tech",
            "number": "5511988880000",
            "phoneAnalytics": {
                "status": "CONNECTED",
                "nameStatus": "PENDING_REVIEW",
                "qualityRating": "UNKNOWN",
                "throughputLevel": "STANDARD"
            },
            "wabaAnalytics": null,
            "pontalTechWhatsAppAccount": {
                "appId": "800000000000001",
                "wabaId": "900000000000002",
                "phoneNumberId": "700000000000002",
                "whatsAppAccountId": "2b8e6f10-9a45-4c72-8531-0e7d4b2a9f63",
                "whatsappAccountType": "official",
                "coexistenceMode": false,
                "coexistenceHistoryMs": null
            }
        }
    }
]
🟠401Não Autorizado
🟠403Proibido
🔴500Erro Interno
Modificado em 2026-08-14 20:09:25
Página anterior
Reprocessar TODAS as entregas com falha
Próxima página
Listar números disponíveis de uma WABA
Built with