Перейти к содержанию

Запустить внешнее событие

Метод позволяет запустить событие, которое послужит триггером для сценария.

Запрос

POST /api/v1/runtime/simple/external/events

Тело запроса (body)

JSON
1
2
3
4
5
{
  "conversationId": "string",
  "externalEventId": "string",
  "externalEventPayload": "object"
}

Свойства

Имя параметра Тип Описание Дополнительно
conversationId string Идентификатор беседы бота. Если используется этот параметр, то externalConversationId указывать не обязательно. Обязательный
externalConversationId string Внешний идентификатор беседы бота. Если используется этот параметр, то сonversationId указывать не обязательно. Если беседа изначально создана в линиях ELMA 365, то идентификатор будет равен "SESSION_ID|livechat", где SESSION_ID - идентификатор сессии в линии ELMA 365. Обязательный
externalEventId string Идентификатор внешнего события. Его можно задать в настройках триггера, в редакторе сценариев или узнать, получив список доступных триггеров, используя метод botExternalEventTriggers. Обязательный
externalEventPayload object Объект, содержащий значения переменных в формате key-value, где ключом является идентификатор переменной. Список досупных для заполнения переменных можно получить, используя метод botExternalEventTriggers. Опционально

Доступные типы переменных и формат значений

Тип переменной Формат
String Строка.
Number Число.
Boolean Логический тип, true или false.
DateTime Строка с датой в формате ISO 8601.
ComplexObject JSON-объект.
PersonName Строка, содержащая ФИО.
File Объект, содержащий наименование файла с расширением и ссылку на его скачивание. Пример значения: { "name": "Устав.pdf", "fileUrl": "https://elar.urfu.ru/bitstream/10995/60280/1/978-5-7996-2317-3_2018.pdf" }

HTTP коды ответов

Код ответа Описание
200 Событие успешно отправлено. Тело ответа отсутствует.
401 Ошибка авторизации. Необходимо проверить X-Token.
404 Не найден триггер с указанным externalEventId или не найдена беседа с указанным conversationId или externalConversationId.
500 Переданные значения переменных не прошли валидацию. Тело ответа содержит подробности об ошибке.

Авторизация

Запрос обязательно должен использовать один из следующих методов авторизации: X-Token.

Пример запроса

Bash
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
curl --location 'https://client.elma-bot.ai/api/v1/runtime/simple/external/events' \
--header 'X-Token: 73802c1e-33bd-4b54-b491-1dc496d58add' \
--header 'Content-Type: application/json' \
--data '{
    "conversationId": "6410af0299553fcfb57523e0",
    "externalEventId": "acquaintanceNotification",
    "externalEventPayload": {
        "tekst_soobschenia": "Прошу ознакомиться с документом до",
        "data_okonchania": "2023-02-15"
    }
}'