Список статей
GET https://api.usedesk.ru/support/{account_id}/articles/list, {account_id} — ID Базы знаний в системе.
Внимание. Если вы используете коробочную версию Юздеска на собственном сервере, URL методов у вас будет отличаться. Уточните URL для работы с API у поддержки — support@usedesk.ru.
Метод возвращает список статей.
* — обязательные поля
|
Параметр
|
Значение
|
|---|---|
| api_token* | Токен API канала |
| collection_ids |
ID разделов Можно передавать несколько значений через запятую |
| category_ids |
ID категорий Можно передавать несколько значений через запятую |
| article_ids |
ID статей Можно передавать несколько значений через запятую |
| count |
Количество статей на страницу По умолчанию: 20 Максимум: 100 |
| page |
Номер страницы По умолчанию: 1 |
| query |
Поисковая строка Поиск производится по заголовку и тексту статьи |
|
short_text |
Параметр, позволяющий отображать обрезанный поисковый результат Работает только совместно с query. Это означает, что если не искать ничего, то текст будет полный даже при short_text=1 Возможные значения:
|
| type |
Фильтрация по публичности статьи
По умолчанию выводятся все статьи. Учитывается приватность родительской категории. То есть, если категория статьи публичная, а родительская категория — приватная, то в выдачу с type=public она не попадёт |
| sort |
Параметр, по которому сортируются статьи Возможные варианты:
По умолчанию: id |
| order |
Порядок сортировки по параметру sort
По умолчанию: asc |
$baseId = 2;
$data = array(
'api_token'=> 'e1cbe1c1c9d910ef2ae975215644cb53dd555de4',
'query' => 'как',
'count' => 2
);
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://api.usedesk.ru/support/'. $baseId .'/articles/list?' . http_build_query($data));
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($curl);
curl_close($curl);
return $result;
{
"page": 1,
"last-page": 5,
"count": 2,
"total-count": 10,
"articles": [
{
"id": 96,
"title": "Как зарегистрироваться",
"text": "\u003Cp\u003EНажмите \u003Cem\u003EНачать \u003C\/em\u003E\u003Cbr\u003EЗаполните все поля\u003Cbr\u003EПодтвердите номер телефона\u003Cbr\u003EПроверьте почту \u003C\/p\u003E\u003Cp\u003Eнепубличный\u003C\/p\u003E",
"public": 0,
"active_until": {
"date": "2020-08-30 21:00:00.000000",
"timezone_type": 3,
"timezone": "UTC"
}
"order": 4,
"is_rating": 0,
"rating": {
"positive": 0,
"negative": 0
},
"category_id": 34,
"category_title": "Название категории",
"collection_id": 123,
"collection_title": "Название раздела",
"collection_image": "https://secure.usedesk.ru/upload/support/2/42/15427483037735cb7bb7f6a11874125e83c7d2ece15bf4788fd5f40.png",
"views": 23,
"created_at": "2017-08-02 06:14:41"
}, {
"id": 98,
"title": "Как зарегистрироваться 2",
"text": "\u003Cp\u003EНажмите \u003Cem\u003EНачать \u003C\/em\u003E\u003Cbr\u003EЗаполните все поля\u003Cbr\u003EПодтвердите номер телефона\u003Cbr\u003EПроверьте почту \u003C\/p\u003E",
"public": 1,
"order": 2,
"is_rating": 0,
"rating": {
"positive": 0,
"negative": 0
},
"category_id": 34,
"category_title": "Название категории",
"collection_id": 123,
"collection_title": "Название раздела",
"collection_image": "https://secure.usedesk.ru/upload/support/2/42/15427483037735cb7bb7f6a11874125e83c7d2ece15bf4788fd5f40.png",
"views": 46,
"created_at": "2017-09-21 17:47:50"
}
]
}
Описание ответа от сервера
| Параметр | Значение | ||||||||||||||||||||||||||||||||||||
| page | Текущая страница | ||||||||||||||||||||||||||||||||||||
| last-page | Количество статей на странице | ||||||||||||||||||||||||||||||||||||
| count | Количество страниц | ||||||||||||||||||||||||||||||||||||
| total-count | Общее количество статей | ||||||||||||||||||||||||||||||||||||
| articles | Массив со статьями
|