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