API: elencare e inviare modelli WhatsApp
Due endpoint permettono al tuo software di usare i tuoi modelli WhatsApp. GET /api/v1/whatsapp/templates elenca i tuoi modelli approvati e POST /api/v1/whatsapp/send-template ne invia uno a un cliente dal tuo numero predefinito. Entrambi richiedono una chiave con accesso WhatsApp.
- Dove
- Ask Menuthere support for a key
- Piano
- Richiede un numero WhatsApp Business collegato, disponibile dal piano Pro.
- Aggiornato
Elenca i tuoi modelli
curl 'https://menuthere.com/api/v1/whatsapp/templates' -H 'Authorization: Bearer ck_live_YOUR_KEY'
Restituisce i modelli approvati sul tuo numero predefinito, così conosci il nome esatto e quanti valori richiede ciascuno.
| Campo | Significato |
|---|---|
| name, language | Il nome del modello e il codice della lingua. |
| category, status | Categoria, ad esempio MARKETING o UTILITY. Lo stato è APPROVED. |
| body_variables | Quanti valori {{n}} richiede il corpo. |
| has_header, header_format | Se c'è un'intestazione, e TEXT, IMAGE, VIDEO o DOCUMENT. |
Invia un modello
POST /api/v1/whatsapp/send-template con un corpo JSON. Il messaggio parte dal tuo mittente predefinito, impostato in Più numeri e numero principale. Non puoi scegliere il numero nella chiamata.
| Campo | Obbligatorio | Cos'è |
|---|---|---|
| to | Sì | Il numero del cliente con prefisso internazionale. |
| template_name | Sì | Il nome preso dalla chiamata dell'elenco. |
| language | No | Se lo ometti, viene ricavato dal modello approvato. |
| body_params | No | Elenco di valori per {{1}}, {{2}} e così via, in ordine. |
| header_params | No | Elenco di valori per un'intestazione di testo. |
| header_media_url, header_media_type | No | Un link e image, video o document per un'intestazione multimediale. |
| button_params | No | Elenco di valori per un pulsante con URL dinamico. |
| idempotency_key | No | Un riferimento che scegli tu. Funzionano anche id e un'intestazione Idempotency-Key. |
Un invio riuscito restituisce ok: true, il message_id, il numero to e status: "sent". Se invii di nuovo la stessa chiave di idempotenza, ricevi il primo risultato con duplicate: true e nulla viene inviato due volte. Un invio fallito rilascia la chiave così puoi riprovare.
Errori e limiti
| Stato | `error` | Significato |
|---|---|---|
| 400 | missing_fields, invalid_json, invalid_number, template_error | Manca un campo obbligatorio, il numero sembra sbagliato, oppure il modello non è adatto ai valori che hai inviato. |
| 404 | template_not_found | Nessun modello approvato con quel nome sul tuo numero predefinito. |
| 409 | recipient_opted_out | Il cliente ha risposto STOP. Non viene inviato alcun messaggio. |
| 409 | in_progress | Una richiesta con la stessa chiave di idempotenza è ancora in corso. |
| 412 | no_whatsapp_number | Non è collegato alcun numero WhatsApp predefinito. |
| 429 | daily_limit_reached, rate_limited | Il limite giornaliero WhatsApp del tuo numero è esaurito, oppure la chiave ha superato il suo limite di richieste. |
| 502 | send_failed | WhatsApp non è raggiungibile. Riprova. |
Domande
Posso inviare un normale messaggio di testo tramite l'API?
Scriverà a chi ha rifiutato i messaggi?
Vedi anche
Non lo trovi? Scrivi a [email protected] o chatta con noi, dalle 9 alle 21.Centro assistenzaPrezzimenuthere.com