შეცდომის კოდები

SMSBAT API-სთან ურთიერთობისას შეიძლება შეგექმნათ შეცდომები. ჩვენ ვიყენებთ ჩვეულებრივ HTTP საპასუხო კოდებს, რათა მიუთითოთ API მოთხოვნის წარმატება ან წარუმატებლობა.

ზოგადად:

• კოდები 2xx დიაპაზონში მიუთითებს წარმატებაზე.
• კოდები 4xx დიაპაზონში მიუთითებს შეცდომაზე, რომელიც ვერ მოხერხდა მოწოდებული ინფორმაციის გათვალისწინებით (მაგ., საჭირო პარამეტრი გამოტოვებულია, შეტყობინების ტიპი არასწორია და ა.შ.).
• კოდები 5xx დიაპაზონში მიუთითებს შეცდომაზე ჩვენს სერვერებთან.

HTTP სტატუსის კოდები

კოდი	სტატუსი	აღწერა
200	OK	მოთხოვნა წარმატებით დასრულდა.
400	ცუდი მოთხოვნა	მოთხოვნა მიუღებელი იყო, ხშირად საჭირო პარამეტრის გამოტოვების ან არასწორი JSON-ის გამო.
401	არაავტორიზებული	მოქმედი API გასაღები არ არის მოწოდებული, ან ავტორიზაცია ვერ მოხერხდა.
403	აკრძალულია	API გასაღებს არ აქვს მოთხოვნის შესრულების ნებართვა, ან თქვენი ანგარიში შეჩერებულია.
404	არ მოიძებნა	მოთხოვნილი რესურსი არ არსებობს.
415	მხარდაუჭერელი მედიის ტიპი	Content-Type სათაური აკლია ან არ არის დაყენებული application/json.
422	დაუმუშავებელი ერთეული	მოთხოვნა იყო დაფორმატებული სწორად, მაგრამ შეიცავდა სემანტიკურ შეცდომებს (მაგ. ტელეფონის ნომრის არასწორი ფორმატი).
429	ძალიან ბევრი მოთხოვნა	ძალიან ბევრი მოთხოვნა ძალიან სწრაფად მოხვდა API-ში. ჩვენ გირჩევთ თქვენი მოთხოვნების ექსპონენციალურ უკან დაბრუნებას.
500, 502, 503, 504	სერვერის შეცდომები	შეფერხება მოხდა SMSBAT-ის ბოლოს.

შეცდომის პასუხის ფორმატი

როდესაც API მოთხოვნა იწვევს შეცდომას, პასუხის ორგანო შეიცავს JSON ობიექტს პრობლემის შესახებ მეტი დეტალებით.

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

ბიზნეს ლოგიკის შეცდომის კოდები (შიდა კოდები)

HTTP სტატუსის კოდების გარდა, ჩვენ შეიძლება დავაბრუნოთ კონკრეტული შიდა კოდი, რათა დაგეხმაროთ მარცხის ზუსტი მიზეზის იდენტიფიცირებაში.

შიდა კოდი	აღწერა	შემოთავაზებული მოქმედება
1001	არასწორი მოთხოვნის ფორმატი	დარწმუნდით, რომ თქვენი მოთხოვნის ტექსტი სწორია JSON.
1002	გამოტოვებული აუცილებელი ველი	შეამოწმეთ message თვისება პასუხში, რომ ნახოთ რომელი ველი აკლია.
1003	არასწორი ტელეფონის ნომერი	დარწმუნდით, რომ მიმღების ნომერი არის E.164 ფორმატში (მაგ., 380501234567).
1004	არარეგისტრირებული ალფა სახელი	პარამეტრი from შეიცავს ალფა სახელს, რომელიც არ არის დამტკიცებული თქვენი ანგარიშისთვის.
1005	არასაკმარისი ბალანსი	თქვენს ანგარიშს არ აქვს საკმარისი სახსრები შეტყობინებების კამპანიის დასამუშავებლად.
1006	არასწორი შეტყობინების ტიპი	type პარამეტრი უნდა იყოს ერთ-ერთი მხარდაჭერილი ტიპი (მაგ., sms, viber_promo).
1007	თარგი ვერ მოიძებნა	მოთხოვნილი Viber/OTP შაბლონის ID არასწორია ან არ არის დამტკიცებული.
1008	არასწორი კარუსელის ნივთები	Viber კარუსელი უნდა შეიცავდეს 2-დან 5 ელემენტს შორის.

[! რჩევა] თუ შეგხვდებათ შეცდომის კოდი, რომელიც არ არის ჩამოთვლილი აქ, ან თუ ფიქრობთ, რომ შეცდომა შეცდომით დაბრუნდა, გთხოვთ, დაუკავშირდეთ [email protected] და მიუთითოთ ზუსტი პასუხის დატვირთვა და სათაურები.