Закрыть диалог

Этот метод используется для закрытия диалога.

URL

POST https://api.carrotquest.io/v1/conversations/{id}/close

В качестве {id} нужно использовать ID диалога.

Аргументы

Этот метод следует общим правилам. Аргументы передаются как GET или POST параметры.

Аргумент Описание
auth_token Обязательный. Токен авторизации (нужен scope: conversations-write)
from_admin Укажите ID администратора в случае назначения администратором (а не ботом).<!-- Можно указать default_admin — администратор по умолчанию
bot_name Укажите имя бота, от которого происходит отправка. Имя по умолчанию: Bot-->
random_id Случайный ID ConversationPart для контроля отправки. По умолчанию: 0

Если диалог уже закрыт, ничего не произойдет, будет возвращен ответ со стаусом 200.

Ответ

{
  "data": {
  }
  "meta": {
    "status": 200
  }
}

Ответ будет пустым.

Примеры

<!-- Закрыть диалог с ID=716 от имени бота:

curl -X POST \
  --data-urlencode 'auth_token=XXX' \
  'https://api.carrotquest.io/v1/conversations/716/close'

--> Закрыть диалог с ID=716 от имени администратора с ID=912:

curl -X POST \
  --data-urlencode 'auth_token=XXX' \
  --data-urlencode 'from_admin=912' \
  'https://api.carrotquest.io/v1/conversations/716/close'