Создать диалог, начатый пользователем на сайте

Этот метод создает диалог, который был инициирован пользователем на сайте (то есть первое сообщение в диалоге — от пользователя).

Для создания диалога, в котором первое сообщение от администратора, нужно использовать метод отправки сообщения пользователю /users/{id}/sendmessage.

URL

POST https://api.carrotquest.io/users/{id}/startconversation

В качестве {id} можно использовать:

ID из нашей системы
Ваш User ID (укажите параметр by_user_id=true). Если пользователя с таким идентификатором не существует, он будет создан автоматически.

Параметры

Параметры аутентификации.
Параметр id_as_string.

Параметр	Тип	Описание
`by_user_id`	Optional[boolean]	Если вы делаете выборку не по ID из Carrot quest, а по своему User ID, этот параметр должен иметь значение `true`. По умолчанию: `false`
`body`	Optional[строка]	Текст сообщения. По умолчанию: пустая строка.
`file`	Optional[File]	Файл, прикрепленный к сообщению. Поддерживаются файлы размером до 10 Мбайт с типами `jpg`, `jpeg`, `png`, `gif`, `pdf`, `rar`, `zip`, `html`, `csv`, `docx`, `doc`, `xlsx`, `xls`, `txt`, `sig`.
`filename`	Optional[строка]	Обязательный, если указан `file`. Имя файла, под которым он отправляется.
`random_id`	Optional[integer]	Произвольное целое число, которое служит, чтобы проассоциировать реплику, пришедшую через RTS API, если она придет раньше, чем ответ от сервера на данный запрос. Данное число будет возвращено в данных о реплике.
`referrer`	Optional[строка]	Страница, на которой был пользователь, когда отправил сообщение.
`app`	Optional[ID]	ID приложения, делающего запрос. По умолчанию определяется на основе токена доступа.

Замечания

Необходимо задать как минимум одно из полей body или file + filename. Можно задать оба.

Ответ

Ответ в поле data будет содержать идентификатор созданного диалога.

{
  "meta": {
    "status": 200
  },
  "data": {
    "id": 1856194
  }
}

Ошибки

Стандартные ошибки Web API.

Ошибки данного метода

Ошибка	Код	Описание
`ReplyTooBig`	400	Слишком длинный текст реплики (`body`)

Примеры

curl -X POST \
  --data-urlencode 'body=Hello' \
  -H "Authorization: Token XXX" \
  https://api.carrotquest.io/users/3964935/startconversation