API › Личные сообщения

Личные сообщения im

20 actions · URL: /api.php?act=<name> или /api/v1/im/<action>

im_load_users GET /api.php?act=im_load_users auth read

Список диалогов пользователя.

Параметры

имятипreqописание
start int нет
limit int нет 1..100
rate-limit: 120 / 1 мин на user
im_show_history GET /api.php?act=im_show_history auth read

История сообщений в диалоге.

Параметры

имятипreqописание
convo_id int да
start int нет
limit int нет
rate-limit: 120 / 1 мин на user
im_unread_total GET /api.php?act=im_unread_total auth read

Количество непрочитанных диалогов.

rate-limit: 120 / 1 мин на user
im_send POST /api.php?act=im_send auth write csrf

Отправить текстовое сообщение в диалог.

Параметры

имятипreqописание
convo_id int да
text string да

Ответ result

pm_id
int
rate-limit: 60 / 1 мин на user
im_send_voice POST /api.php?act=im_send_voice auth write csrf

Прикрепить голосовое сообщение. voice_id — id из upload-эндпоинта.

Параметры

имятипreqописание
convo_id int да
voice_id int да
rate-limit: 20 / 1 мин на user
im_send_circle POST /api.php?act=im_send_circle auth write csrf

Прикрепить видео-кружок.

Параметры

имятипreqописание
convo_id int да
circle_id int да
rate-limit: 20 / 1 мин на user
im_mark_read POST /api.php?act=im_mark_read auth write csrf

Пометить диалог прочитанным.

Параметры

имятипreqописание
convo_id int да
rate-limit: 30 / 1 мин на user
im_delete_pm POST /api.php?act=im_delete_pm auth write csrf

Удалить одно сообщение.

Параметры

имятипreqописание
pm_id int да
rate-limit: 30 / 1 мин на user
im_edit_pm POST /api.php?act=im_edit_pm auth write csrf

Редактировать своё сообщение.

Параметры

имятипreqописание
pm_id int да
text string да
rate-limit: 30 / 1 мин на user
im_delete_convo POST /api.php?act=im_delete_convo auth write csrf

Удалить весь диалог (только у себя).

Параметры

имятипreqописание
convo_id int да
rate-limit: 30 / 1 мин на user
im_start POST /api.php?act=im_start auth write csrf

Найти или создать 1:1 диалог с пользователем (без обязательного первого сообщения).

Параметры

имятипreqописание
user_id int user_id или username
username string user_id или username

Ответ result

convo_id
int
created
bool
rate-limit: 30 / 1 мин на user
im_start_group POST /api.php?act=im_start_group auth write csrf

Создать групповой диалог (3+ участников включая себя).

Параметры

имятипreqописание
user_ids string|array да 2+ peer user_id через запятую или массив
subject string нет

Ответ result

convo_id
int
created
bool
rate-limit: 20 / 1 мин на user
im_add_peers POST /api.php?act=im_add_peers auth write csrf

Добавить участников в диалог (станет групповым при recipients > 2).

Параметры

имятипreqописание
convo_id int да
user_ids string|array да
rate-limit: 30 / 1 мин на user
im_remove_peer POST /api.php?act=im_remove_peer auth write csrf

Удалить участника из группового диалога (только создатель, recipients > 2).

Параметры

имятипreqописание
convo_id int да
user_id int да peer
rate-limit: 30 / 1 мин на user
im_leave POST /api.php?act=im_leave auth write csrf

Выйти из диалога (удалить свою строку pmconvoops, обновить recipients).

Параметры

имятипreqописание
convo_id int да
rate-limit: 30 / 1 мин на user
im_set_subject POST /api.php?act=im_set_subject auth write csrf

Переименовать групповой диалог (участник, recipients > 2).

Параметры

имятипreqописание
convo_id int да
subject string да
rate-limit: 30 / 1 мин на user
im_convo_peers GET /api.php?act=im_convo_peers auth read

Список участников диалога (кроме текущего пользователя).

Параметры

имятипreqописание
convo_id int да
rate-limit: 120 / 1 мин на user
im_typing POST /api.php?act=im_typing auth write csrf

Сообщить, что пользователь печатает в диалоге.

Параметры

имятипreqописание
convo_id int да
rate-limit: 120 / 1 мин на user
im_typing_get GET /api.php?act=im_typing_get auth read

Кто печатает в диалоге (updated_at за последние 5 сек, без себя).

Параметры

имятипreqописание
convo_id int да
rate-limit: 120 / 1 мин на user