Для завершения работы блока отправьте запрос:
POST /api/vertex/v1/complete
Описание запроса:
Наименование |
Формат |
Примечание |
token |
Строка |
Tокен для завершения работы блока. Обязательный параметр |
data |
Строка |
Данные, которые запишутся в переменную, заданную в манифесте |
Пример запроса:
{
"token": string|required,
"data": null|scalar|array
}
Описание ответа:
200 - успешный запрос. Работа блока в диалоге прекращается, бот идет дальше по схеме. Если блок был добавлен в конец схемы, то завершается диалог.
400 - не прошла валидация данных:
{
"message": string
}
403 - доступ запрещен:
{
"status": string
}
Параметр «status» может иметь значения:
- «token_invalid» - не прошла проверка токена на подлинность. Возможно, токен был поврежден. Полезная нагрузка была заменена;
- «instance_not_exist» - инстанс, заданный в токене, не существует;
- «instance_blocked» - инстанс, заданный в токене, заблокирован;
- «dialog_not_exist» - диалог, заданный в токене, не существует;
- «dialog_completed» - диалог, заданный в токене, имеет статус «завершен»;
- «vertex_not_work» - данный блок сейчас не находится в работе в диалоге.
Параметр «data» через переменные передает данные, которые потом можно использовать в чат-боте. В таблице ниже представлен пример записи данных в параметр и отображения их в диалоге.
Параметр «data» в запросе |
Данные в Form.one |
"data": "text" |
text |
"data": 30 |
30 |
"data": true |
1 |
"data": false |
пустота |
"data": [1, 2, 3] |
1, 2, 3 |
"data": ["a", "b", "c"] |
a, b, c |
"data": ["name":"John", "age":"30"] |
John, 30 |
"data":null |
@test |
Комментарии
0 комментариев
Войдите в службу, чтобы оставить комментарий.