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

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

POST
/ask

Authorization

Authorization<token>

In: header

Request Body

application/jsonRequired
chatIdRequiredstring

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

queryRequiredstring

Запрос

formatstring

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

Value in: "links" | "raw"
msgIdstring

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

attachmentsarray<string>

Список вложений (URL)

agentIdnumber

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

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"
attachmentsarray<string>

Список вложений (URL)

agentIdRequirednumber

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

400

Unexpected error

errorRequiredinteger
Format: "int32"
messageRequiredstring
curl -X POST "https://api.wikibot.pro/api/bot/ask" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "chatId": "12345",
    "query": "Как дела?",
    "format": "links",
    "msgId": "67890",
    "attachments": [
      "https://example.com/file.png"
    ],
    "agentId": 5
  }'

Ask query response

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