Notify
Un seul appel pour joindre un utilisateur par push, SMS ou courriel
Gardez un profil pour chacun de vos utilisateurs, puis envoyez une seule fois. HonkIO essaie le push, puis le SMS, puis le courriel, ou l'ordre que vous choisissez, et s'arrête au premier canal qui livre. Le consentement est toujours vérifié sur chaque canal.
curl -X POST https://api.honkio.ca/v1/notify \
-H "Authorization: Bearer mk_test_YOUR_KEY" \
-H "Idempotency-Key: login-code-1042-2026-11-03" \
-H "Content-Type: application/json" \
-d '{
"user_id": "user_1042",
"text": "Your Acme code is 123456",
"subject": "Your Acme code",
"from": { "sms": "+1416XXXXXXX", "email": "hello@yourapp.ca" }
}'
# Response 202: { "id": "ntf_...", "status": "delivered", "channel": "sms", "attempts": [...], ... }Comment ça fonctionne
Trois étapes, les mêmes avec une clé de test et une clé de production.
- 1
Enregistrez un profil de destinataire
Enregistrez un numéro de téléphone, une adresse courriel et une langue pour chaque utilisateur avec PUT /v1/recipients/:user_id, sous votre propre identifiant d'utilisateur. Un utilisateur sans profil peut tout de même recevoir un push sur un appareil actif.
- 2
Envoyez une notification
Appelez POST /v1/notify avec l'identifiant de l'utilisateur et votre texte, ou un modèle. Indiquez vos expéditeurs SMS et courriel, et définissez channels pour changer l'ordre ou écarter un canal.
- 3
Lisez le résultat
La réponse, GET /v1/notifications/:id et les webhooks de notification donnent le canal qui l'a livrée et chaque tentative, avec sa raison.
Conçu pour les notifications transactionnelles
Des messages que votre produit envoie à une personne quand quelque chose s'est produit.
- Codes de connexion
- Essayez d'abord l'application, puis un texto, puis un courriel. Avec un Idempotency-Key, une nouvelle tentative renvoie la première notification et n'envoie jamais le code deux fois.
- Rappels de rendez-vous
- Joignez la personne là où elle peut l'être : un push dans l'application si elle l'a, sinon un texto ou un courriel, dans sa langue.
- Reçus
- Envoyez un seul modèle et chaque canal utilise sa propre partie : le push, le texto et le courriel se lisent chacun comme il se doit.
- Alertes
- Des alertes de compte et de sécurité qui passent au canal suivant quand un canal ne peut pas joindre la personne, avec chaque tentative consignée.
Ce que fait Notify
Une notification, une personne, le premier canal qui fonctionne.
- Votre ordre, chaque canal une fois
- Push, puis SMS, puis courriel par défaut. Définissez channels pour changer l'ordre ou écarter un canal. Chaque canal est essayé au plus une fois, et Notify s'arrête au premier qui livre.
- Profils de destinataires
- Un numéro de téléphone, une adresse courriel et une langue pour chaque utilisateur, sous votre propre identifiant d'utilisateur : le même que celui de ses appareils push.
- Modèles en français et en anglais
- Envoyez un modèle avec des variables et chaque canal envoie sa propre partie, dans la langue du profil sauf si vous en indiquez une.
- Chaque tentative consignée
- Chaque notification liste ses tentatives dans l'ordre, avec le canal, le résultat et la raison d'un canal sauté, refusé ou en échec, dans l'API et le tableau de bord.
- Webhooks
- notification.delivered survient quand un canal l'a livrée et notification.failed quand aucun ne l'a fait. Les deux portent les tentatives, sans le texte du message.
- Jamais d'envoi en double
- Envoyez un en-tête Idempotency-Key et une nouvelle tentative renvoie la première notification, en attente ou non. Elle n'envoie et ne facture jamais deux fois.
Le consentement est vérifié sur chaque canal
Un profil de destinataire contient des coordonnées. Ce n'est jamais un consentement.
- Un texto ou un courriel passe par les mêmes vérifications que les API de SMS et de courriel : consentement, désabonnements, suppressions, limites d'envoi, pauses et solde. Un canal qui refuse fait passer la notification au suivant.
- Enregistrer un numéro de téléphone ou une adresse courriel dans un profil n'est pas un consentement. Vous consignez le consentement comme pour tout autre envoi.
- Les notifications sont transactionnelles par défaut. Marquez un courriel comme commercial et il exige un consentement LCAP au dossier et porte un pied de page de désabonnement.
- Livrée veut dire qu'un canal l'a acceptée : un appareil a accepté le push, l'opérateur a accepté le texto ou le service de courriel a accepté le courriel. Un rebond ou un accusé d'échec reçu ensuite ne la renvoie jamais sur un autre canal.
Tarifs
Notify n'a pas de prix propre.
Une notification est facturée au prix normal du canal qui la livre : un push, un texto ou un courriel. Les tentatives qui passent au canal suivant ne sont pas facturées.
Ce qui a été facturé pour un push qu'aucun appareil n'a accepté, un texto refusé par l'opérateur ou un courriel refusé sur-le-champ est remboursé avant que le canal suivant soit essayé.
Où les données sont stockées
Les profils de destinataires sont stockés au Canada, à Montréal (ca-central-1), avec le reste des données de votre compte. Un profil est conservé jusqu'à ce que vous le supprimiez, et sa suppression efface aussi le texte des notifications de cet utilisateur.
Les requêtes peuvent être traitées sur une infrastructure hébergée aux États-Unis, et un push passe par les serveurs d'Apple ou de Google. Stocké au Canada ne veut pas dire traité uniquement au Canada.
Mode test
Commencez avec une clé de test.
Avec une clé de test, chaque canal fonctionne dans son propre mode test. Les profils sont gardés par mode, comme les consentements : une clé de test ne lit et n'écrit que des profils de test, et un profil de production n'existe pas pour elle.
Documentation
Guides et référence de Notify.
Questions
- Qu'est-ce que HonkIO Notify ?
- Notify est un seul appel d'API qui joint l'un de vos utilisateurs par push, SMS ou courriel. HonkIO essaie les canaux dans votre ordre, le push, puis le SMS, puis le courriel par défaut, et s'arrête au premier qui livre.
- Quand Notify cesse-t-il d'essayer des canaux ?
- Quand un canal accepte la notification : un appareil accepte le push, l'opérateur accepte le texto ou le service de courriel accepte le courriel. Un échec signalé ensuite, comme un rebond, ne la fait pas passer à un autre canal : une notification n'est jamais envoyée deux fois.
- Notify contourne-t-il les vérifications de consentement ?
- Non. Chaque texto ou courriel passe par les mêmes vérifications de consentement, de désabonnement, de suppression et de limites d'envoi que les API de SMS et de courriel, et un refus fait passer la notification au canal suivant. Un profil de destinataire n'est jamais un consentement.
- Combien coûte Notify ?
- Rien en soi. Une notification est facturée au prix normal du canal qui la livre, et les tentatives qui passent au canal suivant ne sont pas facturées. Les prix des canaux sont sur la page des tarifs, en dollars canadiens.
- Où les données des destinataires sont-elles stockées ?
- Au Canada, à Montréal (ca-central-1). Les requêtes peuvent être traitées sur une infrastructure hébergée aux États-Unis, et un push passe par les serveurs d'Apple ou de Google.
- Ai-je besoin d'un profil pour chaque utilisateur ?
- Seulement pour le joindre par SMS ou par courriel : le profil contient le numéro de téléphone et l'adresse courriel. Un utilisateur sans profil peut tout de même recevoir un push sur un appareil actif enregistré sous le même identifiant.
À lire aussi
- Notifications push
Push vers iOS, Android et les navigateurs depuis une seule API, avec chiffrement facultatif du contenu et repli par SMS en un seul appel.
- API SMS
Envoyez et recevez des SMS avec des numéros canadiens locaux et sans frais, avec le consentement LCAP et les réponses STOP appliqués par l’API.
- API courriel
Envoyez des courriels transactionnels depuis votre domaine et recevez les réponses par l’API, avec les vérifications LCAP et des données stockées au Canada.
- Verify
Des codes à usage unique par texto, pour confirmer qu’un numéro de téléphone canadien appartient bien à votre utilisateur.
Essayez d'abord en mode test
Les clés de test fonctionnent dès l'inscription, sans carte et sans frais.
HonkIO