Sign inGet started

Présentation de WhatsApp

Bird WhatsApp utilise la même plateforme et les mêmes clés API que Bird Email et Bird SMS. Appelez l'hôte régional correspondant à la clé API (https://us1.platform.bird.com ou https://eu1.platform.bird.com). Les endpoints WhatsApp se trouvent sous /v1/whatsapp/….
Les envois initiés par l'entreprise utilisent un template de message pré-approuvé. Envoyez-en un depuis le catalogue géré de Bird, qui ne nécessite aucun numéro à vous et envoie depuis un expéditeur géré par Bird, ou connectez un numéro à vous et envoyez vos propres templates depuis celui-ci. Les contacts peuvent envoyer un message à un numéro à vous, et Bird enregistre ces messages entrants aux côtés des messages sortants.

Comment fonctionne l'envoi

Envoyez un message WhatsApp avec POST /v1/whatsapp/messages : un destinataire, un template, et des tags et métadonnées optionnels. Nous validons la requête et renvoyons 202 Accepted avec un identifiant de message. La facturation et la livraison se font de manière asynchrone. L'API n'a pas d'endpoint batch : envoyez une requête par message.
Trois principes structurent l'ensemble de l'API :
  • Envoi et livraison sont deux étapes distinctes. Un 202 signifie que Bird a accepté le message. L'appareil du destinataire ne le reçoit qu'après que le message a progressé à travers WhatsApp jusqu'à un résultat de livraison terminal. Un accusé de lecture apparaît sous forme d'horodatage read_at et d'événement whatsapp.read ; il ne modifie pas le statut du message.
  • Chaque envoi initié par l'entreprise utilise un template. Fournissez le slug du template, un language optionnel, et les valeurs de ses variables. Un message de service, c'est-à-dire du texte libre ou un média, n'atteint un contact que dans la fenêtre de 24 heures ouverte par son propre message, et uniquement depuis un numéro appartenant à votre espace de travail. Voir Envoi de messages WhatsApp.
  • Catégorie et destination déterminent l'expéditeur et le prix. Chaque template a une catégorie authentication, utility ou marketing. Un template géré s'envoie depuis le numéro Bird de sa catégorie, et ne comporte donc pas de champ from ; tout autre envoi désigne son propre expéditeur. Le prix dépend aussi du pays du destinataire, et le message est facturé en deux étapes : les frais de Bird pendant que Bird traite l'envoi, et la part de Meta à la livraison du message. Voir Coût et facturation.

L'application WhatsApp dans le dashboard

Dans le dashboard, WhatsApp est l'une des applications de canal de l'espace de travail. Ses pages :
PageÀ quoi elle sert
MessagesMessages entrants et sortants, avec contenu, événements et détails de livraison par message
MetricsMétriques de livraison sortante et volume de messages entrants
TemplatesLes templates que vous pouvez envoyer, gérés et les vôtres : nom, langue, catégorie et aperçu rendu
NumbersNuméros d'expédition gérés par Bird et, dès que le déploiement vous concerne, vos propres numéros

Visibilité

Bird enregistre une chronologie pour chaque message. Les chronologies sortantes incluent les événements accepted, sent, delivered, read et failure. Une chronologie entrante enregistre le moment où Bird a reçu le message.
  • Lire une chronologie : GET /v1/whatsapp/messages/{message_id}/events renvoie les événements du message. La page Messages affiche la même chronologie. Voir Événements WhatsApp.
  • S'abonner aux événements de livraison sortante : envoyez les événements publics whatsapp.accepted, whatsapp.sent, whatsapp.delivered, whatsapp.read, whatsapp.failed et whatsapp.rejected vers un endpoint webhook.
  • Consulter les métriques agrégées : la page Metrics dispose d'onglets Outbound et Inbound séparés.

Réception

Bird stocke les messages entrants envoyés à un numéro appartenant à votre espace de travail, avec un statut received. Les numéros gérés par Bird ne reçoivent pas de messages pour votre espace de travail. Retrouvez les messages sur la page Messages ou avec GET /v1/whatsapp/messages?direction=inbound. Le détail du message affiche le texte, les médias pris en charge, les documents, les localisations et les types de contenu que Bird ne peut pas rendre. Les médias reçus sont disponibles pendant 30 jours.
L'onglet Inbound de la page Metrics affiche une série temporelle Messages received et une ventilation By phone number. Pour agir sur chaque message entrant dès son arrivée, abonnez-vous plutôt à l'événement webhook whatsapp.received ; voir Événements WhatsApp.
Certains destinataires vous demandent d'arrêter. Enregistrez cela comme une suppression limitée à un compte professionnel ou comme un opt-out au niveau de la personne couvrant tout l'espace de travail, et Bird bloque les envois ultérieurs vers cette adresse dans les deux cas. Voir Opt-outs.

Étapes suivantes

PageCe qu'elle couvre
Envoi de messages WhatsAppL'API d'envoi : destinataire, template, composants, tags, modèle asynchrone
Messages de serviceLes neuf types de contenu, la fenêtre de service et l'envoi de médias par URL
RéceptionMessages entrants, récupération des médias et webhook whatsapp.received
TemplatesLe catalogue de templates, catégories et variables, et envoi par slug
Journal WhatsAppMessages entrants et sortants, contenu, statut et chronologies d'événements
ÉvénementsChronologies de messages et webhooks publics de livraison sortante
Opt-outsSuppressions limitées au compte, opt-outs à l'échelle de l'espace de travail et leur levée
Métriques WhatsAppPerformance de livraison sortante et volume de messages entrants
Limites de débitLe débit de base de chaque groupe, whatsapp_send inclus, et la gestion des 429