Hata Kodları
SMSBAT API ile etkileşimde bulunurken hatalarla karşılaşabilirsiniz. Bir API isteğinin başarısını veya başarısızlığını belirtmek için geleneksel HTTP yanıt kodlarını kullanırız.
Genel olarak: - '2xx' aralığındaki kodlar başarıyı gösterir. - '4xx' aralığındaki kodlar, sağlanan bilgiler göz önüne alındığında başarısız olan bir hatayı belirtir (örneğin, gerekli bir parametrenin atlanması, bir mesaj türünün geçersiz olması vb.). - '5xx' aralığındaki kodlar sunucularımızda bir hata olduğunu gösterir.
HTTP Durum Kodları
| Kod | Durum | Açıklama |
|---|---|---|
| 200 | 'Tamam' | İstek başarılı oldu. |
| 400 | 'Kötü İstek' | Çoğu zaman gerekli bir parametrenin eksik olması veya hatalı biçimlendirilmiş JSON nedeniyle istek kabul edilemezdi. |
| 401 | 'Yetkisiz' | Geçerli bir API anahtarı sağlanmadı veya kimlik doğrulama başarısız oldu. |
| 403 | 'Yasak' | API anahtarının isteği gerçekleştirme izni yok veya hesabınız askıya alındı. |
| 404 | 'Bulunamadı' | İstenen kaynak mevcut değil. |
| 415 | Desteklenmeyen Medya Türü |
'Content-Type' başlığı eksik veya 'application/json' olarak ayarlanmamış. |
| 422 | İşlenemeyen Varlık |
İstek doğru biçimlendirilmiş ancak anlamsal hatalar içeriyordu (ör. geçersiz telefon numarası biçimi). |
| 429 | 'Çok Fazla İstek' | Çok fazla istek API'ye çok hızlı ulaşıyor. İsteklerinizin katlanarak geri alınmasını öneririz. |
| 500, 502, 503, 504 | Sunucu Hataları |
SMSBAT tarafında bir şeyler ters gitti. |
Hata Yanıt Formatı
Bir API isteği hatayla sonuçlandığında yanıt gövdesi, sorunla ilgili daha fazla ayrıntı içeren bir JSON nesnesi içerir.
{
"status": 400,
"error": "Bad Request",
"message": "Missing required field: 'messages'",
"code": 1001
}
İş Mantığı Hata Kodları (Dahili Kodlar)
Hatanın kesin nedenini belirlemenize yardımcı olmak için HTTP durum kodlarına ek olarak belirli bir dahili "kod" da döndürebiliriz.
| Dahili Kod | Açıklama | Önerilen Eylem |
|---|---|---|
| 1001 | 'Geçersiz İstek Formatı' | İstek gövdenizin geçerli JSON olduğundan emin olun. |
| 1002 | 'Zorunlu Alan Eksik' | Hangi alanın eksik olduğunu görmek için yanıttaki "mesaj" özelliğini kontrol edin. |
| 1003 | 'Geçersiz Telefon Numarası' | Alıcı numarasının E.164 biçiminde olduğundan emin olun (ör. '380501234567'). |
| 1004 | Kayıtlı Olmayan Alfa Adı |
"Kimden" parametresi, hesabınız için onaylanmamış bir alfa adı içeriyor. |
| 1005 | 'Yetersiz Bakiye' | Hesabınızda mesajlaşma kampanyasını işlemek için yeterli para yok. |
| 1006 | 'Geçersiz Mesaj Türü' | "type" parametresi desteklenen türlerden biri olmalıdır (ör. "sms", "viber_promo"). |
| 1007 | 'Şablon Bulunamadı' | İstenen Viber/OTP şablon kimliği geçersiz veya onaylanmadı. |
| 1008 | 'Geçersiz Atlı Karınca Öğeleri' | Bir Viber Carousel'in 2 ile 5 arasında öğe içermesi gerekir. |
[!İPUCU] Burada listelenmeyen bir hata koduyla karşılaşırsanız veya bir hatanın yanlışlıkla döndürüldüğünü düşünüyorsanız lütfen [email protected] ile iletişime geçin ve yanıtın tam yükünü ve başlıklarını sağlayın.