Синхронный режим

Ассинхронный режим – это наиболее предпочтительный способ запуска каскадной рассылки через API, который по-умолчанию обеспечивает скорость отправки в 10 RPS (кол-во запросов в секунду) и, кроме синхронных ответов после запуска, позволяет получать ассинхронные события о статусах транзакции:

Запуск через API

Но этот способ не единственный.

Зачем нужен синхронный режим

Если вы хотите протестировать запуск каскадной рассылки, проверить, что все настроено и работает корректно, то можно воспользоваться вторым API-методом, который обрабатывает запросы на отправку каскадной рассылки сразу после запуска и синхронно возвращает результат.

Такой способ запуска каскадных рассылок имеет собственное ограничение на количество принимаемых запросов:

• Лимит для запросов: 1 RSP (кол-во запросов в секунду).

Описание API-метода

Endpoint: https://cascades.fstrk.io/api/v1/transactions/

HTTP-метод: POST

Заголовки запроса:

• api-key: Ключ доступа для аутентификации;

• Content-Type: Формат тела запроса.

Пример тела запроса (JSON):

{
  "phone_number": "<НОМЕР ТЕЛЕФОНА>",
  "routing": [
    "BOT",
    "WHATSAPP"
  ],
  "bot_node_id": <ID СЦЕНАРИЯ (УЗЛА)>,
  "variables": {
    "<KEY>": "<VALUE>"
  },
  "whatsapp_template_name": "<TEMPLATE NAME>",
  "whatsapp_template_variables": {
    "<KEY>": "<VALUE>"
  },
  "waiting_time_route": <КОЛ-ВО СЕКУНД>
  "validity_period_seconds": <КОЛ-ВО СЕКУНД>,
  "tag": "<TAG>",
  "context": {
    "<KEY>": "<VALUE>",
    "<KEY>": "<VALUE>"
  }
}

Параметры запроса и заголовки ничем не отличаются от основного метода, отличается только endpoint на который вы будете делать запрос. Документация для этого метода также описана в Swager по адресу: https://cascades.fstrk.io/api/docs/.

Синхронные ответы:

Код	Описание
201	Успешное создание транзакции. В ответе вернется JSON со всеми параметрами созданной транзакции.
400	Неправильно составлен запрос.
429	Слишком много повторяющихся запросов в секунду.