¶ Plusofon API — медиафайлы
версия от 2023-02-13
Группа методов позволяет управлять медиафайлами (аудиофайлами), которые используются в сценариях вызовов.
Адрес: https://restapi.plusofon.ru
¶ Получение списка
GET api/v1/media
Метод позволяет получить список всех загруженных медиафайлов.
¶ Параметры и примеры запроса
Не имеет параметров.
curl -X GET \
-G "https://restapi.plusofon.ru/api/v1/media" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Client: 10553" \
-H "Authorization: Bearer {token}"
const url = new URL(
"https://restapi.plusofon.ru/api/v1/media"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Client": "10553",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://restapi.plusofon.ru/api/v1/media',
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Client' => '10553',
'Authorization' => 'Bearer {token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://restapi.plusofon.ru/api/v1/media'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Client': '10553',
'Authorization': 'Bearer {token}'
}
response = requests.request('GET', url, headers=headers)
response.json()
¶ Структура и примеры ответа
В ответе возвращается массив data:
-
id
ИД медиафайла -
name
название медиафайла
Получен список медиафайлов:
{
"current_page": 1,
"data": [
{
"id": 1,
"name": "Audio1"
},
{
"id": 2,
"name": "Audio2"
}
],
"first_page_url": "http:\/\/localhost\/api\/v1\/media?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http:\/\/localhost\/api\/v1\/media?page=1",
"next_page_url": null,
"path": "http:\/\/localhost\/api\/v1\/media",
"per_page": 15,
"prev_page_url": null,
"to": 2,
"total": 2
}
Пользователь не найден:
{
"message": "User not found",
"code": 500
}
¶ Получение данных
GET api/v1/media/{media_id}
Метод позволяет получить данные конкретного медиафайла.
¶ Параметры и примеры запроса
Path
media_idstring
⁎ ИД медиафайлаi
curl -X GET \
-G "https://restapi.plusofon.ru/api/v1/media/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Client: 10553" \
-H "Authorization: Bearer {token}"
const url = new URL(
"https://restapi.plusofon.ru/api/v1/media/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Client": "10553",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://restapi.plusofon.ru/api/v1/media/1',
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Client' => '10553',
'Authorization' => 'Bearer {token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://restapi.plusofon.ru/api/v1/media/1'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Client': '10553',
'Authorization': 'Bearer {token}'
}
response = requests.request('GET', url, headers=headers)
response.json()
¶ Структура и примеры ответа
В ответе возвращается:
-
id
ИД медиафайла -
name
название медиафайла
Получены данные медиафайла:
{
"id": 1,
"name": "Audio1"
}
Передан некорректный ИД медиафайла:
{
"message": "The media id must be int.",
"code": 400
}
Пользователь не найден:
{
"message": "User not found.",
"code": 500
}
¶ Скачивание
GET api/v1/media/{media_id}/file
Метод позволяет скачать конкретный медиафайл.
¶ Параметры и примеры запроса
Path
media_idstring
⁎ ИД медиафайлаi
curl -X GET \
-G "https://restapi.plusofon.ru/api/v1/media/1/file" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Client: 10553" \
-H "Authorization: Bearer {token}"
const url = new URL(
"https://restapi.plusofon.ru/api/v1/media/1/file"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Client": "10553",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://restapi.plusofon.ru/api/v1/media/1/file',
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Client' => '10553',
'Authorization' => 'Bearer {token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://restapi.plusofon.ru/api/v1/media/1/file'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Client': '10553',
'Authorization': 'Bearer {token}'
}
response = requests.request('GET', url, headers=headers)
response.json()
¶ Структура и примеры ответа
В ответе может возвращаться:
-
success
признак успешно выполненного запроса -
message
сообщение об ошибке
Медиафайл успешно скачан:
null
Передан некорректный ИД медиафайла:
{
"message": "The media id must be int.",
"code": 400
}
Пользователь не найден:
{
"message": "User not found.",
"code": 500
}
¶ Создание
POST api/v1/media
Метод позволяет загрузить новый медиафайл.
¶ Параметры и примеры запроса
Body
-
namestring
⁎ название медиафайла -
filestring / Base64
⁎ при загрузке своего файла — медиафайл, закодированный в Base64 -
file_mime_typestring
⁎ при загрузке своего файла — тип медиафайла
возможные варианты:
-
mp3 -
wav -
au -
aiff -
gsm -
ogg -
raw
standard_idstring
⁎ при использовании предустановленного файла — ИД стандартного медиафайлаi
curl -X POST \
"https://restapi.plusofon.ru/api/v1/media" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Client: 10553" \
-H "Authorization: Bearer {token}" \
-d '{"name":"deleniti","file":"qui","file_mime_type":"tempora","standard_id":"accusantium"}'
const url = new URL(
"https://restapi.plusofon.ru/api/v1/media"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Client": "10553",
"Authorization": "Bearer {token}",
};
let body = {
"name": "deleniti",
"file": "qui",
"file_mime_type": "tempora",
"standard_id": "accusantium"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
$client = new \GuzzleHttp\Client();
$response = $client->post(
'https://restapi.plusofon.ru/api/v1/media',
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Client' => '10553',
'Authorization' => 'Bearer {token}',
],
'json' => [
'name' => 'deleniti',
'file' => 'qui',
'file_mime_type' => 'tempora',
'standard_id' => 'accusantium',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://restapi.plusofon.ru/api/v1/media'
payload = {
"name": "deleniti",
"file": "qui",
"file_mime_type": "tempora",
"standard_id": "accusantium"
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Client': '10553',
'Authorization': 'Bearer {token}'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
¶ Структура и примеры ответа
В ответе может возвращаться:
-
success
признак успешно выполненного запроса -
message
сообщение об ошибке
Файл успешно добавлен:
{
"success": true
}
Пользователь не найден:
{
"message": "User not found.",
"code": 500
}
¶ Переименование
PATCH api/v1/media/{media_id}
Метод позволяет переименовать конкретный медиафайл.
¶ Параметры и примеры запроса
curl -X PATCH \
"https://restapi.plusofon.ru/api/v1/media/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Client: 10553" \
-H "Authorization: Bearer {token}" \
-d '{"name":"corrupti"}'
const url = new URL(
"https://restapi.plusofon.ru/api/v1/media/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Client": "10553",
"Authorization": "Bearer {token}",
};
let body = {
"name": "corrupti"
}
fetch(url, {
method: "PATCH",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
$client = new \GuzzleHttp\Client();
$response = $client->patch(
'https://restapi.plusofon.ru/api/v1/media/1',
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Client' => '10553',
'Authorization' => 'Bearer {token}',
],
'json' => [
'name' => 'corrupti',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://restapi.plusofon.ru/api/v1/media/1'
payload = {
"name": "corrupti"
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Client': '10553',
'Authorization': 'Bearer {token}'
}
response = requests.request('PATCH', url, headers=headers, json=payload)
response.json()
¶ Структура и примеры ответа
В ответе может возвращаться:
-
success
признак успешно выполненного запроса -
message
сообщение об ошибке
Медиафайл успешно переименован:
{
"success": true
}
Передан некорректный ИД медиафайла:
{
"message": "The media id must be int.",
"code": 400
}
Пользователь не найден:
{
"message": "User not found.",
"code": 500
}
¶ Удаление
DELETE api/v1/media/{media_id}
Метод позволяет удалить конкретный медиафайл.
¶ Параметры и примеры запроса
Path
media_idstring
⁎ ИД медиафайлаi
curl -X DELETE \
"https://restapi.plusofon.ru/api/v1/media/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Client: 10553" \
-H "Authorization: Bearer {token}"
const url = new URL(
"https://restapi.plusofon.ru/api/v1/media/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Client": "10553",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "DELETE",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
$client = new \GuzzleHttp\Client();
$response = $client->delete(
'https://restapi.plusofon.ru/api/v1/media/1',
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Client' => '10553',
'Authorization' => 'Bearer {token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://restapi.plusofon.ru/api/v1/media/1'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Client': '10553',
'Authorization': 'Bearer {token}'
}
response = requests.request('DELETE', url, headers=headers)
response.json()
¶ Структура и примеры ответа
В ответе может возвращаться:
-
success
признак успешно выполненного запроса -
message
сообщение об ошибке
Медиафайл успешно удалён:
{
"success": true
}
Передан некорректный ИД медиафайла:
{
"message": "The media id must be int",
"code": 400
}
Пользователь не найден:
{
"message": "User not found",
"code": 500
}
¶ Стандартные файлы: получение списка
GET api/v1/standard-media
Метод позволяет получить список всех стандартных предустановленных медиафайлов.
¶ Параметры и примеры запроса
Не имеет параметров.
curl -X GET \
-G "https://restapi.plusofon.ru/api/v1/standard-media" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Client: 10553" \
-H "Authorization: Bearer {token}"
const url = new URL(
"https://restapi.plusofon.ru/api/v1/standard-media"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Client": "10553",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://restapi.plusofon.ru/api/v1/standard-media',
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Client' => '10553',
'Authorization' => 'Bearer {token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://restapi.plusofon.ru/api/v1/standard-media'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Client': '10553',
'Authorization': 'Bearer {token}'
}
response = requests.request('GET', url, headers=headers)
response.json()
¶ Структура и примеры ответа
В ответе возвращается массив "standard_media":
-
id
ИД медиафайла -
name
название медиафайла
Получен список стандартных предустановленных медиафайлов:
{
"standard_media": [
{
"id": "f6965c7eadb44c1a5aae6b99df4da814",
"name": "Секретарь"
},
{
"id": "63f9bbe47348c08087534432f998cd5a",
"name": "Приветствие"
},
{
"id": "d05eb4c20c64e057db5b677391dfac59",
"name": "Голосовая почта"
},
{
"id": "774e60095c71fbc4553e5029ad113658",
"name": "Тех-поддержка"
}
]
}
Пользователь не найден:
{
"message": "User not found.",
"code": 500
}
