Versions Compared

Old Version 10

changes.mady.by.user Ivan Korobkov

Saved on

compared with

New Version 11

changes.mady.by.user Ivan Korobkov

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

ПараметрЗначениеКомментарий
МетодPOST
Путь/public/api/v1/clients/me
ЗапросПустой
ОтветClient

...

ПараметрЗначениеКомментарии
МетодPOST
Путь/public/api/v1/clients/auth
Запрос


ПолеТипОбязательноеКомментарий
TokenstringДаТокен внутренний сессии на сервере чата



ОтветClientAuth

...

ПараметрЗначениеКомментарий
МетодPOST
Путь/public/api/v1/clients/signup
Запрос


ПолеТипОбязательноеКомментарий
NamestringДаИмя клиента



ОтветClientAuth

...

ПараметрЗначениеКомментарий
МетодPOST
Путь/public/api/v1/clients/integration_auth
Запрос


ПолеТипОбязательноеКомментарий
CredentialsstringДаЛюбая безопасная строка, по которой внешняя система сможет авторизовать пользователя.



ОтветClientAuth

...

ПараметрЗначениеКомментарии
МетодPOST
Путь/public/api/v1/chats/channel/chat/:channelName
ЗапросПустое
ОтветChat

...

ПараметрЗначениеКомментарии
МетодPOST
Путь/public/api/v1/chats/channel/typing/:channelName
ЗапросПустой
ОтветПустой

...

ПараметрЗначениеКомментарии
МетодPOST
Путь/public/api/v1/chats/channel/messages/:channelName
Запрос


ПараметрТипОбязательныйКомментарий
Limitint32ДаКоличество сообщений
MaxIdint64НетАйди последнего сообщения в прошлом ответе истории



ОтветChatMessage[]

...

ПараметрЗначениеКомментарий
МетодPOST
Путь/public/api/v1/chats/channel/send/:channelName
Запрос


ПолеТипОбязательноеКомментарии
LocalIdint64ДаУникальное айди сообщения на стороне клиента, как правило, можно использовать UTC в миллисекундах.
PayloadChatMessagePayloadTypeДаТип сообщения.
TextstringЗависит от PayloadТекст сообщения.
FileIdstringЗависит от PayloadАйди загруженного файла.



ОтветПустойНовое сообщение придет в SSE подключении.

...

ПараметрЗначениеКомментарий
МетодPOST
Путь/public/api/v1/chats/messages/received
Запросint64[]Айди сообщений, которые нужно пометить как полученные
ОтветПустой

...

ПараметрЗначениеКомментарий
МетодPOST
Путь/public/api/v1/chats/messages/read
Запросint64[]Айди сообщений, которые нужно пометить как прочтенные
ОтветПустой

...

Code Block
[1, 2, 3, 4, 5]

Файлы

Ссылка на файл

ПараметрЗначениеКомментарий
МетодGET
Путь/public/api/v1/files/get/:fileId
ОтветФайл с правильным Content-Type

Информация о файле

ПараметрЗначениеКомментарий
МетодGET
Путь/public/api/v1/files/meta/:fileId
ОтветFile

Пример ответа:

Code Block
{
  "OK": true,
  "Error": null,
  "Result": {
    "Id": "1705a928-0d7a-11e8-b187-13b6ccbb5d10.txt",
    "Type": "file",
    "Owner": "client",
    "OwnerClientId": 11,
    "ClientId": null,
    "UserId": 1,
    "Name": "oci8-sigsegv.txt",
    "Path": "clients/11/11/1705a928-0d7a-11e8-b187-13b6ccbb5d10.txt",
    "Size": 5356,
    "ImageWidth": null,
    "ImageHeight": null,
    "ContentType": "",
    "CreatedAt": 1518167865822
  },
  "Rels": {}
}

Загрузка файла

ПараметрЗначениеКомментарий
МетодPOST
Content-Typemultipart/form-data
Запрос


ПолеТипОбязательноеКомментарий
FileMultipart fileДа
TypeFileTypeДа



ОтветFile

Пример ответа:

Code Block
{
  "OK": true,
  "Error": null,
  "Result": {
    "Id": "9a9cef3d-0d7a-11e8-b188-9def95b467fb.jpg",
    "Type": "image",
    "Owner": "client",
    "OwnerClientId": 11,
    "ClientId": 11,
    "UserId": null,
    "Name": "1.jpg",
    "Path": "clients/11/11/9a9cef3d-0d7a-11e8-b188-9def95b467fb.jpg",
    "Size": 1039999,
    "ImageWidth": 3024,
    "ImageHeight": 4032,
    "ContentType": "image/jpeg",
    "CreatedAt": 1518168086597
  },
  "Rels": {}
}