Отправить ручное сообщение пользователю

Этот метод отправляет ручное сообщение (в виде чата, большого или маленького поп-апа) пользователю чата.

Созданный диалог появится в разделе "диалоги" только когда пользователь ответит на него.

URL

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

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

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

Параметры

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

Параметр Тип Описание
by_user_id Optional[boolean] Если вы делаете выборку не по ID из Carrot quest, а по своему User ID, этот параметр должен иметь значение true. По умолчанию: false
body строка Текст сообщения
type Optional[popup_chat/popup_small/popup_big] Тип сообщения. По умолчанию: popup_chat
app Optional[ID] ID приложения, делающего запрос. По умолчанию определяется на основе токена доступа.

Ответ

Поле data будет содержать два идентификатора:

  • conversation — ID диалога
  • message — ID ручного сообщения 
{
  "meta": {
    "status": 200
  },
  "data": {
    "conversation": 1128184,
    "message": 2804
  }
}

Примеры

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