Documentation

Anatomy

The building blocks of an ivrToolkit application

On this page

Loading Configuration

There are two ways to load your configuration defaults. Either from a properties file or setting it up manually.

// set up your configuration from a file
var sipVoiceProperties = new SipVoiceProperties(_loggerFactory, @"c:\somewhere\voice.properties");

// or you can manually set it up. There are defaults so you don't need to override all of them
var sipVoiceProperties = new SipVoiceProperties(_loggerFactory)
{
    PromptAttempts = 99,
    PromptBlankAttempts = 5,
    DigitsTimeoutInMilli = 5000,
    SipServer = SIP_SERVER,
    SipUsername = USER,
    SipPassword = PASSWORD,
    SipLocalEndpoint = LOCAL_ENDPOINT
};

Choose your Plugin

Pick the plugin you want to use. Here we are using the SipSorcery plugin.

// instantiate the plugin you want to use
using var sipPlugin = new SipSorceryPlugin(_loggerFactory, sipVoiceProperties);

Line Manager

The Line Manager manages your collection of phone lines for the selected plugin.

// create a line manager
using var lineManager = new LineManager(loggerFactory, sipVoiceProperties, sipPlugin);

Getting a Line

The line manager is responsible for keeping track of the lines.

var line = lineManager.GetLine();

ScriptManager

The ScriptManager class defines the flow of your call. The script manager is optional but is recommended for complex flow control.

Instantiate the ScriptManager and pass in the first script you want to execute. Uuse the ExecuteScryptAsync method to start the call flow. It is the responsibility of each script block to decide what the next script block should be or null meaning the the call flow is done.

// Instantiate your beginning script
var startScript = new WelcomeScript(_loggerFactory, _voiceProperties, _line);

// instantiate the script manager, passing in the script you want to start with
var scriptManager = new ScriptManager(_loggerFactory, startScript);

// Execute the scripts. Each script block controls the next script block to execute
await scriptManager.ExecuteScriptAsync(cancellationToken)

_logger.LogDebug("scripts are done so hanging up.");
line.Hangup();

Script Blocks

A script block is an abstract class that you extend to do a block of work. For example: WelcomeScript, MainMenuScript, SubMenu1Script, DoSomeJobScript etc.

Here is an empty script block example:

public class TestScript : BaseScript
{
    private readonly ILoggerFactory _loggerFactory;
    private readonly VoiceProperties _voiceProperties;
    private readonly IIvrLine _line;
    private readonly ILogger _logger;

    public TestScript(ILoggerFactory loggerFactory,
            VoiceProperties voiceProperties,
            IIvrLine line)
            : base(loggerFactory, voiceProperties, line)
    {
        _loggerFactory = loggerFactory;
        _logger = loggerFactory.CreateLogger();
        _logger.LogDebug("Ctr()");
        _voiceProperties = voiceProperties;
        _line = line;
    }

    public override string Description => "Main Script";

    public override ascnc Task ExecuteAsync()
    {
        _logger.LogDebug("ExecuteAsync()");

        // do work here

        // go to the next script you want to execute
        return new AnyScript(_loggerFactory, _voiceProperties, _line);

        // alternatively, if you want to end
        // return null;
    }
}