Crédits et contacts

Lire le solde

La permission balance.read autorise GET /api/sms/v2/balance/.

curl 'https://api.befiana.cloud/api/sms/v2/balance/' \
  --header "Authorization: Bearer $BEFIANA_SMS_API_KEY"

Défilement horizontal si nécessaire. Au clavier : Tab, puis les flèches gauche et droite.

Champ	Utilité
total	Solde total indiqué par le service.
available	Crédits disponibles pour de nouveaux envois.
reserved	Crédits déjà réservés.
valid_until	Date de validité retournée, lorsqu’elle existe.

Le nombre de crédits dépend des segments, pas seulement du nombre de destinataires. Les messages programmés et les lots peuvent réserver des crédits avant leur traitement. N’additionnez pas available et reserved à un total métier enregistré localement pour recalculer le solde : consultez le service.

Prévoir la concurrence

Une lecture de solde n’est pas une réservation. D’autres envois peuvent consommer les crédits entre votre consultation et votre requête. Votre intégration doit traiter un refus pour crédits insuffisants même après une lecture favorable.

Les achats et la gestion des crédits restent dans BEFIANA Cloud. Cette API publique n’annonce pas d’opération d’achat.

Créer ou mettre à jour un contact

La permission contacts.manage autorise POST /api/sms/v2/contacts/. Le champ phone_number identifie le contact dans l’organisation. L’opération renvoie 201 lors d’une création et 200 lors de la mise à jour du contact existant.

curl --request POST 'https://api.befiana.cloud/api/sms/v2/contacts/' \
  --header "Authorization: Bearer $BEFIANA_SMS_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"phone_number":"+261340000000"}'

Consultez les champs descriptifs acceptés dans la référence. Enregistrer un contact n’envoie pas de SMS et ne constitue pas une preuve de consentement à recevoir vos communications.