Page tree
Skip to end of metadata
Go to start of metadata

Response

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

true – успешный ответ
false – ошибка

ErrorErrorНетИнформация об ошибке.
ResultAnyНетУспешный результат, тип зависит от вызываемого метода.
RelsGraphНетГраф зависимых объектов, на которые ссылается результат.

Пример успешного пустого ответа:

{
  "OK": true,
  "Error": null,
  "Result": null,
  "Rels": null
}

Пример успешного ответа с данными и графом зависимых объектов:

{
  "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": "Объект не найден"
  }
}

ActorType

Перечисление типов субъектов, которые могут совершать действия.

ЗначениеКомментарий
""Пустая строка, анонимный клиент.
clientКлиент.
userПользователь.
systemСистема.


Chat

ПолеТипОбязательноеКомментарий
Idint64Да
ProjectIdint64Да
ClientIdint64Да
ChannelIdint64Да




EventIdint64НетАйди последнего события в чате
ClientUnreadint32ДаКоличество непрочитанных сообщений в чате




CreatedAtTimestampДаДата создания
ChangedAtTimestampДаДата изменения

ChatMessage

ПолеТипОбязательноеКомментарий
Idint64Да
ChatIdint64Да
LocalIdint64Да
EventIdint64Да




AuthorActorTypeДа
ClientIdint64Зависит от Author
UserIdint64Зависит от Author




PayloadChatMessagePayloadTypeДа
TextstringДаЕсть всегда, но может быть пустой строкой, если тип сообщения — файл.
FileIdstringЗависит от Payload
RatingIdint64НетАйди оценки оператора




ReceivedboolДаСообщение доставлено получателю.
ReadboolДаСообщение прочитанно получателем.
PushedboolДаОтправлено пуш-уведомление о сообщении.




CreatedAtTimestampДа

Дата создания.

ReceivedAtTimestampДаДата получения.
ReadAtTimestampДаДата прочтения.




MyboolДаТекущий пользователь автор этого сообщения.

ChatMessagePayloadType

Перечисление типов сообщений в чате.

ЗначениеКомментарий
textТекстовое сообщение
fileСообщение с приложенным файлом
ratingСообщение с предложением оценить работу оператора

ChatEvent

Событие в чате.

ПолеТипОбязательноеКомментарий
Idint64trueМожет быть 0, если событие транзитивное, т.е. не хранится в базе данных.
TypeChatEventTypetrueТип события




ChatIdint64trueАйди чата, в котором произошло событие
MessageIdint64falseАйди сообщения, с которым связано событие




ActorActorTypetrueТип актора, который совершил действие.
ClientIdint64falseАйди клиента, который совершил действие.
UserIdint64falseАйди пользователя, который совершил действие.




CreatedAtTimestamptrueДата создания
TransitiveboolfalseТранзитивное событие, не хранится в базе данных, пример, что пользователь печатает в чате.

ChatEventType

Перечисление типов событий в чате.

ЗначениеКомментарий
typingКлиент или пользователь печатает в чате.
message_createdНовое сообщение в чате.
message_receivedПолучатель подтвердил, что сообщение доставлено.
message_readПолучатель подтвердил, что сообщение прочитанно.

Client

ПолеТипОбязательноеКомментарий
Idint64true
ProjectIdint64true




TypeClientTypetrueТип клиента.
NamestringtrueИмя клиента.
OnlinebooltrueКлиент сейчас онлайн.




CreatedAtTimestamptrueДата создания.
UpdatedAtTimestamptrueДата обновления.
SeenAtTimestampfalseДата, когда клиент был онлайн последний раз.

File

ПолеТипОбязательноеКомментарий
Idstringtrue
TypeFileTypetrueТип файла
OwnerFileOwnerTypetrue

Тип владельца файла:

  • public — Публичный файл, виден всем.
  • client — Файл в чате клиента.
OwnerClientIdint64Зависит от OwnerАйди клиента, в чате которого находится этот файл.
ClientIdint64falseАйди клиента, который загрузил этот файл.
UserIdint64falseАйди пользователя, который загрузил этот файл.




NamestringtrueОригинальное имя файла.
PathstringtrueВнутренний путь к файлу.
Sizeint64trueРазмер файла в байтах




ImageWidthint64falseШирина изображения.
ImageHeightint64falseВысота изображения




ContentTypestringtrueТип содержания файла.
CreatedAtTimestamptrueДата создания файла.

FileType

Перечисление типов файла.

ЗначениеКомментарий
fileФайл или документ.
imageИзображение.

Rating

ПолеТипОбязательноеКомментарий
Idint64true
ProjectIdint64trueАйди проекта
TicketIdint64trueАйди обращения
ClientIdint64trueАйди клиента
UserIdint64trueАйди оператора




StateRatingStatetrueСостояние оценки
Valueint32falseЗначение оценки или null
CommentstringtrueКомментарий клиента или пустая строка




CreatedAtTimestamptrue
UpdatedAtTimestamptrue

RatingInput

ПолеТипОбязательноеКомментарий
Valueint32trueЗначение оценки от 0 до 5.
CommentstringtrueКомментарий клиента или пустая строка.

RatingState

Состояние оценки оператора.

ЗначениеКомментарий
pendingОжидание оценки клиентом.
ignoredКлиент проигнорировал оценку.
ratedКлиент оценил работу оператора.

User

ПолеТипОбязательноеКомментарий
Idint64true
NamestringtrueИмя пользователя
PositionstringtrueДолжность пользователя
AvatarIdstringfalseАйди аватарки пользователя
Onlinebooltrue




CreatedAtTimestamptrue
UpdatedAtTimestamptrue
LoggedInAtTimestampfalse




DisplayNamestringtrueИмя, которое нужно показывать клиентам
  • No labels