From b4746713a364442a257cbf55a53dbe032298e8cf Mon Sep 17 00:00:00 2001 From: ChronosX88 Date: Sun, 13 May 2018 20:11:54 +0300 Subject: [PATCH] Update API.md --- doc/ru/API.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/doc/ru/API.md b/doc/ru/API.md index 706678c..59ba298 100644 --- a/doc/ru/API.md +++ b/doc/ru/API.md @@ -37,13 +37,13 @@ API - ядро мессенджера. Достаточно подключить Структура сообщения в JSON: ```json -{ "peerSender":"*IPv6*", "peerReceiver":"*IPv6*", "action":"send", "msgID":"*ID сообщения в чате*","msgText":"*сообщение*", "timestamp":"*время*", "enctype":"" } +{ "peerSender":"*IPv6*", "peerReceiver":"*IPv6*", "action":"send", "chatID":"*Идентификатор чата, у обоих он одинаковый*", "msgID":"*ID сообщения в чате*","msgText":"*сообщение*", "timestamp":"*время*", "enctype":"" } ``` ответ: ```json -{ "peerSender":"*IPv6 отправителя, т.е. кому доставили сообщение*", "peerReceiver":"*IPv6 получателя, т.е. кто отправил сообщение*", "action":"sendSuccess", "msgID":"*ID сообщения, которое доставлено, в чате*", "status": true } +{ "peerSender":"*IPv6 отправителя, т.е. кому доставили сообщение*", "peerReceiver":"*IPv6 получателя, т.е. кто отправил сообщение*", "action":"sendSuccess", "chatID":"*Идентификатор чата, у обоих он одинаковый*", "msgID":"*ID сообщения, которое доставлено, в чате*", "status": true } ``` Сообщение может должно быть зашифровано, метод шифрования указан в поле `enctype`. @@ -64,11 +64,11 @@ API - ядро мессенджера. Достаточно подключить { "peerID":"*IPv6*", "action":"pong" } ``` -Если у нас есть сообщения для адреса и он онлайн (last_connect < 1 минуты), то передаём их +Если у нас есть сообщения для адреса и он онлайн (last_connect < 1 минуты), то передаём их. Если для этого адрес в базе есть недоставленные сообщения, то отправляем такой запрос: ```json -{ "action": "history", "messages":[{},{},{}...] } +{ "action":"history", "messages":[{},{},{}...] } ``` ответ: @@ -86,14 +86,13 @@ API - ядро мессенджера. Достаточно подключить Для ретрансляции можно также использовать свой сервер в интернете, нужно просто его добавить в контакты. ```json -{ "action":"resend", ... } +{ "peerSender":"*IPv6*", "peerReceiver":"*IPv6*", "action":"resend", "chatID":"*Идентификатор чата, у обоих он одинаковый*", "msgID":"*ID сообщения в чате*","msgText":"*сообщение*", "timestamp":"*время*", "enctype":"" } ``` -Параметры такие же как и для send -ответ +Ответ: ```json -{ "status":1 } +{ "peerID":"*IPv6*", "action":"resendSuccess","status":true } ``` Если `status == 0` - то эта нода не желает пересылать сообщения и ей повторно отправлять не нужно.