SHiNE-server/docs/API/12_Direct_Messages_Push_Calls_API.md

API для разработчиков: DM, push и сигналы звонков

Документ описывает публичные операции, связанные с личными сообщениями, WebPush и сигналами звонков.

Подробная логика DM и бинарного формата:

• docs/Personal_Messages/Протокол_DM_v1.md
• docs/Personal_Messages/Формат_DM_v1.md

Важно:

• legacy-операция SendDirectMessage отключена и не зарегистрирована в публичном API;
• для DM v1 нужно использовать SendMessagePair, ReceiveOutcomingMessage, ReceiveIncomingMessage, DeleteMessage, DeleteConversation, GetDirectMessages;
• DmSyncBatch предназначен для межсерверной догоняющей синхронизации, не для обычного клиентского UI.

1. UpsertPushToken

Требует авторизации.

Запрос

{
  "op": "UpsertPushToken",
  "requestId": "push-upsert-001",
  "payload": {
    "sessionId": "SESSION_ID",
    "endpoint": "https://push.example/...",
    "p256dhKey": "BASE64",
    "authKey": "BASE64",
    "platform": "web",
    "userAgent": "Mozilla/5.0 ..."
  }
}

Успешный ответ

{
  "op": "UpsertPushToken",
  "requestId": "push-upsert-001",
  "status": 200,
  "ok": true,
  "payload": {
    "tokenId": "token-1",
    "updatedAtMs": 1774700000123
  }
}

2. SendTestWebPush

Требует авторизации.

Запрос

{
  "op": "SendTestWebPush",
  "requestId": "push-test-001",
  "payload": {
    "login": "alice",
    "sessionId": "SESSION_ID",
    "title": "Test",
    "text": "Push body"
  }
}

3. SendMessagePair и ReceiveOutcomingMessage

ReceiveOutcomingMessage — алиас SendMessagePair.

Назначение

Передаёт пару signed DM-блоков:

• incomingBlobB64 — блок type=1 или type=3
• outgoingBlobB64 — блок type=2 или type=4

Все типы в этой паре используют бинарный формат SHiNE_DM.

Запрос

{
  "op": "SendMessagePair",
  "requestId": "dm-pair-001",
  "payload": {
    "incomingBlobB64": "BASE64_INCOMING_SIGNED_BLOCK",
    "outgoingBlobB64": "BASE64_OUTGOING_SIGNED_BLOCK"
  }
}

Успешный ответ

{
  "op": "SendMessagePair",
  "requestId": "dm-pair-001",
  "status": 200,
  "ok": true,
  "payload": {
    "baseKey": "from|to|time|nonce",
    "incomingKey": "from|to|time|nonce|1",
    "outgoingKey": "from|to|time|nonce|2",
    "deliveredWsSessions": 1,
    "deliveredWebPushSessions": 0
  }
}

Ошибки

• 400 / BAD_FIELDS — пустой incomingBlobB64 или outgoingBlobB64
• 400 / BAD_BLOCK_FORMAT — base64 или бинарный контейнер повреждён
• 400 / BAD_CRYPTO_METHOD — неподдерживаемый метод шифрования контейнера EncryptedBody_v1_0
• 404 / USER_NOT_FOUND — один из логинов не найден даже после попытки lazy-import из Solana PDA
• 460 / BAD_SIGNATURE — подпись блока не прошла проверку

4. ReceiveIncomingMessage

Принимает только один входящий signed DM-блок.

Назначение

Используется там, где нужно принять только incoming-вариант сообщения.

Принимаемые типы:

• type=1 — входящая копия сообщения
• type=3 — входящий read-receipt

Запрос

{
  "op": "ReceiveIncomingMessage",
  "requestId": "dm-in-001",
  "payload": {
    "incomingBlobB64": "BASE64_INCOMING_SIGNED_BLOCK",
    "sourceServerLogin": "server-a"
  }
}

sourceServerLogin необязателен. Если поле есть, сервер использует его как подсказку, чтобы не отправлять событие обратно серверу-источнику.

5. DeleteMessage

Принимает один signed DM-блок type=5 или type=6.

Запрос

{
  "op": "DeleteMessage",
  "requestId": "dm-del-001",
  "payload": {
    "blobB64": "BASE64_DELETE_BLOCK"
  }
}

6. DeleteConversation

Принимает один signed DM-блок type=7 или type=8.

Запрос

{
  "op": "DeleteConversation",
  "requestId": "dm-del-all-001",
  "payload": {
    "blobB64": "BASE64_DELETE_CONVERSATION_BLOCK"
  }
}

7. GetDirectMessages

Требует авторизации. Возвращает историю диалога с конкретным собеседником страницами.

Важно:

• начиная с 22 июля 2026 года сервер больше не высылает старую DM-историю автоматически при логине;
• после подключения клиент должен сам запросить первую страницу диалога;
• новые realtime-сообщения по-прежнему приходят событием SignedMessageArrived.
• в GetDirectMessages сервер отдаёт только обычные chat-сообщения (type=1/2), без read-receipt и delete/tombstone.

Запрос

{
  "op": "GetDirectMessages",
  "requestId": "dm-history-001",
  "payload": {
    "peerLogin": "bob",
    "limit": 50,
    "beforeTimeMs": 1774700000123,
    "beforeMessageKey": "alice|bob|1774700000123|123456789|1"
  }
}

