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