صندوق دریافت
صندوق دریافت صفحهبندیشده
پیامهای دریافتی یک بازه را صفحه به صفحه برمیگرداند، با اطلاعات صفحهبندی در metadata.
GET
POST
https://api.payamras.ir/v1/YOUR_API_KEY/sms/inboxpaged.json
- هر صفحه حداکثر ۲۰۰ پیام. بازه حداکثر دو روز و اگر خالی باشد، دو روز اخیر.
پارامترها
| نام | نوع | توضیح |
|---|---|---|
linenumber
الزامی
|
String | شماره خط دریافتکننده. |
isread
الزامی
|
Integer | 0 خواندهنشده، 1 خواندهشده. |
startdate
اختیاری
|
UnixTime | ابتدای بازه. |
enddate
اختیاری
|
UnixTime | انتهای بازه. |
pagenumber
اختیاری
|
Integer | شماره صفحه؛ از ۱. |
نمونه درخواست
curl -G "https://api.payamras.ir/v1/YOUR_API_KEY/sms/inboxpaged.json" \
--data-urlencode "linenumber=10004346" \
--data-urlencode "isread=0" \
--data-urlencode "pagenumber=1"
<?php
$apiKey = 'YOUR_API_KEY';
$params = [
'linenumber' => '10004346',
'isread' => '0',
'pagenumber' => '1',
];
$ch = curl_init("https://api.payamras.ir/v1/{$apiKey}/sms/inboxpaged.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({
linenumber: "10004346",
isread: "0",
pagenumber: "1",
});
const response = await fetch(`https://api.payamras.ir/v1/${apiKey}/sms/inboxpaged.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 = {
"linenumber": "10004346",
"isread": "0",
"pagenumber": "1",
}
response = requests.get(f"https://api.payamras.ir/v1/{api_key}/sms/inboxpaged.json", params=params)
result = response.json()
if result["return"]["status"] != 200:
raise RuntimeError(result["return"]["message"])
پاسخ
فیلدهای هر ردیف entries:
| فیلد | نوع | توضیح |
|---|---|---|
messageid |
Long | شناسه پیام دریافتی. |
message |
String | متن پیام. |
sender |
String | شماره فرستنده پیام. |
receptor |
String | خط شما که پیام را دریافت کرده. |
date |
UnixTime | زمان دریافت. |
{
"return": {
"status": 200,
"message": "تایید شد"
},
"entries": [
{
"messageid": 22045121,
"message": "لغو11",
"sender": "09121234567",
"receptor": "10004346",
"date": 1760337500
}
],
"metadata": {
"totalcount": 1,
"currentpage": 1,
"totalpages": 1,
"pagesize": 200
}
}
خطاهای رایج
علاوه بر خطاهای عمومی مثل 403 و
418، این متد ممکن است این کدها را در
return.status برگرداند: