Задать вопрос

Запрос возвращает синхронный ответ, либо вызывает webhook URL в зависимости от способа взаимодействия.

GET
/ask

Authorization

Authorization<token>

In: header

Query Parameters

chatIdRequiredstring

Внешний идентификатор чата с клиентом

queryRequiredstring

Запрос

formatstring

Форматирование ответа: links - добавить ссылки вида (name)[link], raw - неформатированный ответ

Value in: "links" | "raw"
msgIdstring

Идентификатор сообщения

Response Body

200

Ask query response

answerRequiredstring

Ответ на вопрос

botIdRequiredstring

Идентификатор бота

chatIdRequiredstring

Идентификатор бота

msgIdstring

Идентификатор сообщения, переданный в запросе

typeRequiredstring

Тип ответа:

  • SUCCESS — успешный ответ
  • NO_ANSWER — агент не смог сформировать ответ
  • ERROR — внутренняя ошибка сервера (например, таймаут)
  • GREETING — содержит только приветствие
  • OPERATOR — вызов оператора
  • SKIP — пропуск сообщения
  • GRATITUDE — содержит только благодарность

Если type равен OPERATOR, ERROR или NO_ANSWER — чат необходимо перевести на оператора.

Value in: "SUCCESS" | "NO_ANSWER" | "ERROR" | "GREETING" | "OPERATOR" | "SKIP" | "GRATITUDE"
agentIdRequirednumber

Идентификатор агента, который выполнил запрос

400

Unexpected error

errorRequiredinteger
Format: "int32"
messageRequiredstring
curl -X GET "https://api.wikibot.pro/api/bot/ask?chatId=string&query=string&format=links&msgId=string" \
  -H "Authorization: <token>"

Ask query response

{
  "answer": "string",
  "botId": "string",
  "chatId": "string",
  "msgId": "string",
  "type": "SUCCESS",
  "agentId": 0
}