curl --request GET \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Accept: application/json' \
'https://forum.arzguard.com/api/threads/123/posts?page=1'
{
"posts": [
{
"post_id": 123
}
],
"pagination": {
"current_page": 1,
"last_page": 1,
"per_page": 20,
"shown": 1,
"total": 1
}
}
Темы
Сообщения темы
Возвращает страницу сообщений темы с данными о закреплённых и выделенных сообщениях.
GET
/
api
/
threads
/
{id}
/
posts
curl --request GET \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Accept: application/json' \
'https://forum.arzguard.com/api/threads/123/posts?page=1'
{
"posts": [
{
"post_id": 123
}
],
"pagination": {
"current_page": 1,
"last_page": 1,
"per_page": 20,
"shown": 1,
"total": 1
}
}
Возвращает страницу сообщений темы с данными о закреплённых и выделенных сообщениях.
Обязательные scopes:
Доступ
В каждом запросе обязателен заголовокXF-Api-Key. Примеры используют серверную переменную $FORUM_API_KEY; тип ключа и контекст пользователя определяют доступ к данным.
string
required
Ключ API. Храните его на сервере интеграции; в примере используется переменная окружения.
thread:read.
Параметры
integer
required
ID темы. Значение
123 в примере условное.integer
Номер страницы. По умолчанию запрашивается первая страница; размер выдачи определяется настройками форума.
string
Порядок сообщений из набора, поддерживаемого типом темы. Универсальный список вариантов для всех типов не задаётся.
Успешный ответ
HTTP200. Пример ниже сокращён и содержит только условные данные. Полные объекты и условия видимости полей описаны в схемах данных.
| Поле | Тип | Описание |
|---|---|---|
pinned_post | Post | Закреплённое первое сообщение; возвращается, если тип темы предусматривает его закрепление. |
highlighted_posts | Post[] | Выделенные сообщения, если они определены типом темы. Причина выделения зависит от типа обсуждения. |
posts | Post[] | Сообщения выбранной страницы. Закреплённое первое сообщение не исключается из своей обычной позиции в этом массиве. |
pagination | pagination | Метаданные страницы: current_page, last_page, per_page, shown, total. Размер страницы определяется настройками форума. |
Ошибки
Стандартный ответ содержит массивerrors с code, message и params. Проверяйте HTTP-статус и машинный код; формат и обработка ошибок общие для API.
curl --request GET \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Accept: application/json' \
'https://forum.arzguard.com/api/threads/123/posts?page=1'
{
"posts": [
{
"post_id": 123
}
],
"pagination": {
"current_page": 1,
"last_page": 1,
"per_page": 20,
"shown": 1,
"total": 1
}
}