JavaScript is disabled. For a better experience, please enable JavaScript in your browser before proceeding.
You are using an out of date browser. It may not display this or other websites correctly.
You should upgrade or use an
alternative browser .
Конечные точки Views Views: 608 Last updated Last updated: Sep 11, 2021
page integer Номер страницы cutoff integer Временная метка UnixTime самого старого уведомления для включения. Обратите внимание, что непрочитанные и непросмотренные уведомления всегда включены. unviewed bool Если верно, получает только непросмотренные уведомления unread bool Если верно, получает только непрочитанные уведомления
to_user_id integer ID пользователя для получения оповещения alert string Текст оповещения. Можно использовать заполнитель "{link}" для автоматической вставки ссылки from_user_id integer Если указано, пользователь, от которого отправляется оповещение. В противном случае используется текущий пользователь API . Может быть 0 для анонимного оповещения link_url string Заполнитель {link} link_title string Название заполнителя {link}
success bool Результат запроса. Может быть только true
read bool Если указано, помечает все уведомления как прочитанные viewed bool Если указано, помечает все уведомления как просмотренные
success bool Результат запроса. Может быть только true
alert UserAlert Сущность UserAlert указанного ID
read bool Если указано, помечает уведомление как прочитанное unread bool Если указано, помечает уведомление как непрочитанное viewed bool Если указано, помечает уведомление как просмотренное
success bool Результат запроса. Может быть только true
attachment Attachment Сущность Attachment с информацией о загруженном файле
attachment_key_user_wrong Срабатывает, если пользователь, отправляющий запрос, не соответствует пользователю, создавшему ключ вложения.
type string Тип содержимого вложения. Типы по умолчанию включают post, conversation_message. context string[] Пары ключ-значение, представляющие контекст вложения. Это зависит от типа содержимого и выполняемого действия. attachment file Первое вложение, которое будет связано с новым ключом.
key string Созданный ключ вложения. Его следует использовать для загрузки дополнительных файлов или для связывания загруженных вложений с другим содержимым. attachment Attachment Если был предоставлен файл и загрузка прошла успешно, здесь будет описано новое вложение.
attachment Attachment Сущность Attachment с информацией о файле
success bool Результат запроса. Может быть только true
data binary Выводятся непосредственно двоичные данные, а не JSON.
url string URL-адрес миниатюры.
not_found Не найдено, если вложение не имеет миниатюры
login string Имя пользователя или адрес электронной почты пользователя для тестирования password string Пароль пользователя limit_ip string IP-адрес, который следует считать выполняющим запрос. Если он указан, он будет использоваться для предотвращения попыток перебора.
user User В случае успеха, пользовательская запись совпадающего пользователя
session_id string Если указано, проверяет наличие активной сессии с этим идентификатором. remember_cookie string Если указано, проверяет, является ли активным значение cookie "запомнить меня".
success bool Если false, то не удалось найти сессионный или запоминающий файл cookie user User В случае успеха - запись пользователя, с которым произошел контакт. Может быть гостем.
user_id integer ID пользователя limit_ip string Если указано, фиксирует токен на указанном IP для дополнительной безопасности return_url string Если указано, то после входа в систему пользователь будет возвращен на этот URL. В противном случае он попадет в индекс форума. force bool Если задано, URL входа будет принудительно заменять текущего вошедшего пользователя, если пользователь уже вошел в систему и отличается от текущего вошедшего пользователя. По умолчанию установлено значение false. remember bool Управляет тем, будет ли cookie "remember me" устанавливаться при входе пользователя в систему. По умолчанию установлено значение true.
login_token string Токен входа login_url string Прямая ссылка на вход в аккаунт expiry_date integer Временная метка Unix, когда истекает срок действия токена. Если срок действия маркера истек или он недействителен, будет выдана ошибка.
conversation_id integer ID переписки message string Сообщение attachment_key string Ключ вложения API для загрузки файлов. Тип содержимого ключа вложения должен быть conversation_message с контекстом [conversation_id], установленным на данный идентификатор переписки.
message string Содержимое нового сообщения attachment_key string Ключ вложения API для загрузки файлов. Тип содержимого ключа вложения должен быть conversation_message с контекстом [message_id], установленным на ID этого сообщения.
reaction_id integer Идентификатор реакции для использования. Для отмены используйте идентификатор текущей реакции.
success bool Результат запроса. Может быть только true action string "insert" или "delete" в зависимости от того, была ли реакция добавлена или удалена.
page integer Номер страницы starter_id integer Отправитель receiver_id integer Получатель starred bool Получает только избранные переписки, если указано unread bool Получает только непрочитанные переписки, если указано
recipient_ids integer[] Список идентификаторов пользователей для отправки беседы title string Название переписки message string Тело сообщения переписки attachment_key string Ключ вложения API для загрузки файлов. Тип содержимого ключа вложения должен быть conversation_message без контекста. conversation_open bool Если false, то ответы на переписку не могут быть сделаны. open_invite bool Если true, то любой участник переписки может добавлять других.
success bool Результат запроса. Может быть только true conversation Conversation Сущность созданной переписки
with_messages bool Если указано, ответ будет включать страницу с сообщениями. page integer Страница сообщений, которые необходимо включить
title string Название переписки open_invite bool Если true, то любой участник переписки может добавлять других. conversation_open bool Если false, то ответы на переписку не могут быть сделаны.
success bool Результат запроса. Может быть только true conversation Conversation Сущность обновленной переписки
ignore bool Если true, дальнейшие ответы на эту переписку будут игнорироваться. (В противном случае ответы вернут эту переписку в список).
success bool Результат запроса. Может быть только true
recipient_ids integer[] Список идентификаторов пользователей, которых нужно пригласить
success bool Результат запроса. Может быть только true
date integer Временная метка Unix для отметки прочитанной переписки. Если не указано, по умолчанию используется текущее время.
success bool Результат запроса. Может быть только true
success bool Результат запроса. Может быть только true
star bool Если указано, устанавливает указанный статус. Если не указан, переключает статус.
success bool Результат запроса. Может быть только true
with_threads bool Если true, получает страницу с темами на этом форуме page integer Страница prefix_id integer Фильтрует темы с указанным префиксом. starter_id integer Фильтрует темы, начатые указанным идентификатором пользователя. last_days integer Фильтрует темы, в которых был получен ответ за последние X дней. unread bool Фильтрует только непрочитанные темы. Игнорируется для гостей. thread_type string Фильтрует темы по указанному типу тем. order string Метод упорядочивания: last_post_date, post_date. В контексте конкретного форума: title, reply_count, view_count, vote_score, first_post_reaction_score. direction string Либо "asc", либо "desc" для возрастания или убывания. Применяется, только если указан порядок.
forum Forum Сущность запрошенного форума threads Thread[] Темы на этой странице pagination pagination Информация о странице sticky Thread[] Если на странице 1, то список закрепленных тем на этом форуме. Не учитывается в лимите на страницу.
date integer Временная метка Unix для отметки чтения форума. Если не указано, по умолчанию используется текущее время.
success bool Результат запроса. Может быть только true
prefix_id integer Фильтрует темы с указанным префиксом. starter_id integer Фильтрует темы, начатые указанным идентификатором пользователя. last_days integer Фильтрует темы, в которых был получен ответ за последние X дней. unread bool Фильтрует только непрочитанные темы. Игнорируется для гостей. thread_type string Фильтрует темы по указанному типу тем. order string Метод упорядочивания: last_post_date, post_date. В контексте конкретного форума: title, reply_count, view_count, vote_score, first_post_reaction_score. direction string Либо "asc", либо "desc" для возрастания или убывания. Применяется, только если указан порядок.
threads Thread[] Темы на этой странице pagination pagination Информация о странице sticky Thread[] Если на странице 1, то список закрепленных тем на этом форуме. Не учитывается в лимите на страницу.
version_id integer ID версии XenForo site_title string Название сайта, к которому относится данный API base_url string Базовый URL установки XenForo, к которой относится этот API api_url string Базовый URL-адрес API key[type] string Тип ключа доступа к API (гость, пользователь или суперюзер) key[user_id] integer Если это ключ пользователя, то идентификатор пользователя, для которого предназначен ключ; в противном случае null key[allow_all_scopes] bool Если true, список всех scopes key[scopes] string[] Список scopes, к которым может получить доступ этот ключ (если не разрешен доступ ко всем scopes)
me User Информация о пользователе API
option[creation_watch_state] string option[interaction_watch_state] string option[content_show_signature] bool option[email_on_conversation] bool option[push_on_conversation] bool option[receive_admin_email] bool option[show_dob_year] bool option[show_dob_date] bool profile[location] string profile[website] string profile[about] string profile[signature] string privacy[allow_view_profile] string privacy[allow_post_profile] string privacy[allow_receive_news_feed] string privacy[allow_send_personal_conversation] string privacy[allow_view_identities] string visible bool active_visible bool timezone string custom_title string custom_fields[<name>] string
success bool Результат запроса. Может быть только true
avatar file Загруженный новый аватар
success bool Результат запроса. Может быть только true
success bool Результат запроса. Может быть только true
success bool Результат запроса. Может быть только true confirmation_required bool True, если для этого изменения требуется подтверждение по электронной почте
success bool Результат запроса. Может быть только true
tree_map array Связка, соединяющая идентификаторы родительских узлов со списком идентификаторов их дочерних узлов nodes Node[] Список всех узлов
node[title] string node[node_name] string node[description] string node[parent_node_id] integer node[display_order] integer node[display_in_list] bool type_data array Данные узла, относящиеся к конкретному типу. Доступные опции зависят от типа узла. node_type_id string
node Node Информация о созданном узле
nodes_flat array Массив. Каждая запись содержит ключи "node" и "depth".
node[title] string node[node_name] string node[description] string node[parent_node_id] integer node[display_order] integer node[display_in_list] bool type_data array Данные узла, относящиеся к конкретному типу. Доступные опции зависят от типа узла.
node Node Обновленная информация об узле
delete_children bool Если true, дочерние узлы будут удалены. В противном случае они будут подключены к родителю этого узла.
success bool Результат запроса. Может быть только true
thread_id integer ID темы, на которую нужно ответить. message string attachment_key string Ключ вложения API для загрузки файлов. Тип контекста ключа вложения должен быть post, а context[thread_id] должен быть установлен на ID этой темы.
message string silent bool Если true и разрешения позволяют, эта правка не будет обновляться с указанием "последнее редактирование". clear_edit bool Если true и разрешения позволяют, все указания на "последнее редактирование" будут удалены. Требуется "silent". author_alert bool author_alert_reason string attachment_key string Ключ вложения API для загрузки файлов. Тип контекста ключа вложения должен быть post, а context[post_id] должен быть установлен на ID этого поста.
success bool Результат запроса. Может быть только true post Post
success bool Результат запроса. Может быть только true
true mixed Success new_solution_post Post Пост, который был отмечен как решение old_solution_post Post Пост, не отмеченное как решение
reaction_id integer Идентификатор реакции для использования. Для отмены используйте идентификатор текущей реакции.
success true action string "insert" или "delete" в зависимости от того, была ли реакция добавлена или удалена.
type string Тип голосования, "up" или "down". Используйте текущий тип для отмены.
success true action string "insert" или "delete" в зависимости от того, была ли реакция добавлена или удалена.
profile_post_id integer Идентификатор сообщения профиля, к которому будет прикреплен этот комментарий. message string attachment_key string Ключ вложения API для загрузки файлов. Тип контекста ключа вложения должен быть profile_post_comment, а context[profile_post_id] должен соответствовать ID сообщения профиля.
message string author_alert bool author_alert_reason bool attachment_key string Ключ вложения API для загрузки файлов. Тип контекста ключа вложения должен быть profile_post_comment, а context[profile_post_comment_id] должен быть установлен на ID комментария этого сообщения профиля.
reaction_id integer Идентификатор реакции для использования. Для отмены используйте идентификатор текущей реакции.
success true action string "insert" или "delete" в зависимости от того, была ли реакция добавлена или удалена.
user_id integer Идентификатор пользователя, в профиле которого будет размещена эта информация. message string attachment_key string Ключ вложения API для загрузки файлов. Тип контекста ключа вложения должен быть profile_post, а context[profile_user_id] должен быть установлен на данный идентификатор пользователя.
with_comments bool Если указано, ответ будет включать страницу комментариев. page integer Страница комментариев для включения direction string Запрос определенного порядка сортировки комментариев - по умолчанию 'desc' (самые новые первыми), также допускается 'asc' (самые старые первыми)
message string author_alert bool author_alert_reason bool attachment_key string Ключ вложения API для загрузки файлов. Тип контекста ключа вложения должен быть profile_post, а context[profile_post_id] должен быть установлен на ID этого сообщения профиля.
page integer direction string Запрос определенного порядка сортировки комментариев - по умолчанию 'desc' (самые новые первыми), также допускается 'asc' (самые старые первыми)
reaction_id integer Идентификатор реакции для использования. Для отмены используйте идентификатор текущей реакции.
success true action string "insert" или "delete" в зависимости от того, была ли реакция добавлена или удалена.
with_threads bool Если true, получает страницу тем в этом поисковом форуме page integer
search_forum SearchForum threads Thread[] Темы на этой странице. Примечание: при этом всегда будут соблюдаться разрешения пользователя на просмотр, независимо от того, настроен ли API на обход разрешений. pagination pagination Сведения о страницах sticky Thread[] Если на странице 1, то список закрепленных тем на этом форуме. Не учитывается в лимите на страницу.
threads Thread[] Темы на этой странице. Примечание: при этом всегда будут соблюдаться разрешения пользователя на просмотр, независимо от того, настроен ли API на обход разрешений. pagination pagination Сведения о страницах sticky Thread[] Если на странице 1, то список закрепленных тем на этом форуме. Не учитывается в лимите на страницу.
page integer prefix_id integer Фильтрует темы с указанным префиксом. starter_id integer Фильтрует темы, начатые указанным идентификатором пользователя. last_days integer Фильтрует темы, в которых был получен ответ за последние X дней. unread bool Фильтрует только непрочитанные темы. Игнорируется для гостей. thread_type string Фильтрует темы указанного типа темы. order string Метод сортировки: last_post_date, post_date. В контексте конкретного форума: title, reply_count, view_count, vote_score, first_post_reaction_score. direction string Либо "asc", либо "desc" для возрастания или убывания. Применяется, только если указан порядок.
node_id integer ID форума, в котором будет создана тема. title string Название темы. message string Тело первого сообщения в теме. discussion_type string Тип темы, которую необходимо создать. Для конкретных типов может потребоваться дополнительный ввод. prefix_id integer Идентификатор префикса, применяемого к теме. Если он не действителен в выбранном форуме, то будет проигнорирован. tags string[] Массив тегов для применения к теме. custom_fields[<name>] string Значение для применения к пользовательскому полю с указанным именем. discussion_open bool sticky bool attachment_key string API-ключ вложения для загрузки файлов. Тип контекста ключа вложения должен быть post с context[node_id], установленным на ID форума, в котором он размещается.
no_permission No permission error.
with_posts bool Если указано, ответ будет включать страницу сообщений. page integer Страница сообщений для включения with_first_post bool Если указано, ответ будет содержать первое сообщение в теме. with_last_post bool Если указано, ответ будет содержать последнее сообщение в теме. order string Фильтрует только непрочитанные темы. Игнорируется для гостей.
thread Thread first_unread Post Если тема не прочитана, информация о первом непрочитанном сообщении. first_post Post По запросу, информация о первом сообщении в теме. last_post Post По запросу, информация о последнем сообщении в теме. pinned_post Post Прикрепленное первое сообщение темы, если оно определено типом темы. highlighted_posts Post[] Список выделенных сообщений, если они соответствуют типу темы. Причина выделения зависит от типа темы. posts Post[] Список сообщений на запрашиваемой странице. Обратите внимание, что даже если первое сообщение прикреплено, оно будет включено сюда. pagination pagination Сведения о страницах
date integer Временная метка Unix для отметки прочтения темы. Если не указано, по умолчанию используется текущее время.
target_node_id integer prefix_id integer Если задано, обновляет префикс темы. Префикс должен быть действительным в целевом форуме. title string Если установлено, обновляет заголовок темы notify_watchers bool Если true, пользователи, просматривающие целевой форум, получат уведомление, как если бы эта тема была создана в целевом форуме. starter_alert bool Если true, то создатель темы получит уведомление о перемещении. starter_alert_reason bool
page integer order string Запрос определенного порядка сортировки сообщений из доступных вариантов для типа темы
pinned_post Post Прикрепленное первое сообщение темы, если оно определено типом темы. highlighted_posts Post[] Список выделенных сообщений, если они соответствуют типу темы. Причина выделения зависит от типа темы. posts Post[] Список сообщений на запрашиваемой странице. Обратите внимание, что даже если первое сообщение прикреплено, оно будет включено сюда. pagination pagination Сведения о страницах
type string Тип голосования, "up" или "down". Используйте текущий тип для отмены.
success true action string "insert" или "delete" в зависимости от того, была ли реакция добавлена или удалена.
option[creation_watch_state] string option[interaction_watch_state] string option[content_show_signature] bool option[email_on_conversation] bool option[push_on_conversation] bool option[receive_admin_email] bool option[show_dob_year] bool option[show_dob_date] bool profile[location] string profile[website] string profile[about] string profile[signature] string privacy[allow_view_profile] string privacy[allow_post_profile] string privacy[allow_receive_news_feed] string privacy[allow_send_personal_conversation] string privacy[allow_view_identities] string visible bool activity_visible bool timezone string custom_title string option[is_discouraged] bool username string email string user_group_id integer secondary_group_ids integer[] user_state string is_staff bool message_count integer reaction_score integer trophy_points integer username_change_visible bool Если значение true и имя пользователя изменено, изменение будет заметно (показано в публичном списке предыдущих имен пользователей). password string dob[day] integer dob[month] integer dob[year] integer custom_fields[<name>] string
user User Пользователь, точно соответствующий заданному электронному адресу
exact User Пользователь, который точно соответствует заданному имени пользователя recommendations User[] Список пользователей, которые соответствуют префиксу имени пользователя (но не точно)
with_posts bool Если указано, ответ будет включать страницу сообщений профиля. page integer Страница комментариев для включения
option[creation_watch_state] string option[interaction_watch_state] string option[content_show_signature] bool option[email_on_conversation] bool option[push_on_conversation] bool option[receive_admin_email] bool option[show_dob_year] bool option[show_dob_date] bool profile[location] string profile[website] string profile[about] string profile[signature] string privacy[allow_view_profile] string privacy[allow_post_profile] string privacy[allow_receive_news_feed] string privacy[allow_send_personal_conversation] string privacy[allow_view_identities] string visible bool activity_visible bool timezone string custom_title string option[is_discouraged] bool username string email string user_group_id integer secondary_group_ids integer[] user_state string is_staff bool message_count integer reaction_score integer trophy_points integer username_change_visible bool Если значение true и имя пользователя изменено, изменение будет заметно (показано в публичном списке предыдущих имен пользователей). password string dob[day] integer dob[month] integer dob[year] integer custom_fields[<name>] string
rename_to string Если указано, пользователь будет переименован перед удалением
avatar file Загруженный новый аватар
profile_posts ProfilePost[] Список постов профиля на запрашиваемой странице pagination pagination Сведения о страницах
delete_children bool If true, child nodes will be deleted. Otherwise, they will be connected to this node's parent.