Files
Govor/docs/api-reference.md
Artemy 632ac04b56 Add forwarding, friend controls, and benefits
Add message forwarding and reply lookup, friend removal and blocking endpoints, and database-backed Govor+ privileges with customizable profile tags. Include migrations, integration tests, and updated API and operations documentation.
2026-10-31 18:29:40 +07:00

13 KiB

Карта HTTP API

Карта составлена по действующим атрибутам контроллеров ревизии a3401ce. Закомментированные методы не включены. Тела запросов, ответы и права описаны в связанных разделах; точную runtime-схему DTO также показывает /swagger/v1/swagger.json установленного сервера. Swagger может быть ограничен оператором.

По умолчанию нужен Bearer access token и активная сессия. Без JWT доступны register/login/challenge/login, refresh, проверки server и InvitationWithKey (последний требует adminKey). Остальные методы не становятся публичными от наличия ссылки-приглашения. purpose в маршрутах пароля — только change или reset. Числовые типы чата: 0 — личный, 1 — группа.

Для методов без тела успех может быть 204; не пытайтесь всегда разбирать JSON. Форматы ошибок — общий контракт.

Доступность

Метод Маршрут Назначение
GET /server/ping Процесс доступен
GET /server/ready БД доступна и миграции применены

InviteUserController

Подробное описание · Исходник

Метод Маршрут
POST /api/admin/InviteUser/Invitation
POST /api/admin/InviteUser/InvitationWithKey
GET /api/admin/InviteUser/GetAllActiveInvitations
GET /api/admin/InviteUser
GET /api/admin/InviteUser/{id}

ReactionPacksAdminController

Подробное описание · Исходник

Метод Маршрут
GET /api/admin/reaction-packs
GET /api/admin/reaction-packs/{packId}
POST /api/admin/reaction-packs
PUT /api/admin/reaction-packs/{packId}
DELETE /api/admin/reaction-packs/{packId}
POST /api/admin/reaction-packs/{packId}/reactions/emoji
POST /api/admin/reaction-packs/{packId}/reactions/media
DELETE /api/admin/reaction-packs/{packId}/reactions/{reactionId}

RequiredChannelController

Подробное описание · Исходник

Метод Маршрут
GET /api/admin/required-channel
PUT /api/admin/required-channel

UsersController

Подробное описание · Исходник

Метод Маршрут
GET /api/admin/Users/all
GET /api/admin/Users/{id}
POST /api/admin/Users/user/{id}/password

AuthController

Подробное описание · Исходник

Метод Маршрут
POST /api/Auth/register
POST /api/Auth/login
POST /api/Auth/password/challenge
POST /api/Auth/password/login
GET /api/Auth/password
PUT /api/Auth/password/enrollment
PUT /api/Auth/password/recovery
POST /api/Auth/password/{purpose}/challenge
POST /api/Auth/password/{purpose}/authorize
POST /api/Auth/password/change
POST /api/Auth/password/reset-encryption

RefreshController

Подробное описание · Исходник

Метод Маршрут
POST /api/auth/token/refresh

SessionKeysController

Подробное описание · Исходник

Метод Маршрут
POST /api/session/keys
GET /api/session/users/{userId}/keys
POST /api/session/keys/rotate
GET /api/session/keys/remaining
POST /api/session/keys/{preKeyId}/used

ChannelReactionsController

Подробное описание · Исходник

Метод Маршрут
GET /api/groups/{groupId}/reactions
PUT /api/groups/{groupId}/reactions

ChatLoadController

Подробное описание · Исходник

Метод Маршрут
GET /api/groups/{groupId}/messages
GET /api/user/{userId}/messages

E2eeController

Подробное описание · Исходник

Метод Маршрут
PUT /api/e2ee/device
GET /api/e2ee/recovery
GET /api/e2ee/identities/{peer}/changes
GET /api/e2ee/devices
PUT /api/e2ee/devices/certificate
GET /api/e2ee/conversations/{type}/{conversationId}/signers/{deviceSession}
PUT /api/e2ee/recovery
GET /api/e2ee/conversations/{type}/{conversationId}/keys

FriendshipController

Подробное описание · Исходник

Метод Маршрут
GET /api/friends/search
GET /api/friends

FriendsRequestQueryController

Подробное описание · Исходник

Метод Маршрут
GET /api/friends/requests
GET /api/friends/responses

GroupsController

Подробное описание · Исходник

Метод Маршрут
POST /api/groups
GET /api/groups/search
GET /api/groups/mine
GET /api/groups/{groupId}
PUT /api/groups/{groupId}
POST /api/groups/{groupId}/join
POST /api/groups/{groupId}/avatar
DELETE /api/groups/{groupId}/avatar
DELETE /api/groups/{groupId}/members/me
GET /api/groups/{groupId}/members
PUT /api/groups/{groupId}/members/{userId}/administrator
DELETE /api/groups/{groupId}/members/{userId}/administrator
PUT /api/groups/{groupId}/members/{userId}/ban
DELETE /api/groups/{groupId}/members/{userId}/ban
POST /api/groups/{groupId}/ownership/{userId}
POST /api/groups/{groupId}/invitations
GET /api/groups/{groupId}/invitations
DELETE /api/groups/{groupId}/invitations/{invitationId}
DELETE /api/groups/{groupId}/messages/{messageId}

InviteController

Подробное описание · Исходник

Метод Маршрут
GET /api/group-invites/{code}
GET /invite/{code}
POST /api/group-invites/{code}/join
POST /invite/{code}/join

MediaController

Подробное описание · Исходник

Метод Маршрут
POST /api/media/upload
GET /api/media/download/{id}

MessageReactionsController

Подробное описание · Исходник

Метод Маршрут
GET /api/messages/{messageId}/reactions
PUT /api/messages/{messageId}/reactions/me
DELETE /api/messages/{messageId}/reactions/me

MessageReadController

Подробное описание · Исходник

Метод Маршрут
POST /api/chats/{chatId}/read
GET /api/chats/{chatId}/unread-count

OnlinePingingController

Подробное описание · Исходник

Метод Маршрут
PATCH /api/online/ping
GET /api/online/status/{userId}

PrivateChatController

Подробное описание · Исходник

Метод Маршрут
GET /api/user/{friendId}/private-chat
GET /api/user/private-chats

ProfileController

Подробное описание · Исходник

Метод Маршрут
POST /api/profile/avatar
GET /api/profile/download/me
GET /api/profile/download/{id}

PushTokensController

Подробное описание · Исходник

Метод Маршрут
POST /api/pushes/token/register
DELETE /api/pushes/token

ReactionPacksController

Подробное описание · Исходник

Метод Маршрут
GET /api/reaction-packs
GET /api/reaction-packs/mine
GET /api/reaction-packs/{packId}
GET /api/reaction-packs/shared/{shareCode}
GET /api/reactions/{reactionId}
PUT /api/reaction-packs/{packId}/subscription
DELETE /api/reaction-packs/{packId}/subscription
GET /api/reaction-packs/limits

SessionController

Подробное описание · Исходник

Метод Маршрут
GET /api/Session/all
DELETE /api/Session/close/{sessionId}
DELETE /api/Session/close
DELETE /api/Session/close/all

SignalR

Команды сообщений находятся в ChatsHub, заявки — в FriendsHub. Подключения: /hubs/chats, /hubs/friends, /hubs/presence, /hubs/profiles. Пустой GroupsHub не опубликован как рабочий endpoint.