AMIgo offers several high level controls that allows to retrieve, edit and update the configuration files used by Asterisk. These controls are named with prefix AMIgoSetup. The AMIgoSetupPanel control group most setup controls into a tab control to form a full featured setup / configuration panel.

A Configuration file and a DialPlan editor controls are also available.

The AMI_Client component offers several methods to get and update configuration files and higher level methods to create / update users, queues, agents, conferences etc.

Note
See: AMI_Client Members for the list.

AMIgo uses and supports the configuration model introduced by the Asterisk GUI, which allocates a ranges of extensions for the different PBX elements and store these in the guipreferences.conf configuration file.

The Asterisk GUI assigns extensions range for: Users (Extensions), Queues, Conferences, Ring Groups and Voicemail groups. AMIgo adds two new items to this: Agents and Applications. These extensions range will be used to write the dialplan instructions. Each element is written in a different context and these context are include in the 'default' context.

If the guipreferences.conf file exists this will be used. Otherwise a default extension range will be proposed. You can edit and save this from the 'General' tab of the Setup panel. The extension can be set to a size of 3 or 4 digits.

Caution
Make sure that the extensions range do not overlap.

AMIgo uses generic Lists of Dictionary to store and manipulate the configuration information that is retrieved from the Asterisk configuration files:

public List<Dictionary<string, string>>

This is a list of Dictionary which contains the configuration information in the form of key / Value pair. Each section or context in a given configuration file is contained in a dictionary in the list. Each of these dictionary has a "FileName" and a "Category" keys which identify the file and context / section.

These dictionary lists are available as AMI_Client public fields. See:

AMI_Client Fields, See also: _AgentsConfigList()()()(), _AgentsConfigList()()()(), _ConferencesConfigList()()()(), _ExtensionsConfigList()()()(), _QueuesConfigList()()()(), _UsersConfigList()()()()

Use the GetDicoIndexInList(List<(Of <<'(Dictionary<(Of <<'(String, String>)>>)>)>>), String) method to get the index of a given category / context from a Dictionary List.

Use the GetValueFromDictionaryList(List<(Of <<'(Dictionary<(Of <<'(String, String>)>>)>)>>), String, String, String%) method to get the value of a given category / context and Key name from a Dictionary List.

You can use the foreach keyword and KeyValuePair object to read the key / values from the dictionary

CopyC#

1if ((index = GetDicoIndexInList(_ExtensionsConfigList, "default")) != -1)
2{
3  string key = "", value = "";
4  foreach (KeyValuePair<string, string> kvp in _ExtensionsConfigList[index])
5  {
6    key = kvp.Key;
7    value = kvp.Value
8  }
9}

Getting the config files

Configuration file editor

The AMIgoConfigEditor Panel and Form controls allows to display, edit and update the configuration file.

Use the ConfigGetFile(String) method to retrieve a file. Once the file has been read a GetConfigEvent()()()() will be triggered and the GetConfigEventArgs will contains the FileName and the content of the config file as an array of strings.

The example below show how to get a file and open it in the AMIgo editor control in a form.

CopyC#

 1private void buttonGetConfig_Click(object sender, EventArgs e)
 2{
 3  if (AMI_ClientInstance != null)
 4    AMI_ClientInstance.ConfigGetFile("asterisk.conf");
 5}
 6public void GetConfigEventHandler(object sender, GetConfigEventArgs ev)
 7{
 8  if (AMI_ClientInstance != null)
 9    AMI_ClientInstance.ConfigOpenEditor(ev.filename, ev.strings);
10}

DialPlan Editor