Update API.md

This commit is contained in:
Denis Davydov 2018-05-09 15:23:21 +03:00
parent f3d0dd3a99
commit cf8d80a685

22
API.md
View File

@ -38,7 +38,10 @@ GUI - примитивная программа под Linux/Window/Android, к
``` ```
Когда один отправил запрос - то второй может отправить свой ключ и тогда сервера смогут общаться друг с другом. Когда один отправил запрос - то второй может отправить свой ключ и тогда сервера смогут общаться друг с другом.
2. Отправка сообщения: ### Отправка сообщения
Структура сообщения в JSON:
```json ```json
{ "action":"send", "from":"адрес", "to":"адрес", "message":"сообщение", "timestamp":"время", "enctype":"", "key":"" } { "action":"send", "from":"адрес", "to":"адрес", "message":"сообщение", "timestamp":"время", "enctype":"", "key":"" }
``` ```
@ -50,8 +53,10 @@ GUI - примитивная программа под Linux/Window/Android, к
Если нет ответа, то сохраняем сообщение у себя в истории, чтобы потом переотправить. Если нет ответа, то сохраняем сообщение у себя в истории, чтобы потом переотправить.
`status==1` - доставлено, другой - недоставлено (помечаем как недоставлено `status==1` - доставлено, другой - недоставлено (помечаем как недоставлено
3. Пинг - проверка онлайн ### Пинг - проверка онлайна
Если прошло время больше чем last_connect + 1 минута, от отправляем запрос Если прошло время больше чем last_connect + 1 минута, от отправляем запрос
```json ```json
{ "action":"ping" } { "action":"ping" }
``` ```
@ -60,21 +65,24 @@ GUI - примитивная программа под Linux/Window/Android, к
{ "action":"pong" } { "action":"pong" }
``` ```
4. Если у нас есть сообщения для адреса и он онлайн (last_connect < 1 минуты), то передаём их Если у нас есть сообщения для адреса и он онлайн (last_connect < 1 минуты), то передаём их
Если для этого адрес в базе есть недоставленные сообщения, то отправляем такой запрос: Если для этого адрес в базе есть недоставленные сообщения, то отправляем такой запрос:
```json ```json
{ "action": "history", "messages":[{},{},{}...] } { "action": "history", "messages":[{},{},{}...] }
``` ```
ответ ответ:
```json ```json
{ "status":[1,1,1,0,1] } { "status":[1,1,1,0,1] }
``` ```
В ответ приходит массив с 1 или 0. Если 1 - сообщение сохранено успешно, 0 - ошибка и его нужно потом переотправить. В ответ приходит массив с 1 или 0. Если 1 - сообщение сохранено успешно, 0 - ошибка и его нужно потом переотправить.
5. Отправить сообщение для другого абонента (это нужно чтобы отправлять тем, кто в offline) ### Отправление сообщения для другого абонента (это нужно чтобы отправлять тем, кто в offline)
Если человек, которому мы отправляем сообщение offline - то во-первых оно сохраняется у себя на сервере, для последующей отправки.
Во-вторых, можно попросить какого-то друга его переотправить. Для этого выбираем случайно несколько друзей из списка контактов, у которых can_resend == 1 и отправляем им запрос. Если человек, которому мы отправляем сообщение offline - то, во-первых, оно сохраняется у себя на сервере, для последующей отправки.
Во-вторых, можно попросить какого-то друга его переотправить. Для этого выбираем случайно несколько друзей из списка контактов, у которых `can_resend == 1` и отправляем им запрос.
Для ретрансляции можно также использовать свой сервер в интернете, нужно просто его добавить в контакты. Для ретрансляции можно также использовать свой сервер в интернете, нужно просто его добавить в контакты.
```json ```json
{ "action":"resend", ... } { "action":"resend", ... }
``` ```