ایجاد درخواست

تمامی درخواست‌های مربوط به API بازوی بله باید در بستر HTTPS و به این شکل https://tapi.bale.ai/bot<token>/METHOD_NAME فراخوانی شوند. برای مثال به درخواست زیر توجه کنید:

درخواست

از دو متد GET و POST و همچنین چهار روش زیر برای ارسال پارامتر در ریکوئست‌های بازوی بله پشتیبانی می‌شود:

URL query string

application/x-www-form-urlencoded

application/json (به جز برای آپلود فایل)

multipart/form-data (برای آپلود فایل استفاده کنید)

پاسخ حاوی یک شیء JSON است، که همیشه یک فیلد ok از جنس boolean دارد. پاسخ همچنین ممکن است دارای یک فیلد توضیحات (description) باشد که برای توضیح نتیجه‌ی درخواست استفاده می‌شود. اگر فیلد ok برابر true باشد، به این معنی هست که درخواست موفق بوده و نتیجه درخواست را می‌توان در فیلد result یافت. در زمان ناموفق بودن درخواست، مقدار فیلد ok برابر false بوده و یک فیلد error_code از نوع integer که بیانگر خطای رخ داده است در پاسخ وجود دارد. برخی از خطاها ممکن است یک فیلد اختیاری parameters از نوع ResponseParameters داشته ‌باشند، که می‌تواند به مدیریت خودکار خطا کمک کند.

هیچ حساسیتی نسبت به بزرگ یا کوچک بودن حروف در API بازوی بله وجود ندارد. همه درخواست‌ها باید با فرمت UTF-8 ایجاد شوند.