Update API.md

This commit is contained in:
ChronosX88 2018-05-13 20:11:54 +03:00 committed by GitHub
parent ba84a53fdb
commit b4746713a3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -37,13 +37,13 @@ API - ядро мессенджера. Достаточно подключить
Структура сообщения в JSON: Структура сообщения в JSON:
```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 ```json
{ "peerSender":"*IPv6 отправителя, т.е. кому доставили сообщение*", "peerReceiver":"*IPv6 получателя, т.е. кто отправил сообщение*", "action":"sendSuccess", "msgID":"*ID сообщения, которое доставлено, в чате*", "status": true } { "peerSender":"*IPv6 отправителя, т.е. кому доставили сообщение*", "peerReceiver":"*IPv6 получателя, т.е. кто отправил сообщение*", "action":"sendSuccess", "chatID":"*Идентификатор чата, у обоих он одинаковый*", "msgID":"*ID сообщения, которое доставлено, в чате*", "status": true }
``` ```
Сообщение может должно быть зашифровано, метод шифрования указан в поле `enctype`. Сообщение может должно быть зашифровано, метод шифрования указан в поле `enctype`.
@ -64,7 +64,7 @@ API - ядро мессенджера. Достаточно подключить
{ "peerID":"*IPv6*", "action":"pong" } { "peerID":"*IPv6*", "action":"pong" }
``` ```
Если у нас есть сообщения для адреса и он онлайн (last_connect < 1 минуты), то передаём их Если у нас есть сообщения для адреса и он онлайн (last_connect < 1 минуты), то передаём их.
Если для этого адрес в базе есть недоставленные сообщения, то отправляем такой запрос: Если для этого адрес в базе есть недоставленные сообщения, то отправляем такой запрос:
```json ```json
@ -86,14 +86,13 @@ API - ядро мессенджера. Достаточно подключить
Для ретрансляции можно также использовать свой сервер в интернете, нужно просто его добавить в контакты. Для ретрансляции можно также использовать свой сервер в интернете, нужно просто его добавить в контакты.
```json ```json
{ "action":"resend", ... } { "peerSender":"*IPv6*", "peerReceiver":"*IPv6*", "action":"resend", "chatID":"*Идентификатор чата, у обоих он одинаковый*", "msgID":"*ID сообщения в чате*","msgText":"*сообщение*", "timestamp":"*время*", "enctype":"" }
``` ```
Параметры такие же как и для send Ответ:
ответ
```json ```json
{ "status":1 } { "peerID":"*IPv6*", "action":"resendSuccess","status":true }
``` ```
Если `status == 0` - то эта нода не желает пересылать сообщения и ей повторно отправлять не нужно. Если `status == 0` - то эта нода не желает пересылать сообщения и ей повторно отправлять не нужно.