Текст

Создать коммуникацию (одну)

POST https://api.deeray.com/v1/carrot/conversation/create

Path Parameters

Name	Type	Description
...author.avatar	string	Ссылка на аватар (фото) автора сообщения. Изображение должно иметь соотношение сторон 1:1.
...author.nick	string	Уникальный идентификатор автора сообщения.
...author.name	string	Имя автора
...item.author	object	Объект автора данного сообщения
...message.tags	array	Список тегов текущего сообщения. Каждый тег является строкой.
...message.originator	string	Инициатор сообщения. Может принимать значение: customer, operator, service.
...message.created_at	string	Дата и время создания сообщения в миллисекундах.
...message.body	string	Текст сообщения
...item.message	object	Объект текстового сообщения
...item.id	string	Идентификатор сообщения. Если type = message, то данный атрибут не требуется.
messages.item	object	Объект сообщения
messages	array	Список сообщений.
channel	string	Канал откуда поступила коммуникация, например: кол-центр, telegram, viber, sms.
tags	array	Список меток коммуникации. Каждая метка является строкой.
type	string	Тип коммуникации. Может принимать значение: message, conversation.
id	string	Идентификатор коммуникации, которую необходимо создать. Если данный атрибут не передается, то uuid записи будет создан автоматически и возвращен в ответе на данный запрос.
secret-key	string	Ключ доступа к проекту
api-key	string	Ключ авторизации клиента

200

{
  "item": {
    "id": "uuid"
  }
  "code": 0
}

Создать коммуникации (множество)

POST https://api.deeray.com/v1/carrot/conversations/create

Данный метод позволяет создавать коммуникации "пачкой". Применяется в системах с большим объемом коммуникаций и в случаях, когда за раз необходимо загрузить большое кол-во коммуникаций (например, когда загрузка идет не в режиме реального времени, а по расписанию).

Path Parameters

Name	Type	Description
secret-key	string	Ключ доступа к проекту
api-key	string	Ключ авторизации клиента
items	array	Список коммуникаций. Формат коммуникаций см выше.

200

Удалить коммуникацию

POST https://api.deeray.com/v1/carrot/conversation/delete

Path Parameters

Name	Type	Description
conversation.message	string	Идентификатор сообщения в коммуникации. Если type = message, то данный атрибут не требуется.
conversation.id	string	Идентификатор коммуникации
conversation.type	string	Тип коммуникации. Может принимать значение: message, conversation.
conversation	object	Объект коммуникации
secret-key	string	Ключ доступа к проекту
api-key	string	Ключ авторизации клиента

200

{
  "code": 0
}

Если type = conversation и conversation.message не присутствует в атрибутах, то все сообщения в рамках указанной коммуникации (conversation.id) будут удалены.

Создать сообщения

POST https://api.deeray.com/v1/carrot/messages/create

Создание сообщений. Формат сообщения такой же, как и коммуникаций (см выше), за исключением, что экстра-данные по сообщению передаются в объекте options.

Path Parameters

Name	Type	Description
tags	array	Теги сообщения.
score	object	Объект оценки, которую поставил пользователь сообщения
channel	string	Канал
location	object	Локация
items.message	object	Объект сообщения
items	array	Массив сообщений
secret-key	string	Ключ доступа к проекту
api-key	string	Ключ авторизации клиента

200