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