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