فایلهای چندرسانهای
حذف فایل
یک فایل آپلودشده را حذف میکند.
DELETE
https://api.payamras.ir/v1/YOUR_API_KEY/media/delete.json
پارامترها
| نام | نوع | توضیح |
|---|---|---|
id
الزامی
|
Guid | شناسه فایل. |
نمونه درخواست
curl -X DELETE -G "https://api.payamras.ir/v1/YOUR_API_KEY/media/delete.json" \
--data-urlencode "id=3f2b7c1e-9a4d-4e21-8b0f-6c5d2a1e9f30"
<?php
$apiKey = 'YOUR_API_KEY';
$params = [
'id' => '3f2b7c1e-9a4d-4e21-8b0f-6c5d2a1e9f30',
];
$ch = curl_init("https://api.payamras.ir/v1/{$apiKey}/media/delete.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({
id: "3f2b7c1e-9a4d-4e21-8b0f-6c5d2a1e9f30",
});
const response = await fetch(`https://api.payamras.ir/v1/${apiKey}/media/delete.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 = {
"id": "3f2b7c1e-9a4d-4e21-8b0f-6c5d2a1e9f30",
}
response = requests.delete(f"https://api.payamras.ir/v1/{api_key}/media/delete.json", params=params)
result = response.json()
if result["return"]["status"] != 200:
raise RuntimeError(result["return"]["message"])
پاسخ
فیلدهای هر ردیف entries:
| فیلد | نوع | توضیح |
|---|---|---|
id |
Guid | شناسه فایل. |
deleted |
Boolean | true اگر حذف شد. |
{
"return": {
"status": 200,
"message": "تایید شد"
},
"entries": {
"id": "3f2b7c1e-9a4d-4e21-8b0f-6c5d2a1e9f30",
"deleted": true
}
}
خطاهای رایج
علاوه بر خطاهای عمومی مثل 403 و
418، این متد ممکن است این کدها را در
return.status برگرداند: