Типы данных
Response
Поле | Тип | Обязательное | Комментарий |
---|---|---|---|
OK | bool | Да |
|
Error | Error | Нет | Информация об ошибке. |
Result | Any | Нет | Успешный результат, тип зависит от вызываемого метода. |
Rels | Graph | Нет | Информация о связанных объектах результата. |
Пример успешного ответа:
{ "OK": true, "Error": null, "Result": [ { "Id": 504, "ChatId": 10, "EventId": 3614, "Author": "user", "UserId": 12, "Payload": "text", "Text": "Добрый день!", "CreatedAt": 1500970393387, } ], "Rels": { "Users": [ { "Id": 12, "Name": "Оператор", "Email": "operator@iqstore.ru", "CreatedAt": 1500970142322, "UpdatedAt": 1507204200866 } ] } }
Пример ответа с ошибкой:
{ "OK": false, "Error": { "Code": "not_found", "Text": "Объект не найден" } }
Сервисы
Чаты
Информация о чате
Значение | Комментарии | |
---|---|---|
Путь | /public/api/v1/chats/channel/chat/:channelName | |
Запрос | Пустое | |
Ответ | Chat |
Пример ответа:
{ "OK": true, "Error": null, "Result": { "Id": 10, "ProjectId": 1, "ClientId": 11, "ChannelId": 1, "TicketId": 68, "EventId": 3645, "ClientUnread": 5, "CreatedAt": 1498085875177, "ChangedAt": 1518091061880 }, "Rels": { "Clients": [ { "Id": 11, "ProjectId": 1, "CompanyId": 2, "Type": "crm", "Name": "Дмитрий Менделеев", "Online": true, "CustomerId": 5, "ChannelId": null, "TelegramId": null, "FacebookId": null, "VKId": null, "TotalTickets": 2, "TotalOpenTickets": 1, "CreatedAt": 1498085866873, "UpdatedAt": 1518164918835, "SeenAt": 1518164918835, "MessagedAt": null, "IntegrationId": "10" } ] } }
Отправка уведомления о том, что пользователь печатает сообщение
Значение | Комментарии | |
---|---|---|
Путь | /public/api/v1/chats/channel/typing/:channelName | |
Запрос | Пустой | |
Ответ | Пустой |
Пример ответа:
{ "OK": true, "Error": null, "Result": null, "Rels": null }
Получение истории сообщений в чате
Сообщения в чате возвращаются в обратном порядке по дате, сначала новые.
Значение | Комментарии | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Путь | /public/api/v1/chats/channel/messages/:channelName | |||||||||||||
Запрос |
| |||||||||||||
Ответ | ChatMessage[] |
Пример запроса:
{ "Limit": 10, "MaxId": 1234 }
Пример ответа:
{ "OK": true, "Error": null, "Result": [ { "Id": 504, "ChatId": 10, "LocalId": 1500970393387, "EventId": 3614, "TicketMessageId": null, "Author": "user", "ClientId": null, "UserId": 12, "Payload": "text", "Text": "Добрый день!", "Received": false, "Read": false, "Pushed": true, "CreatedAt": 1500970393387, "ReceivedAt": null, "ReadAt": null, "My": false } ], "Rels": { "Clients": [ { "Id": 11, "ProjectId": 1, "CompanyId": 2, "Type": "crm", "Name": "Дмитрий Менделеев", "Online": true, "CustomerId": 5, "ChannelId": null, "TelegramId": null, "FacebookId": null, "VKId": null, "TotalTickets": 2, "TotalOpenTickets": 1, "CreatedAt": 1498085866873, "UpdatedAt": 1518165344742, "SeenAt": 1518165344742, "MessagedAt": null, "IntegrationId": "10" } ], "Users": [ { "Id": 12, "Name": "Оператор", "Email": "operator@iqstore.ru", "Position": "Оператор", "RoleId": 2, "AvatarId": null, "Online": false, "Deleted": false, "TotalAssignedTickets": 0, "CreatedAt": 1500970142322, "UpdatedAt": 1507204200866, "LastSeenAt": 1500970417675, "DisplayName": "Оператор" } ] } }