50% de desconto com o código BLACKFRIDAY5020% de desconto com o código BLACKFRIDAY20
Integrações e APIGrowth / Pro ou superior

API: listar e enviar modelos de WhatsApp

Dois endpoints permitem que seu software use seus modelos de WhatsApp. GET /api/v1/whatsapp/templates lista seus modelos aprovados e POST /api/v1/whatsapp/send-template envia um a um cliente pelo seu número padrão. Os dois precisam de uma chave com acesso WhatsApp.

Onde
Ask Menuthere support for a key
Plano
Precisa de um número do WhatsApp Business conectado, o que começa no Starter / Pro.
Atualizado

Liste seus modelos

curl 'https://menuthere.com/api/v1/whatsapp/templates' -H 'Authorization: Bearer ck_live_YOUR_KEY'

Retorna os modelos aprovados no seu número padrão, para você saber o nome exato e quantos valores cada um precisa.

CampoSignificado
name, languageO nome do modelo e o código do idioma.
category, statusCategoria, como MARKETING ou UTILITY. O status é APPROVED.
body_variablesQuantos valores {{n}} o corpo precisa.
has_header, header_formatSe há cabeçalho, e TEXT, IMAGE, VIDEO ou DOCUMENT.

Envie um modelo

POST /api/v1/whatsapp/send-template com um corpo JSON. A mensagem sai pelo seu remetente padrão, definido em Vários números e o número principal. Você não pode escolher o número na chamada.

CampoObrigatórioO que é
toSimO número do cliente com o código do país.
template_nameSimO nome que veio da chamada de listagem.
languageNãoBuscado no modelo aprovado se você o omitir.
body_paramsNãoLista de valores para {{1}}, {{2}} e assim por diante, em ordem.
header_paramsNãoLista de valores para um cabeçalho de texto.
header_media_url, header_media_typeNãoUm link e image, video ou document para um cabeçalho de mídia.
button_paramsNãoLista de valores para um botão de URL dinâmico.
idempotency_keyNãoUma referência que você escolhe. id e um cabeçalho Idempotency-Key também funcionam.

Um envio bem-sucedido retorna ok: true, o message_id, o número to e status: "sent". Se você enviar a mesma chave de idempotência de novo, recebe o primeiro resultado com duplicate: true e nada é enviado duas vezes. Um envio que falha libera a chave para você tentar de novo.

Erros e limites

Status`error`Significado
400missing_fields, invalid_json, invalid_number, template_errorFalta um campo obrigatório, o número parece errado, ou o modelo não combina com os valores enviados.
404template_not_foundNenhum modelo aprovado com esse nome no seu número padrão.
409recipient_opted_outO cliente respondeu STOP. Nenhuma mensagem é enviada.
409in_progressUma requisição com a mesma chave de idempotência ainda está em andamento.
412no_whatsapp_numberNenhum número de WhatsApp padrão está conectado.
429daily_limit_reached, rate_limitedO limite diário de WhatsApp do seu número acabou, ou a chave passou do limite de requisições.
502send_failedNão foi possível alcançar o WhatsApp. Tente de novo.
Bom saberTodo envio pela API é uma mensagem normal de WhatsApp, então a Meta cobra por ele como por qualquer outro. Veja Quanto custam as mensagens de WhatsApp. Um modelo precisa estar aprovado para ser enviado. Veja Modelos de mensagem.

Perguntas

Posso enviar uma mensagem de texto normal pela API?
Não. A API envia só modelos aprovados, que também chegam a clientes fora da janela de 24 horas.
Ela envia mensagem a quem cancelou o recebimento?
Não. Um cliente que respondeu STOP é ignorado e a chamada retorna recipient_opted_out.

Não encontrou? Escreva para help@mail.menuthere.com ou fale com a gente no chat, das 9h às 21h.Central de ajudaPreçosmenuthere.com