قالب HTML داشبورد مدیریتی Admiro

آدرس فراخوانی API

https://api.regads.ir/bale/v3/

متد ۱: ارسال پیام (Send Message)

این متد پیام (مانند OTP یا متن دلخواه) را برای شماره مشخص‌شده ارسال می‌کند.

پارامترهای درخواست

نام پارامتر	نوع داده	اجباری	شرح
`api-access-key`	String	✅	توکن اتصال به وب‌سرویس که باید در Header قرار گیرد
`bot_id`	Integer	✅	شناسه بازو ارسال‌کننده پیام
`phone_number`	String	✅	شماره تلفن مقصد (بدون علامت +)
`message_data`	Object	✅	داده‌های پیام شامل محتوای نوع پیام (مثلاً `otp_message`) و مقدار آن
`otp` (داخل `message_data`)	String	✅	کد OTP یا متن ارسال‌شونده

Curl
PHP

curl --location 'https://api.regads.ir/bale/v3/send_message' \
--header 'api-access-key: **********' \
--header 'Content-Type: application/json' \
--data '{
  "bot_id": **********,
  "phone_number": "989121345678",
  "message_data": {
    "otp_message": {
      "otp": "123456"
    }
  }
}'

<?php
$url = 'https://api.regads.ir/bale/v3/send_message';
$headers = [
  'api-access-key: **********',
  'Content-Type: application/json'
];

$data = [
  'bot_id' => **********,
  'phone_number' => '989121345678',
  'message_data' => ['otp_message' => ['otp' => '123456']]
];

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);
echo $response;
?>

نمونه پاسخ (Response JSON)

{
    status: "100",
    messageid: 2612781840,
    cost: "30",
    receptor: "09121345678",
    datetime: "2026-04-24 04:50:25",
    datetime_shamsi: "1405/2/4 04:50:25",
    message: [
        {
            type: "otp",
            text: "123456",
            bale_request_id: "rqpfx-Bs5ZoZ.fRpaJxd.BjXzLKOC15V",
            bale_message_id: "Bs5ZoZ.fRpaJxd.BjXzLKOC15V"
        }
    ]
}

متد ۲: بررسی وضعیت ارسال (Check Message Status)

این متد برای بررسی وضعیت پیام ارسال‌شده به کار می‌رود. باید شناسه پیام (message_id) را که در پاسخ متد ارسال دریافت کرده‌اید برای این متد ارسال کنید.

پارامترهای درخواست

نام پارامتر	نوع داده	اجباری	شرح
`api-access-key`	String	✅	کلید دسترسی
`message_id`	String	✅	شناسه پیام دریافتی از متد ارسال
`bot_id`	Integer	✅	شناسه بازو مربوطه

Curl
PHP

curl --location 'https://api.regads.ir/bale/v3/check_message' \
--header 'api-access-key: **********' \
--header 'Content-Type: application/json' \
--data '{
  "bot_id": **********,
  "message_id": "abc123xyz"
}'

<?php
$url = 'https://api.regads.ir/bale/v3/check_message';
$headers = [
  'api-access-key: **********',
  'Content-Type: application/json'
];
$data = [
  'bot_id' => **********,
  'message_id' => 'abc123xyz'
];
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
?>

نمونه پاسخ (Response JSON)

{
  "status": "delivered",
  "message_id": "abc123xyz",
  "description": "Message successfully delivered to recipient."
}

⚠️ جدول کدهای خطا

کد خطا	توضیح
`400`	داده ارسالی نامعتبر است (Bad Request)
`401`	کلید دسترسی اشتباه یا معتبر نیست
`403`	دسترسی غیرمجاز به بازو یا مقصد
`404`	پیام یا بازو مورد نظر یافت نشد
`500`	خطای داخلی سرور
`503`	سرویس موقتاً در دسترس نیست

۱۰ اردیبهشت ۱۴۰۳امروز

محسن

۶ تیر ۱۴۰۳۱ ساعت پیش

مارال

۱۳ مرداد ۱۴۰۳امروز

لیلا

۲۱ آبان ۱۴۰۳دیروز

فریبا

مستندات وب‌سرویس بله

آدرس فراخوانی API

متد ۱: ارسال پیام (Send Message)

پارامترهای درخواست

نمونه پاسخ (Response JSON)

متد ۲: بررسی وضعیت ارسال (Check Message Status)

پارامترهای درخواست

نمونه پاسخ (Response JSON)

⚠️ جدول کدهای خطا