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

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

URL

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

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

Параметры

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

Параметр	Тип	Описание
from_admin	Optional[ID/default_admin]	Укажите ID администратора в случае ответа от администратора или default_admin для отправки от имени дефолтного отправителя сайта
random_id	Optional[integer]	Случайное целое число, чтобы сопостовлять создаваемое сообщение с репликой из RTS. По умолчанию, 0

Замечания

Чтобы контролировать, от чьего имени будет закрыт диалог, используйте from_admin.

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

Ответ

В поле data будет возвращен словарь, содержащий:

• id: ID - идентификатор созданной системной реплики закрытия
• part_group: ID - идентификатор вопроса, к которому принадлежит новая реплика

Пример:

{
  "data": {
    "id": 123,
    "part_group": 345
  },
  "meta": {
    "status": 200
  }
}

Ошибки

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

Примеры

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

curl -X POST \
  -H "Authorization: Token XXX" \
  --data-urlencode "from_admin=912" \
  "https://api.carrotquest.io/conversations/716/close"