وضعیت و گزارش ارسال
صندوق ارسال در یک بازه
پیامهای ارسالشده در یک بازه زمانی را برمیگرداند؛ برای ساختن گزارش ارسال در سیستم خودتان.
GET
POST
https://api.payamras.ir/v1/YOUR_API_KEY/sms/selectoutbox.json
- به دسترسی IP نیاز دارد.
- بازه حداکثر یک روز و startdate حداکثر ۳ روز قبل است.
- حداکثر ۵۰۰ ردیف برمیگردد و صفحهبندی ندارد؛ اگر ۵۰۰ ردیف گرفتید، بازه را کوچکتر کنید.
پارامترها
| نام | نوع | توضیح |
|---|---|---|
startdate
الزامی
|
UnixTime | ابتدای بازه. |
enddate
اختیاری
|
UnixTime | انتهای بازه. خالی یعنی همین لحظه. |
sender
اختیاری
|
String | فقط پیامهای این خط. |
نمونه درخواست
curl -G "https://api.payamras.ir/v1/YOUR_API_KEY/sms/selectoutbox.json" \
--data-urlencode "startdate=1760300000" \
--data-urlencode "enddate=1760380000"
<?php
$apiKey = 'YOUR_API_KEY';
$params = [
'startdate' => '1760300000',
'enddate' => '1760380000',
];
$ch = curl_init("https://api.payamras.ir/v1/{$apiKey}/sms/selectoutbox.json?" . 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({
startdate: "1760300000",
enddate: "1760380000",
});
const response = await fetch(`https://api.payamras.ir/v1/${apiKey}/sms/selectoutbox.json?${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 = {
"startdate": "1760300000",
"enddate": "1760380000",
}
response = requests.get(f"https://api.payamras.ir/v1/{api_key}/sms/selectoutbox.json", params=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": 10,
"statustext": "رسیده به گیرنده",
"sender": "10004346",
"receptor": "09121234567",
"date": 1760337000,
"cost": 1200
}
]
}
خطاهای رایج
علاوه بر خطاهای عمومی مثل 403 و
418، این متد ممکن است این کدها را در
return.status برگرداند: