Codes d'erreur

Lorsque vous interagissez avec l’API SMSBAT, vous pouvez rencontrer des erreurs. Nous utilisons des codes de réponse HTTP conventionnels pour indiquer le succès ou l’échec d’une requête API.

En général :

• Les codes dans la plage « 2xx » indiquent le succès.
• Les codes dans la plage « 4xx » indiquent une erreur qui a échoué compte tenu des informations fournies (par exemple, un paramètre obligatoire a été omis, un type de message n’est pas valide, etc.).
• Les codes dans la plage « 5xx » indiquent une erreur avec nos serveurs.

Codes d’état HTTP

Codes	Statut	Descriptif
200	D'accord	La demande a abouti.
400	Mauvaise demande	La demande était inacceptable, souvent en raison de l’absence d’un paramètre requis ou d’un JSON mal formé.
401	Non autorisé	Aucune clé API valide fournie ou l’authentification a échoué.
403	Interdit	La clé API ne dispose pas des autorisations nécessaires pour exécuter la demande ou votre compte est suspendu.
404	Non trouvé	La ressource demandée n’existe pas.
415	Type de média non pris en charge	L’en-tête « Content-Type » est manquant ou n’est pas défini sur « application/json ».
422	Entité non traitable	La demande était correctement formatée mais contenait des erreurs sémantiques (par exemple, un format de numéro de téléphone non valide).
429	« Trop de demandes »	Trop de requêtes parviennent trop rapidement à l’API. Nous recommandons un recul exponentiel de vos demandes.
500, 502, 503, 504	Erreurs du serveur	Quelque chose s’est mal passé du côté de SMSBAT.

Format de réponse d’erreur

Lorsqu’une requête API génère une erreur, le corps de la réponse contient un objet JSON avec plus de détails sur le problème.

{
  "status": 400,
  "error": "Bad Request",
  "message": "Missing required field: 'messages'",
  "code": 1001
}

Codes d’erreur de logique métier (codes internes)

En plus des codes d’état HTTP, nous pouvons renvoyer un « code » interne spécifique pour vous aider à identifier la raison exacte de l’échec.

Code interne	Descriptif	Action suggérée
1001	Format de demande invalide	Assurez-vous que le corps de votre demande est un JSON valide.
1002	Champ obligatoire manquant	Vérifiez la propriété message dans la réponse pour voir quel champ est manquant.
1003	Numéro de téléphone invalide	Assurez-vous que le numéro du destinataire est au format E.164 (par exemple, « 380501234567 »).
1004	Nom Alpha non enregistré	Le paramètre « from » contient un nom alpha qui n’a pas été approuvé pour votre compte.
1005	« Solde insuffisant »	Votre compte ne dispose pas de suffisamment de fonds pour traiter la campagne de messagerie.
1006	Type de message invalide	Le paramètre type doit être l’un des types pris en charge (par exemple, sms, viber_promo).
1007	Modèle introuvable	L’ID de modèle Viber/OTP demandé n’est pas valide ou n’est pas approuvé.
1008	« Éléments du carrousel non valides »	Un carrousel Viber doit contenir entre 2 et 5 éléments.

[!ASTUCE] Si vous rencontrez un code d’erreur non répertorié ici, ou si vous pensez qu’une erreur a été renvoyée par erreur, veuillez contacter [email protected] et fournir la charge utile et les en-têtes de réponse exacts.