وضعیت و گزارش ارسال
وضعیت با شماره گیرنده
همه پیامهایی که در یک بازه به یک شماره فرستادهاید را با وضعیتشان برمیگرداند.
GET
POST
https://api.payamras.ir/v1/YOUR_API_KEY/sms/statusbyreceptor.json
- بازه حداکثر یک روز است. اگر enddate خالی باشد، یک روز پس از startdate در نظر گرفته میشود.
پارامترها
| نام | نوع | توضیح |
|---|---|---|
receptor
الزامی
|
String | شماره گیرنده. |
startdate
الزامی
|
UnixTime | ابتدای بازه. |
enddate
اختیاری
|
UnixTime | انتهای بازه؛ نباید قبل از startdate باشد. |
نمونه درخواست
curl -G "https://api.payamras.ir/v1/YOUR_API_KEY/sms/statusbyreceptor.json" \
--data-urlencode "receptor=09121234567" \
--data-urlencode "startdate=1760300000" \
--data-urlencode "enddate=1760380000"
<?php
$apiKey = 'YOUR_API_KEY';
$params = [
'receptor' => '09121234567',
'startdate' => '1760300000',
'enddate' => '1760380000',
];
$ch = curl_init("https://api.payamras.ir/v1/{$apiKey}/sms/statusbyreceptor.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({
receptor: "09121234567",
startdate: "1760300000",
enddate: "1760380000",
});
const response = await fetch(`https://api.payamras.ir/v1/${apiKey}/sms/statusbyreceptor.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 = {
"receptor": "09121234567",
"startdate": "1760300000",
"enddate": "1760380000",
}
response = requests.get(f"https://api.payamras.ir/v1/{api_key}/sms/statusbyreceptor.json", params=params)
result = response.json()
if result["return"]["status"] != 200:
raise RuntimeError(result["return"]["message"])
پاسخ
فیلدهای هر ردیف entries:
| فیلد | نوع | توضیح |
|---|---|---|
receptor |
String | شماره گیرنده. |
messageid |
Long | شناسه پیام. |
status |
Integer | وضعیت پیام. |
statustext |
String | شرح وضعیت. |
{
"return": {
"status": 200,
"message": "تایید شد"
},
"entries": [
{
"receptor": "09121234567",
"messageid": 8792343,
"status": 10,
"statustext": "رسیده به گیرنده"
}
]
}
خطاهای رایج
علاوه بر خطاهای عمومی مثل 403 و
418، این متد ممکن است این کدها را در
return.status برگرداند:
- 417 تاریخ نامعتبر است یا فرمت آن اشتباه است.