...
Поле | Тип | Обязательное | Комментарий |
---|---|---|---|
OK | bool | Да |
|
Error | Error | Нет | Информация об ошибке. |
Result | Any | Нет | Успешный результат, тип зависит от вызываемого метода. |
Rels | Graph | НетИнформация | о связанных объектах результатаГраф зависимых объектов, на которые ссылается результат. |
Пример успешного пустого ответа:
Пример ответа:
Code Block |
---|
{ "OK": true, "Error": null, "Result": null, "Rels": null } |
Пример успешного ответа с данными и графом зависимых объектов:
Code Block |
---|
{
"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
}
]
}
} |
...
Code Block |
---|
{ "OK": false, "Error": { "Code": "not_found", "Text": "Объект не найден" } } |
Сервисы
Клиенты
Информация о текущем клиенте
Параметр | Значение | Комментарий |
---|---|---|
Путь | /public/api/v1/clients/me | |
Запрос | Пустой | |
Ответ | Client |
Пример ответа:
Code Block |
---|
{
"OK": true,
"Error": null,
"Result": {
"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": 1518167008390,
"SeenAt": 1518167008390,
"MessagedAt": null,
"IntegrationId": "10"
},
"Rels": {}
}
|
Авторизация пользователя по сессии
Параметр | Значение | Комментарии | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
Путь | /public/api/v1/clients/auth | |||||||||
Запрос |
| |||||||||
Ответ | ClientAuth |
Пример запроса:
Code Block |
---|
{"Token": "e71539abc4e000626c34bf981892b9acf84b84ed.f23e085bdd5d2b46e87b36fd79654727"} |
Пример ответа:
Code Block |
---|
{
"OK": true,
"Error": null,
"Result": {
"Client": {
"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": 1518167109406,
"SeenAt": 1518167109406,
"MessagedAt": null,
"IntegrationId": "10"
},
"Session": {
"Id": 92,
"ClientId": 11,
"Token": "e71539abc4e000626c34bf981892b9acf84b84ed.f23e085bdd5d2b46e87b36fd79654727",
"CreatedAt": 1518164878551,
"Integration": false,
"IntegrationHash": null,
"IntegrationCredentials": null
}
},
"Rels": {}
} |
Регистрация анонимного пользователя
Параметр | Значение | Комментарий | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
Путь | /public/api/v1/clients/signup | |||||||||
Запрос |
| |||||||||
Ответ | ClientAuth |
Пример запроса:
Code Block |
---|
{"Name": "John Doe"} |
Пример ответа:
Code Block |
---|
{
"OK": true,
"Error": null,
"Result": {
"Client": {
"Id": 18,
"ProjectId": 1,
"CompanyId": null,
"Type": "internal",
"Name": "John Doe",
"Online": false,
"CustomerId": null,
"ChannelId": null,
"TelegramId": null,
"FacebookId": null,
"VKId": null,
"TotalTickets": 0,
"TotalOpenTickets": 0,
"CreatedAt": 1518167345813,
"UpdatedAt": 1518167345813,
"SeenAt": null,
"MessagedAt": null,
"IntegrationId": null
},
"Session": {
"Id": 94,
"ClientId": 18,
"Token": "9f0ccd578394c9ef56c660de0f6c4614cbfe9a35.a07b3b3359e0d3943e074656dcda5d28",
"CreatedAt": 1518167345815,
"Integration": false,
"IntegrationHash": null,
"IntegrationCredentials": null
}
},
"Rels": {}
} |
Авторизация клиента через внешнюю систему
Например, авторизация клиента, информация о котором есть в ДБО или CRM.
Параметр | Значение | Комментарий | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
Путь | /public/api/v1/clients/integration_auth | |||||||||
Запрос |
| |||||||||
Ответ | ClientAuth |
Пример запроса:
Code Block |
---|
{"Credentials": "super-secure-token"} |
Пример ответа:
Code Block |
---|
{
"OK": true,
"Error": null,
"Result": {
"Client": {
"Id": 1,
"ProjectId": 1,
"CompanyId": null,
"Type": "crm",
"Name": "Мартин Лютер Кинг",
"Online": false,
"CustomerId": 7,
"ChannelId": null,
"TelegramId": null,
"FacebookId": null,
"VKId": null,
"TotalTickets": 15,
"TotalOpenTickets": 0,
"CreatedAt": 1491678852327,
"UpdatedAt": 1517989811064,
"SeenAt": 1516117515977,
"MessagedAt": null,
"IntegrationId": "1"
},
"Session": {
"Id": 95,
"ClientId": 1,
"Token": "cd0f8d5b81358ec76db6aa50ec0424d7fd4fccc7.da3df153848575972de2e8b3ca187f2f",
"CreatedAt": 1518167539961,
"Integration": false,
"IntegrationHash": null,
"IntegrationCredentials": null
}
},
"Rels": {}
} |
Чаты
Информация о чате
Параметр | Значение | Комментарии |
---|---|---|
Путь | /public/api/v1/chats/channel/chat/:channelName | |
Запрос | Пустое | |
Ответ | Chat |
...
Отправка уведомления о том, что пользователь печатает сообщение
Параметр | Значение | Комментарии |
---|---|---|
Путь | /public/api/v1/chats/channel/typing/:channelName | |
Запрос | Пустой | |
Ответ | Пустой |
...
Сообщения в чате возвращаются в обратном порядке по дате, сначала новые.
Параметр | Значение | Комментарии | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Путь | /public/api/v1/chats/channel/messages/:channelName | |||||||||||||
Запрос |
| |||||||||||||
Ответ | ChatMessage[] |
...
Code Block | ||
---|---|---|
| ||
{
"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": "Оператор"
}
]
}
} |
Отправка сообщения в чат
Параметр | Значение | Комментарий | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Путь | /public/api/v1/chats/channel/send/:channelName | |||||||||||||||||||||
Запрос |
| |||||||||||||||||||||
Ответ | Пустой | Новое сообщение придет в SSE подключении. |
Пример запроса:
Code Block |
---|
{
"LocalId": 1518166402407,
"Payload": "text",
"Text": "Привет"
} |
Подтверждение получения сообщений
Параметр | Значение | Комментарий |
---|---|---|
Путь | /public/api/v1/chats/messages/received | |
Запрос | int64[] | Айди сообщений, которые нужно пометить как полученные |
Ответ | Пустой |
Пример запроса:
Code Block |
---|
[1, 2, 3, 4, 5] |
Подтверждение прочтения сообщений
Параметр | Значение | Комментарий |
---|---|---|
Путь | /public/api/v1/chats/messages/read | |
Запрос | int64[] | Айди сообщений, которые нужно пометить как прочтенные |
Ответ | Пустой |
Пример запроса:
Code Block |
---|
[1, 2, 3, 4, 5] |