ارسال پیامک
ارسال پیامک
یک متن را به یک یا چند گیرنده (حداکثر ۲۰۰ شماره در هر درخواست) میفرستد. برای ارسال متنهای متفاوت به گیرندههای متفاوت از sendarray استفاده کنید.
POST
GET
https://api.payamras.ir/v1/YOUR_API_KEY/sms/send.json
- برای هر گیرنده یک ردیف در entries برمیگردد. messageid هر ردیف را برای پیگیری وضعیت ذخیره کنید.
- اگر sender ارسال نشود، پیام از خط پیشفرض حساب ارسال میشود.
پارامترها
| نام | نوع | توضیح |
|---|---|---|
receptor
الزامی
|
String | شماره گیرنده. چند شماره را با ویرگول (,) جدا کنید؛ حداکثر ۲۰۰ شماره. |
message
الزامی
|
String | متن پیام. باید URL-encode شود. |
sender
اختیاری
|
String | شماره خط فرستنده. اگر خالی باشد، خط پیشفرض حساب استفاده میشود. |
date
اختیاری
|
UnixTime | زمان ارسال زمانبندیشده. خالی یعنی ارسال فوری. |
type
اختیاری
|
Integer | نوع نمایش پیام روی گوشی (جدول «انواع نمایش» در صفحه وضعیت پیامها). فقط برای خطوط ۳۰۰۰. |
localid
اختیاری
|
Long | شناسه پیام در سیستم شما برای جلوگیری از ارسال تکراری. تعداد آن باید با تعداد گیرندهها برابر باشد. |
hide
اختیاری
|
Byte | مقدار 1 شماره گیرنده را در گزارشها و صندوق ارسال پنهان میکند. |
tag
اختیاری
|
String | برچسب دستهبندی گزارش. حداکثر ۲۰۰ کاراکتر، فقط حروف انگلیسی، عدد، - و _. برچسب باید از قبل تعریف شده باشد. |
policy
اختیاری
|
String | نام سیاست ارسال تعریفشده روی حساب. |
mediaid
اختیاری
|
Guid | شناسه فایل چندرسانهای آپلودشده. فقط برای خطوط پیامرسان داخلی. |
نمونه درخواست
curl -X POST "https://api.payamras.ir/v1/YOUR_API_KEY/sms/send.json" \
--data-urlencode "receptor=09121234567,09351234567" \
--data-urlencode "message=سفارش شما ثبت شد. کد پیگیری: 48213" \
--data-urlencode "sender=10004346"
<?php
$apiKey = 'YOUR_API_KEY';
$params = [
'receptor' => '09121234567,09351234567',
'message' => 'سفارش شما ثبت شد. کد پیگیری: 48213',
'sender' => '10004346',
];
$ch = curl_init("https://api.payamras.ir/v1/{$apiKey}/sms/send.json");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($params));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = json_decode(curl_exec($ch), true);
if ($result['return']['status'] !== 200) {
throw new RuntimeException($result['return']['message']);
}
const apiKey = "YOUR_API_KEY";
const params = new URLSearchParams({
receptor: "09121234567,09351234567",
message: "سفارش شما ثبت شد. کد پیگیری: 48213",
sender: "10004346",
});
const response = await fetch(`https://api.payamras.ir/v1/${apiKey}/sms/send.json`, {
method: "POST",
body: params,
});
const result = await response.json();
if (result.return.status !== 200) {
throw new Error(result.return.message);
}
import requests
api_key = "YOUR_API_KEY"
params = {
"receptor": "09121234567,09351234567",
"message": "سفارش شما ثبت شد. کد پیگیری: 48213",
"sender": "10004346",
}
response = requests.post(f"https://api.payamras.ir/v1/{api_key}/sms/send.json", data=params)
result = response.json()
if result["return"]["status"] != 200:
raise RuntimeError(result["return"]["message"])
پاسخ
فیلدهای هر ردیف entries:
| فیلد | نوع | توضیح |
|---|---|---|
messageid |
Long | شناسه یکتای پیام؛ برای پیگیری وضعیت ذخیره کنید. |
message |
String | متن پیام. |
status |
Integer | وضعیت پیام (صفحه وضعیت پیامها). |
statustext |
String | شرح وضعیت. |
sender |
String | خط فرستنده. |
receptor |
String | شماره گیرنده. |
date |
UnixTime | زمان ثبت یا زمانبندی ارسال. |
cost |
Integer | هزینه پیام به ریال. |
{
"return": {
"status": 200,
"message": "تایید شد"
},
"entries": [
{
"messageid": 8792343,
"message": "سفارش شما ثبت شد. کد پیگیری: 48213",
"status": 1,
"statustext": "در صف ارسال",
"sender": "10004346",
"receptor": "09121234567",
"date": 1760337000,
"cost": 1200
},
{
"messageid": 8792344,
"message": "سفارش شما ثبت شد. کد پیگیری: 48213",
"status": 1,
"statustext": "در صف ارسال",
"sender": "10004346",
"receptor": "09351234567",
"date": 1760337000,
"cost": 1200
}
]
}
خطاهای رایج
علاوه بر خطاهای عمومی مثل 403 و
418، این متد ممکن است این کدها را در
return.status برگرداند: