VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa

Atendimento da mini-loja

Ajuda, reclamação, qualificação de revendedor, atendente humano e o assistente de compras da mini-loja do WhatsApp.

Esta seção reúne tudo o que o cliente usa para pedir ajuda na mini-loja do WhatsApp: a central de ajuda com perguntas frequentes e contatos, o envio de uma reclamação ou de uma qualificação de revendedor, o pedido para falar com uma pessoa e o chat com o assistente de compras. No fim, os links assinados que abrem a mídia de uma conversa exportada.

Todas as rotas usam o token da mini-loja no caminho (veja Mini-loja do WhatsApp); só os dois links de mídia usam um token assinado próprio.

Pontos-chave
  • A loja decide o que existe. Reclamação, qualificação de revendedor e atendente humano podem estar desligados. Leia a central de ajuda antes de mostrar os botões.
  • "Atendente disponível" depende do relógio. human_enabled é configuração; human_available diz se há alguém agora.
  • Solicitações são idempotentes. Reclamação e qualificação levam um submission_id (UUID) gerado por você: reenviar o mesmo devolve o mesmo protocolo.
  • O corpo é estrito. Nas solicitações, campo desconhecido é recusado com 400 invalid_support_request.
  • Quando um atendente assume, o assistente se cala. O turno do assistente responde human: true e o chat passa a ler as mensagens da pessoa.
  • Limites. Leituras (GET) da mini-loja têm um teto de 1.500 requisições por minuto por IP, e as escritas dividem um teto de 600 por minuto. Passou do limite: 429.

Como funciona

Ajuda→Reclamação ou revenda→Atendente→Assistente
  1. Ler a ajuda

    GET /support/{token} devolve FAQ, contatos e quais canais estão abertos agora.

  2. Registrar uma solicitação

    POST /support/{token}/complaints ou /reseller-leads gravam a solicitação e devolvem o protocolo.

  3. Falar com uma pessoa

    POST /support/{token}/handoff pede que um atendente assuma a conversa, ou manda o cliente abrir o WhatsApp da loja.

  4. Conversar com o assistente

    POST /intelligence/{token}/assist envia uma mensagem. GET /intelligence/{token}/inbox traz o que o atendente escreve.

Conceitos-chave

Protocolo

Uma reclamação gera um protocolo SAC- e uma qualificação gera um REV-, seguidos de 8 caracteres. O cliente guarda o protocolo para conferir depois com a loja. O atendimento humano não gera protocolo: ele acontece na conversa.

Atendimento humano

O atendente só assume uma conversa que já existe no WhatsApp da loja, ligada ao telefone do cliente. Visitante sem conversa é encaminhado para o WhatsApp da loja (contact_url). Quando ninguém da equipe responde a tempo, o chat do assistente recebe um aviso do próprio assistente.

O assistente

O assistente conversa e age sobre a mesma sacola e o mesmo catálogo do cliente. As respostas trazem effects, que dizem à tela o que atualizar, e cards, que desenham escolhas no chat. Detalhes em Assistente da loja.

Endpoints

MétodoRotaO que fazPágina
GET/api/v1/storefront/wa-coex/support/{token}Central de ajudaCentral de ajuda
POST/api/v1/storefront/wa-coex/support/{token}/complaintsRegistra uma reclamaçãoSolicitações de suporte
POST/api/v1/storefront/wa-coex/support/{token}/reseller-leadsRegistra uma qualificação de revendedorSolicitações de suporte
POST/api/v1/storefront/wa-coex/support/{token}/handoffPede um atendenteSolicitações de suporte
POST/api/v1/storefront/wa-coex/intelligence/{token}/assistMensagem ao assistenteAssistente da loja
GET/api/v1/storefront/wa-coex/intelligence/{token}/inboxMensagens do atendenteAssistente da loja
GET/api/v1/storefront/wa-coex/inbox-media/{token}Mídia de uma conversa (link assinado)Links de mídia
GET/api/v1/storefront/wa-coex/media-share/{token}Mídia de uma conversa (link compartilhável)Links de mídia

Erros comuns

  • Mostrar o botão sem checar a loja. Reclamação desligada responde 404 complaints_disabled; revenda desligada, 404 reseller_qualification_disabled.
  • Reusar o submission_id. Um UUID novo por formulário. Reusar o de uma reclamação anterior devolve o protocolo antigo em vez de criar uma nova.
  • Mandar um campo a mais. O corpo das solicitações é estrito; um campo desconhecido gera 400.
  • Esperar erro HTTP quando não há atendente. handoff sempre responde 200; leia status (accepted, redirect, unavailable).
  • Ignorar human: true. Se o turno do assistente volta com human: true, ele não respondeu de propósito. Mostre as mensagens do atendente.
  • Prazo curto no assistente. Um turno envolve o assistente processando a resposta e leva segundos.

Próximos passos

Central de ajuda
FAQ, contatos e canais abertos.
Solicitações de suporte
Reclamação, revenda e atendente.
Assistente da loja
Chat de compras e cartões.
Pedidos da mini-loja
Acompanhar e cancelar pedidos.
Anterior
Assinaturas e compras agendadas
Próxima
Central de ajuda da loja
Nesta página
  • Como funciona
  • Conceitos-chave
  • Protocolo
  • Atendimento humano
  • O assistente
  • Endpoints
  • Erros comuns
  • Próximos passos