Developer Docs
مستندات API
با چند خط کد، سرویس ارسال پیام را به سیستم خود متصل کنید
۱. احراز هویت
همهی درخواستهای API باید هدر X-API-Key داشته باشند. کلید API را میتوانید از داشبورد → کلیدهای API بسازید.
GET https://robatpayam.ir/api/v1/me X-API-Key: rp_your_api_key_here
۲. ارسال یک پیام
POST /api/v1/send
POST https://robatpayam.ir/api/v1/send
X-API-Key: rp_your_api_key_here
Content-Type: application/json
{
"platform": "Bale", // Bale | Eitaa | Rubika | WhatsApp
"recipient": "09123456789",
"message": "سلام! متن پیام"
}
// پاسخ موفق:
{ "success": true, "id": "uuid...", "cost": 250 }
نمونه Python
import requests
r = requests.post(
"https://robatpayam.ir/api/v1/send",
headers={"X-API-Key": "rp_..."},
json={"platform":"Bale","recipient":"09123456789","message":"سلام"}
)
print(r.json())
نمونه PHP
$ch = curl_init("https://robatpayam.ir/api/v1/send");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"X-API-Key: rp_...", "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
"platform" => "Bale",
"recipient" => "09123456789",
"message" => "سلام"
]));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
echo curl_exec($ch);
نمونه Node.js
const res = await fetch("https://robatpayam.ir/api/v1/send", {
method: "POST",
headers: { "X-API-Key": "rp_...", "Content-Type": "application/json" },
body: JSON.stringify({
platform: "Bale",
recipient: "09123456789",
message: "سلام"
})
});
console.log(await res.json());
نمونه C#
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("X-API-Key", "rp_...");
var res = await client.PostAsJsonAsync(
"https://robatpayam.ir/api/v1/send",
new { platform = "Bale", recipient = "09123456789", message = "سلام" }
);
Console.WriteLine(await res.Content.ReadAsStringAsync());
۳. ارسال انبوه
POST /api/v1/send-bulk
{
"platform": "Bale",
"recipients": ["09123456789","09121112222","..."],
"message": "متن پیام برای همه"
}
۴. اطلاعات کلید و کیف پول
GET /api/v1/me
۵. تاریخچه ارسال
GET /api/v1/logs?page=1&pageSize=50
۶. کدهای خطا
| کد | معنی |
|---|---|
401 | کلید API نامعتبر |
402 | موجودی کیف پول کافی نیست |
400 | پارامترهای درخواست نامعتبر |
429 | نرخ درخواست بیش از حد |
503 | پلتفرم موقتاً در دسترس نیست |