Pour planifier l’envoi de SMS en masse en utilisant une clé API, envoyez une requête POST à l’endpoint /api/smsko/v1/sendbulk/.
Endpoint #
POST /api/smsko/v1/sendbulk/
En-têtes #
{
"Authorization": "votre_api_key"
}Corps #
{
"phone_numbers": ["321234567", "327654321", "326316659", "340972193"],
"message": "Ceci est un message SMS programmé en masse",
"send_at": "2024-07-07 15:30"
}Réponse #
{
"message": "4 SMS has been successfully scheduled.",
"phone_numbers": ["321234567", "327654321", "326016659", "340972193"]
}Codes d’erreur #
Voici une liste des erreurs possibles que vous pouvez rencontrer lors de l’utilisation de l’API et leur signification :
Erreurs de l’API #
Erreurs d’authentification #
{
"error": "Invalid API key."
}Cette erreur se produit lorsque la clé API fournie n’est pas valide.
{
"error": "No API key provided."
}Cette erreur se produit lorsque aucune clé API n’est fournie dans l’en-tête de la requête.
Erreurs de validation des données #
{
"error": "Invalid date format. Use 'YYYY-MM-DD HH:MM'."
}Cette erreur se produit lorsque le format de la date est incorrect.
{
"error": "Message exceeds the maximum length of 320 characters."
}Cette erreur se produit lorsque le message dépasse la longueur maximale autorisée de 320 caractères.
{
"error": "Invalid phone numbers format. Provide a list of phone numbers."
}Cette erreur se produit lorsque le format des numéros de téléphone est incorrect. Vous devez fournir une liste de numéros de téléphone.
Erreurs de service #
{
"error": "Your account is not activated to send SMS."
}Cette erreur se produit lorsque le compte de l’utilisateur n’est pas activé pour envoyer des SMS.
{
"error": "No activation request found. Please complete your activation request."
}Cette erreur se produit lorsque aucune demande d’activation n’est trouvée pour l’utilisateur.
{
"error": "Insufficient balance or validity expired."
}Cette erreur se produit lorsque le solde SMS est insuffisant ou lorsque la validité du solde a expiré.
Erreurs diverses #
{
"error": "Failed to send SMS.",
"meta": "0321234567",
"details": {...}
}Cette erreur se produit lorsque l’envoi du SMS échoue pour une raison quelconque.
Conclusion #
Ce guide fournit les informations nécessaires pour interagir avec l’API de SMS by BEFIANA en utilisant des clés API. Pour toute question ou assistance supplémentaire, veuillez contacter le support technique de BEFIANA.
SMS by BEFIANA, Solution pour envoyer des SMS ou campagne de masse à Madagascar
