Skip to main content
Endpoint · GET /quick-replies
Endpoint de somente consulta: devolve informação e não modifica nada. Não é enviado dentro do array actions — é chamado direto.
Devolve o catálogo de respostas rápidas do negócio, em ordem alfabética e paginado por cursor. Cada item traz apenas o name, e esse é o valor que depois é passado em quick_reply.name ao montar uma ação de envio. O catálogo não expõe o conteúdo da resposta rápida (o shape de suas actions não é incluído): serve para descobrir quais nomes existem, não para inspecionar o que cada uma envia. Parâmetros
  • slug — slug do negócio na rota, sem diferenciar maiúsculas. Deve coincidir com o negócio do token. Obrigatório.
  • search — substring do nome, sem diferenciar maiúsculas (1 a 100 caracteres). O asterisco * funciona como curinga e corresponde a qualquer sequência de caracteres; os caracteres % e _ são buscados literalmente. Opcional.
  • cursor — cursor opaco devolvido pela página anterior em next_cursor. Omitir para pedir a primeira página. Não reutilizar cursores entre endpoints diferentes: mesmo que o formato seja idêntico, cada endpoint o interpreta sobre seu próprio conjunto de dados. Opcional.
  • limit — respostas rápidas por página. Por padrão 20, máximo 100. Opcional.

Resposta

has_more indica se restam resultados depois desta página. Enquanto for true, repetir a chamada passando o valor de next_cursor em ?cursor= e mantendo os mesmos filtros. Quando has_more for false, next_cursor vem como null.

Exemplo

É uma leitura pura: pede a primeira página do catálogo para ver quais nomes estão disponíveis. A chamada não envia nenhuma mensagem nem modifica nenhuma conversa — apenas devolve nomes, que depois alimentam uma ação de envio.
A página seguinte, com o cursor devolvido pela resposta anterior:

Erros

Veja o catálogo completo em Erros. O name que esta consulta devolve é exatamente o consumido pelas ações de envio: Enviar mensagem no modo resposta rápida (quick_reply: { "name": ... }) e Enviar resposta rápida ou template, que envia a resposta rápida com a janela de 24h aberta e o template se estiver fechada. O nome é comparado sem diferenciar maiúsculas, mas é melhor copiá-lo exatamente como vem do catálogo.