Create a scenario

Create Scenario Endpoint:

This resource describes a scenario identified by a unique ID, with creation and update timestamps. It includes settings such as name, sticky channel behavior with a specified TTL, and PSD2 compliance status. Additionally, it defines PIN options with a specified TTL, security measures including rate limiting based on IP and destination number, and block scores for fraud detection. The scenario also lists communication channels such as SMS, Viber, voice, and flashcall, each with their respective configurations like sender information, message content, and timing for the next event.

URL: baseURL/scenario

Method: POST

Headers:

Content-Type: application/json
principalId:{accountID}

Request Body:

This command sends a POST request to BaseURL/scenario with the specified JSON payload, including headers for content type and principal ID.

curl --location 'baseURL/scenario' \
--header 'Content-Type: application/json' \
--header 'principalId: 1' \
--data-raw '{
    "settings": {
        "name": "string",
        "sticky_channel": false,
        "psd2_compliant": false
    },
    "pin_options": {
        "ttl": 320
    },
    "security": {
        "rate_limiting": {
            "ip": false,
            "destination_number": false,
            "interval": 3,
            "max_attempts": 3
        },
        "block_scores": []
    },
    "channels": [
        {
            "channel": "sms",
            "from": "Verify",
            "message": "Your PIN is @@pin",
            "flash": false,
            "transcode": true,
            "order": 1,
            "next_event_in": 37
        }
    ]
}'

Response Body:

{
  "scenario_id": "7280ecaa-a132-4908-8f26-c1ecbe138d98",
  "created_date": "2020-09-04T06:58:35Z",
  "updated_date": "2020-09-04T06:58:35Z",
  "settings": {
    "name": "string",
    "sticky_channel": true,
    "sticky_channel_ttl": 7
  },
  "pin_options": {
    "ttl": 320
  },
  "security": {
    "rate_limiting": {
      "ip": true,
      "destination_number": true,
      "interval": 3,
      "max_attempts": 3
    },
    "block_scores": [
      "high risk"
    ]
  },
  "channels": [
    {
      "flash": false,
      "transcode": true,
      "from": "Verify",
      "message": "Your PIN is @@pin",
      "channel": "sms",
      "next_event_in": 37,
      "order": 1
    },
    {
      "sender_info_tracking_id": "0094d198-4dd2-4fb5-b451-d46aca191b27",
      "message": "Dear customer your ACME inc PIN is @@pin",
      "channel": "viber",
      "next_event_in": 43,
      "order": 2
    },
    {
      "from": "ACME INC",
      "dtmf_required": true,
      "repeat": 3,
      "language": "en_US",
      "gender": "female",
      "next_event_in": 60,
      "message": "Dear customer your ACME inc PIN is @@pin",
      "channel": "voice",
      "order": 3
    },
    {
      "channel": "flashcall",
      "next_event_in": 30,
      "order": 5
    }
  ]
}

Where: