لیست سیاه خط
حذف از لیست سیاه
مسدودی شمارهها روی یک خط را برمیدارد. پارامترها در query string فرستاده میشوند.
DELETE
https://api.payamras.ir/v1/YOUR_API_KEY/line/blocked/remove.json
- حداکثر ۵۰ شماره در هر درخواست.
- فقط شمارههایی که از پنل یا وبسرویس مسدود شدهاند قابل حذفاند؛ مسدودی اپراتور یا سیستم را نمیتوان برداشت.
پارامترها
| نام | نوع | توضیح |
|---|---|---|
linenumber
الزامی
|
String | شماره خط. |
receptor
الزامی
|
String | شمارهها، جداشده با ویرگول. |
نمونه درخواست
curl -X DELETE -G "https://api.payamras.ir/v1/YOUR_API_KEY/line/blocked/remove.json" \
--data-urlencode "linenumber=10004346" \
--data-urlencode "receptor=09121234567"
<?php
$apiKey = 'YOUR_API_KEY';
$params = [
'linenumber' => '10004346',
'receptor' => '09121234567',
];
$ch = curl_init("https://api.payamras.ir/v1/{$apiKey}/line/blocked/remove.json?" . http_build_query($params));
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
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",
receptor: "09121234567",
});
const response = await fetch(`https://api.payamras.ir/v1/${apiKey}/line/blocked/remove.json?${params}`, { method: "DELETE" });
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",
"receptor": "09121234567",
}
response = requests.delete(f"https://api.payamras.ir/v1/{api_key}/line/blocked/remove.json", params=params)
result = response.json()
if result["return"]["status"] != 200:
raise RuntimeError(result["return"]["message"])
پاسخ
فیلدهای هر ردیف entries:
| فیلد | نوع | توضیح |
|---|---|---|
message |
String | نتیجه عملیات. |
{
"return": {
"status": 200,
"message": "تایید شد"
},
"entries": {
"message": "شمارهها از لیست سیاه حذف شدند"
}
}
خطاهای رایج
علاوه بر خطاهای عمومی مثل 403 و
418، این متد ممکن است این کدها را در
return.status برگرداند:
- 412 فرستنده نامعتبر است، یا تعداد آیتمها از سقف مجاز بیشتر است.