فایلهای چندرسانهای
جزئیات فایل
اطلاعات و وضعیت پردازش یک فایل را برمیگرداند.
GET
https://api.payamras.ir/v1/YOUR_API_KEY/media/get.json
پارامترها
| نام | نوع | توضیح |
|---|---|---|
id
الزامی
|
Guid | شناسه فایل. |
نمونه درخواست
curl -G "https://api.payamras.ir/v1/YOUR_API_KEY/media/get.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/get.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({
id: "3f2b7c1e-9a4d-4e21-8b0f-6c5d2a1e9f30",
});
const response = await fetch(`https://api.payamras.ir/v1/${apiKey}/media/get.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 = {
"id": "3f2b7c1e-9a4d-4e21-8b0f-6c5d2a1e9f30",
}
response = requests.get(f"https://api.payamras.ir/v1/{api_key}/media/get.json", params=params)
result = response.json()
if result["return"]["status"] != 200:
raise RuntimeError(result["return"]["message"])
پاسخ
فیلدهای هر ردیف entries:
| فیلد | نوع | توضیح |
|---|---|---|
id |
Guid | شناسه فایل؛ همان mediaid در ارسال پیام. |
name |
String | نام فایل. |
mime_type |
String | نوع فایل. |
size |
Long | حجم به بایت. |
duration |
Integer | مدت ویدیو به ثانیه. |
resolution |
String | ابعاد تصویر یا ویدیو. |
status |
Integer | وضعیت پردازش: 0 در حال پردازش، 1 آماده، 2 خطا. |
review.status |
Integer | نتیجه بررسی: 1 تایید، 2 رد. |
{
"return": {
"status": 200,
"message": "تایید شد"
},
"entries": {
"id": "3f2b7c1e-9a4d-4e21-8b0f-6c5d2a1e9f30",
"name": "banner.jpg",
"mime_type": "image/jpeg",
"extension": "jpg",
"size": 284512,
"duration": null,
"resolution": "1080x1080",
"status": 1,
"status_desc": "آماده"
}
}
خطاهای رایج
علاوه بر خطاهای عمومی مثل 403 و
418، این متد ممکن است این کدها را در
return.status برگرداند: