curl --request GET 'https://forum.arzguard.com/api/conversations/123/' \
--header "XF-Api-Key: $FORUM_API_KEY"
{
"conversation": {
"conversation_id": 123,
"title": "Пример переписки"
}
}
Личные диалоги
Получить переписку
Возвращает сведения о переписке и при необходимости страницу её сообщений.
GET
/
api
/
conversations
/
{id}
/
curl --request GET 'https://forum.arzguard.com/api/conversations/123/' \
--header "XF-Api-Key: $FORUM_API_KEY"
{
"conversation": {
"conversation_id": 123,
"title": "Пример переписки"
}
}
Возвращает сведения о переписке и при необходимости страницу её сообщений.
Поля
Ошибки возвращаются в общей структуре
Примеры сокращены и содержат только условные значения. Состав полей объектов зависит от прав, контекста и установленных дополнений.
messages и pagination добавляются только при with_messages=1. Получение переписки не заменяет явную отметку прочтения через POST-метод.
Доступ
ПередавайтеXF-Api-Key в заголовке каждого запроса. Типы ключей и выбор пользователя.
Требуемые scopes: conversation:read. Все перечисленные разрешения нужны одновременно.
Нужен контекст зарегистрированного пользователя. Для Super key укажите XF-Api-User; доступ к объектам и действиям проверяется отдельно от scopes.
Параметры
string
required
Секретный API-ключ. В примерах ключ берётся из серверной переменной
$FORUM_API_KEY.integer
required
Идентификатор переписки.
boolean
При
1 добавляет страницу сообщений и объект pagination к сведениям о переписке.integer
Номер страницы. Размер страницы задаётся настройками форума; отдельного параметра
per_page у этого метода нет.Ответ
HTTP200, JSON. Схемы объектов и условные поля.
Conversation
Сведения о переписке с учётом текущего участника.
ConversationMessage[]
Массив сообщений запрошенной страницы. Возвращается только при
with_messages=1.pagination
Сведения о странице:
current_page, last_page, per_page, shown, total. Возвращается только при with_messages=1.errors. Обрабатывайте поле code; текст message может меняться или переводиться. Формат ошибок.
curl --request GET 'https://forum.arzguard.com/api/conversations/123/' \
--header "XF-Api-Key: $FORUM_API_KEY"
{
"conversation": {
"conversation_id": 123,
"title": "Пример переписки"
}
}