beforeTimeMs и beforeMessageKey необязательны. Если их нет, сервер вернёт самую новую страницу.

Успешный ответ

{
  "op": "GetDirectMessages",
  "requestId": "dm-history-001",
  "status": 200,
  "ok": true,
  "payload": {
    "login": "alice",
    "peerLogin": "bob",
    "limit": 50,
    "hasMore": true,
    "nextBeforeTimeMs": 1774699999000,
    "nextBeforeMessageKey": "alice|bob|1774699999000|123456780|2",
    "messages": [
      {
        "messageKey": "alice|bob|1774700000123|123456789|1",
        "baseKey": "alice|bob|1774700000123|123456789",
        "fromLogin": "alice",
        "toLogin": "bob",
        "messageType": 1,
        "timeMs": 1774700000123,
        "nonce": 123456789,
        "revisionTimeMs": 0,
        "reencryptedAtMs": 0,
        "createdAtMs": 1774700001123,
        "readAtMs": 1774700001456,
        "blobB64": "BASE64_SIGNED_BLOCK"
      }
    ]
  }
}

Для следующей страницы клиент должен передать nextBeforeTimeMs и nextBeforeMessageKey из предыдущего ответа.

8. DmSyncBatch

Межсерверная операция для догоняющей синхронизации истории одного пользователя. В текущей реализации не требует авторизации сервера-источника, но удалённый сервер отдаёт данные только если сам является access-сервером ownerLogin по user_access_servers_current.

Запрос

{
  "op": "DmSyncBatch",
  "requestId": "dm-sync-001",
  "payload": {
    "ownerLogin": "alice",
    "afterStoredAtMs": 1774700000000,
    "afterMessageKey": "alice|bob|1774699999000|123456780|2",
    "limit": 500,
    "maxBytes": 3000000
  }
}

afterStoredAtMs и afterMessageKey образуют курсор. Если курсора нет, сервер передаёт 0 и пустую строку. limit ограничен максимумом 500.

Успешный ответ

{
  "op": "DmSyncBatch",
  "requestId": "dm-sync-001",
  "status": 200,
  "ok": true,
  "payload": {
    "ownerLogin": "alice",
    "limit": 500,
    "rawBytes": 84512,
    "hasMore": true,
    "nextStoredAtMs": 1774700100000,
    "nextMessageKey": "alice|bob|1774700000123|123456789|1",
    "items": [
      {
        "messageKey": "alice|bob|1774700000123|123456789|1",
        "baseKey": "alice|bob|1774700000123|123456789",
        "targetLogin": "alice",
        "fromLogin": "bob",
        "toLogin": "alice",
        "messageType": 1,
        "timeMs": 1774700000123,
        "storedAtMs": 1774700100000,
        "blobB64": "BASE64_SIGNED_BLOCK"
      }
    ]
  }
}

События в items идут по storedAtMs ASC, messageKey ASC. В пачке могут быть сообщения любых диалогов пользователя, read-receipt и delete/tombstone типов 5/6/7/8.

Ошибки:

• 400 / EMPTY_OWNER_LOGIN — не передан ownerLogin
• 403 / LOCAL_SERVER_NOT_ACCESS_SERVER — этот сервер не является access-сервером пользователя
• 500 / LOCAL_SERVER_NOT_CONFIGURED — не настроен server.SHiNE.login

9. AckSessionDelivery

Требует авторизации. Подтверждает доставку в текущую сессию.

Запрос

{
  "op": "AckSessionDelivery",
  "requestId": "ack-001",
  "payload": {
    "messageKey": "from|to|time|nonce|1"
  }
}

10. Событие SignedMessageArrived

Сервер присылает его по WebSocket в активные сессии адресата.

Payload события

{
  "messageKey": "from|to|time|nonce|1",
  "baseKey": "from|to|time|nonce",
  "fromLogin": "alice",
  "toLogin": "bob",
  "targetLogin": "bob",
  "messageType": 1,
  "timeMs": 1774700000123,
  "nonce": 123456789,
  "blobB64": "BASE64_SIGNED_BLOCK",
  "backlog": false
}

Если это новая ревизия того же письма, messageKey остаётся тем же, а revisionTimeMs меняется внутри бинарного блока.

Для типов 5/6/7/8 событие тоже приходит в таком же конверте, но логика применения определяется messageType и бинарным blobB64.

11. CallInviteBroadcast

Требует авторизации. Шлёт приглашение к звонку в активные сессии toLogin.

12. CallSignalToSession

Требует авторизации. Шлёт сигнал звонка в конкретную сессию.

13. Замечания

• все DM-типы 1..8 используют SHiNE_DM
• GetUser может lazy-import пользователя из Solana PDA, поэтому именно через него клиент обычно получает clientKey адресата для E2EE
• сервер не расшифровывает DM и не использует ciphertext как preview текста
• сервер хранит последнюю применённую версию контентного сообщения по правилу revisionTimeMs, а при равенстве — по reencryptedAtMs
• если сервер уже знает tombstone удаления переписки и получает старое сообщение до этой границы, он перерассылает известный DeleteConversation на access_servers обеих сторон
• HTTP endpoints для DM-файлов сейчас отсутствуют