Seu sistema
CRM, ERP, automação ou produto próprio inicia a operação.
Aparência
API pública · v1
Conversas que fluem para além da interface.
Conecte CRM, automações e operações próprias aos recursos de chat, etiquetas, setores e usuários da Underchat com um contrato autenticado por conta e executor.
Base URL
https://api-public.underchat.com.br/v101 curl --request GET \
02 --url "https://api-public.underchat.com.br/v1/chat?status=my_chats" \
03 --header "keyapi: uc_live_••••••••" \
04 --header "x-underchat-user-id: 0195…"
05
06 HTTP/1.1 200 OK
07 {
08 "data": [
09 { "chat_id": "0195…" }
10 ]
11 }98operações autenticadas documentadas pelo OpenAPI
4domínios: chat, etiquetas, setores e usuários
2headers separam a conta do usuário executor
Mapa de integração
Do sistema externo ao atendimento, sem atalhos ocultos.
API Underchat
A chave identifica a conta; o header de usuário define o executor.
Operação
Mensagens e organização chegam ao mesmo fluxo do painel.
Atenda, envie, transfira.
Liste conversas, consulte mensagens, gerencie contatos e execute o ciclo completo de atendimento.
Ver fluxo completo ↗02 / EtiquetasContexto visível.
Modele etiquetas, cores e status para manter automações e operadores na mesma linguagem.
Organizar etiquetas ↗03 / SetoresRoteamento preciso.
Consulte equipes, crie áreas e direcione cada conversa ao destino certo.
Configurar setores ↗04 / UsuáriosIdentidade explícita.
Sincronize pessoas, papéis, horários, setores e canais com isolamento rigoroso por conta.
Gerenciar usuários ↗Contrato sempre atual
Os campos que a API aceita, direto da fonte.
A referência interativa é renderizada do OpenAPI publicado pela própria API. Tipos, obrigatoriedade, exemplos e respostas acompanham cada endpoint.
Abrir referência da API →