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 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.
| Campo | Significado |
|---|---|
| name, language | O nome do modelo e o código do idioma. |
| category, status | Categoria, como MARKETING ou UTILITY. O status é APPROVED. |
| body_variables | Quantos valores {{n}} o corpo precisa. |
| has_header, header_format | Se 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.
| Campo | Obrigatório | O que é |
|---|---|---|
| to | Sim | O número do cliente com o código do país. |
| template_name | Sim | O nome que veio da chamada de listagem. |
| language | Não | Buscado no modelo aprovado se você o omitir. |
| body_params | Não | Lista de valores para {{1}}, {{2}} e assim por diante, em ordem. |
| header_params | Não | Lista de valores para um cabeçalho de texto. |
| header_media_url, header_media_type | Não | Um link e image, video ou document para um cabeçalho de mídia. |
| button_params | Não | Lista de valores para um botão de URL dinâmico. |
| idempotency_key | Não | Uma 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 |
|---|---|---|
| 400 | missing_fields, invalid_json, invalid_number, template_error | Falta um campo obrigatório, o número parece errado, ou o modelo não combina com os valores enviados. |
| 404 | template_not_found | Nenhum modelo aprovado com esse nome no seu número padrão. |
| 409 | recipient_opted_out | O cliente respondeu STOP. Nenhuma mensagem é enviada. |
| 409 | in_progress | Uma requisição com a mesma chave de idempotência ainda está em andamento. |
| 412 | no_whatsapp_number | Nenhum número de WhatsApp padrão está conectado. |
| 429 | daily_limit_reached, rate_limited | O limite diário de WhatsApp do seu número acabou, ou a chave passou do limite de requisições. |
| 502 | send_failed | Não foi possível alcançar o WhatsApp. Tente de novo. |
Perguntas
Posso enviar uma mensagem de texto normal pela API?
Ela envia mensagem a quem cancelou o recebimento?
Relacionados
Não encontrou? Escreva para [email protected] ou fale com a gente no chat, das 9h às 21h.Central de ajudaPreçosmenuthere.com