وضعیت و گزارش ارسال
جزئیات پیام
اطلاعات کامل پیامها (متن، فرستنده، گیرنده، هزینه و وضعیت) را با messageid برمیگرداند.
GET
POST
https://api.payamras.ir/v1/YOUR_API_KEY/sms/select.json
- به دسترسی IP نیاز دارد؛ بدون آن خطای 407 برمیگردد (صفحه محدودیتها و دسترسی).
- کندتر از sms/status است. اگر فقط وضعیت تحویل لازم دارید، از sms/status استفاده کنید.
- حداکثر ۵۰۰ شناسه در هر درخواست.
پارامترها
| نام | نوع | توضیح |
|---|---|---|
messageid
الزامی
|
Long | شناسه پیام. چند شناسه را با ویرگول جدا کنید. |
نمونه درخواست
curl -G "https://api.payamras.ir/v1/YOUR_API_KEY/sms/select.json" \
--data-urlencode "messageid=8792343"
<?php
$apiKey = 'YOUR_API_KEY';
$params = [
'messageid' => '8792343',
];
$ch = curl_init("https://api.payamras.ir/v1/{$apiKey}/sms/select.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({
messageid: "8792343",
});
const response = await fetch(`https://api.payamras.ir/v1/${apiKey}/sms/select.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 = {
"messageid": "8792343",
}
response = requests.get(f"https://api.payamras.ir/v1/{api_key}/sms/select.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 برگرداند: