====== Список команд AMI интерфейса asterisk реализованных в компоненте для 1С======
При разработке компоненты мы придерживались идеи прозрачного прокси между AMI интерфейсом Asterisk и 1C:Предприятием 8. 
Мы планируем описать все [[kb:asterisk:ami|команды AMI интерфейса Asterisk]], и транслировать их в функции компоненты.

===== Функции AMI реализованные в компоненте =====

^Функция^Описание^
| [[doc:1cajam:api:AbsoluteTimeout|AbsoluteTimeout(Channel,  Timeout,  ActionID, Result)]]|Установка абсолютно максимального времени для вызова|
| [[doc:1cajam:api:AgentLogoff|AgentLogoff(Agent, Soft, ActionID, Result)]]|Установка статуса агента как _не_ зарегистрированного|
| [[doc:1cajam:api:Agents|Agents(ActionID, Result)]]|Список агентов и их статусы|
| [[doc:1cajam:api:AGI|AGI(Channel,  Command,  CommandID,  ActionID, Result)]]|Добавление AGI команды в очередь выполнения|
| [[doc:1cajam:api:Atxfer|Atxfer(Channel,  Exten,  Context,  Priority,  ActionID, Result)]]|Консультативный перевод| 
| [[doc:1cajam:api:Bridge|Bridge(Channel1 ,  Channel2 ,  Tone ,  ActionID, Result)]]|Соединение двух существующих каналов|
| [[doc:1cajam:api:Challenge|Challenge(AuthType ,  ActionID, Result)]]|Генерация хеша для MD5 аутентификации|
| [[doc:1cajam:api:ChangeMonitor|ChangeMonitor(Channel,  File,  ActionID, Result)]]|Изменение имени файла для записи вызова для канала|
| [[doc:1cajam:api:Command|Command(command,  ActionID, Result)]]|Выполнение команды CLI.| 
| [[doc:1cajam:api:ConfbridgeKick|ConfbridgeKick(Conference,  Channel,  ActionID, Result)]]|Дропнуть пользователя конференции |
| [[doc:1cajam:api:ConfbridgeList|ConfbridgeList(Conference ,  ActionID, Result)]]|Список участников конференции |
| [[doc:1cajam:api:ConfbridgeListRooms|ConfbridgeListRooms( ActionID, Result)]]|Списки данных обо всех активных конференций|
| [[doc:1cajam:api:ConfbridgeLock|ConfbridgeLock(Conference, ActionID, Result)]]|Блокировка количества участников конференции|
| [[doc:1cajam:api:ConfbridgeMute|ConfbridgeMute(Conference, Channel, ActionID, Result)]]|Выключить микрофон участника конференции|
| [[doc:1cajam:api:ConfbridgeSetSingleVideoSrc|ConfbridgeSetSingleVideoSrc( Conference,  Channel,  ActionID, Result)]]|Сделать видео участника конференции единственным видео источником для всей конференции|
| [[doc:1cajam:api:ConfbridgeStartRecord|ConfbridgeStartRecord(Conference,  RecordFile,  ActionID, Result)]]|Начать запись конференции. Если файл записи уже создан, будет возвращена ошибка, иначе файл записи будет создан в monitor директории|
| [[doc:1cajam:api:ConfbridgeStopRecord|ConfbridgeStopRecord(Conference,  ActionID, Result)]]|Прекратить запись конференции|
| [[doc:1cajam:api:ConfbridgeUnlock|ConfbridgeUnlock(Conference,  ActionID, Result)]]|Разблокировать конференцию и разрешить присоединение новых пользователей|
| [[doc:1cajam:api:ConfbridgeUnmute|ConfbridgeUnmute(Conference,  Channel,  ActionID, Result)]]|Включить микрофон участника конференции|
| [[doc:1cajam:api:CoreSettings|CoreSettings(ActionID, Result)]]|Отобразить параметры PBX, версию ядра и т.д.|
| [[doc:1cajam:api:CoreShowChannels|CoreShowChannels(ActionID, Result)]]|Отобразить список активных каналов|
| [[doc:1cajam:api:CoreStatus|CoreStatus(ActionID, Result)]]|Отобразить состояние переменных ядра PBX|
| [[doc:1cajam:api:CreateConfig|CreateConfig(Filename,  ActionID, Result)]]|Создание пустого конфигурационного файла|
| [[doc:1cajam:api:DAHDIDialOffHook|DAHDIDialOffHook( DAHDIChannel ,  Number ,  ActionID, Result)]]|Набор номера через DAHDI канал, при поднятой трубке|
| [[doc:1cajam:api:DAHDIDNDoff|DAHDIDNDoff(DAHDIChannel ,  ActionID, Result)]]|Установка “Do Not Disturb” статуса в OFF|
| [[doc:1cajam:api:DAHDIDNDon|DAHDIDNDon(DAHDIChannel ,  ActionID, Result)]]|Установка “Do Not Disturb” статуса в ON|
| [[doc:1cajam:api:DAHDIHangup|DAHDIHangup(DAHDIChannel ,  ActionID, Result)]]|Завершение вызова по каналу DAHDI|
| [[doc:1cajam:api:DAHDIRestart|DAHDIRestart(ActionID, Result)]]|Полный рестарт DAHDI канала (завершение вызова)|
| [[doc:1cajam:api:DAHDIShowChannels|DAHDIShowChannels(DAHDIChannel ,  ActionID, Result)]]|Получение статусов DAHDI каналов|
| [[doc:1cajam:api:DAHDITransfer|DAHDITransfer(DAHDIChannel ,  ActionID, Result)]]|Перевод вызова (DAHDI канал)|
| [[doc:1cajam:api:DataGet|DataGet(Path,  Search,   Filter,  ActionID, Result)]]|Получить значения ключей из Asterisk Data Base|
| [[doc:1cajam:api:DBDel|DBDel(Family,  Key,  ActionID, Result)]]|Удаление значений из astDB|
| [[doc:1cajam:api:DBDelTree|DBDelTree(Family,  Key,  ActionID, Result)]]|Удаление дерева значений из astDB|
| [[doc:1cajam:api:DBGet|DBGet(Family,  Key,  ActionID, Result)]]|Получение значений из astDB|
| [[doc:1cajam:api:DBPut|DBPut(Family,  Key,   Val,  ActionID, Result)]]|Вставка данных в astDB|
| [[doc:1cajam:api:Events|Events(EventMask,  ActionID, Result)]]|Управление Manager API событиями поступающими в соединение|
| [[doc:1cajam:api:ExtensionState|ExtensionState( Exten,  Context,  ActionID, Result)]]|Проверка состояние екстеншена|
| [[doc:1cajam:api:Filter|Filter(Operation,  Filter ,  ActionID, Result)]]|Установить белый или черный фильтр для сообытий текущей сессии менеджера|
| [[doc:1cajam:api:FilterList|FilterList( ActionID, Result)]]|Показать текущие фильтры событий для этой сессии|
| [[doc:1cajam:api:GetConfig|GetConfig(Filename,Category, ActionID, Result)]]|Получение заданного файла конфигурации|
| [[doc:1cajam:api:GetConfigJSON|GetConfigJSON( Filename, ActionID, Result)]]|Получение заданного файла конфигурации в формате JSON|
| [[doc:1cajam:api:GetHASPInfo|GetHASPInfo(Result)]]|Получение информации по ключам защиты Sentinel HASP|
| [[doc:1cajam:api:GetVar|GetVar(Channel,  Variable,  ActionID, Result)]]|Получение значения переменной канала.|  
| [[doc:1cajam:api:Hangup|Hangup(Channel, Cause, ActionID, Result)]]|Завершение соединение на заданном канале.| 
| [[doc:1cajam:api:IAXnetstats|IAXnetstats(ActionID, Result)]]|Отобразить сетевую статистику IAX |
| [[doc:1cajam:api:IAXpeerlist|IAXpeerlist(ActionID, Result)]]|Список IAX пиров|
| [[doc:1cajam:api:IAXpeers|IAXpeers(ActionID, Result)]]|Список IAX пиров|
| [[doc:1cajam:api:IAXregistry|IAXregistry(ActionID, Result)]]|Отобразить зарегистрированных IAX пиров|
| [[doc:1cajam:api:JabberSend|JabberSend(Jabber,  JID,   Message ,  ActionID, Result)]]|Команда посылает сообщение Jabber клиенту|
| [[doc:1cajam:api:ListCategories|ListCategories( Filename ,  ActionID, Result)]]|Получение списка категорий конфигурационного файла|
| [[doc:1cajam:api:ListCommands|ListCommands(ActionID, Result)]]|Получение списка доступных команд для Manager API|
| [[doc:1cajam:api:LocalOptimizeAway|LocalOptimizeAway( Channel,  ActionID, Result)]]|Оптимизировать выход локального канала, когда это возможно|
| [[doc:1cajam:api:Login|Login(Username ,  Secret , Result)]]|Начало сеанса Asterisk Manager API|
| [[doc:1cajam:api:Logoff|Logoff(Result)]]|Выход из Manager API|
| [[doc:1cajam:api:MailboxCount|MailboxCount( Mailbox,  ActionID, Result)]]|Получение числа сообщений в голосовом ящике|
| [[doc:1cajam:api:MailboxStatus|MailboxStatus( Mailbox,  ActionID, Result)]]|Получение состояния голосового ящика|
| [[doc:1cajam:api:MeetmeList|MeetmeList(Conference,  ActionID, Result)]]|Список участников конференции|
| [[doc:1cajam:api:MeetmeListRooms|MeetmeListRooms(ActionID, Result)]]|Список комнат конференций|
| [[doc:1cajam:api:MeetmeMute|MeetmeMute(Meetme,  Usernum,  ActionID, Result)]]|Выключение микрофона у участника конференции Meetme|
| [[doc:1cajam:api:MeetmeUnmute|MeetmeUnmute(Meetme,  Usernum,  ActionID, Result)]]|Включение микрофона у участника конференции Meetme|
| [[doc:1cajam:api:MessageSend|MessageSend(To,From,Body,Base64Body,Variable,ActionID,Result)]]|Отправка сообщения в канал|
| [[doc:1cajam:api:MixMonitor|MixMonitor(Channel, File, options, ActionID, Result)]]|Запись каналов в файл|
| [[doc:1cajam:api:MixMonitorMute|MixMonitorMute( Channel,  Direction ,   State ,  ActionID, Result)]]|Выключить/Включить Mixmonitor запись|
| [[doc:1cajam:api:ModuleCheck|ModuleCheck(Module ,  ActionID, Result)]]|Проверка загружен ли указанный модуль|
| [[doc:1cajam:api:ModuleLoad|ModuleLoad(Module ,  LoadType ,  ActionID, Result)]]|Управление модулями Asterisk|
| [[doc:1cajam:api:Monitor|Monitor(Channel,  File,  Format,  Mix,  ActionID, Result)]]|Запись разговора на заданном канале|  
| [[doc:1cajam:api:MuteAudio|MuteAudio(Channel,Direction,State,ActionID, Result)]]|MuteAudio|  
| [[doc:1cajam:api:Originate|Originate(Channel,  Context,  Exten,  Priority,  Timeout,  CallerID,  Variable,  Account,  Application,  Data,  Async, Codecs, EarlyMedia, ActionID, Result)]]|Совершение исходящего вызова, выполнение произвольной команды.| 
| [[doc:1cajam:api:Park|Park(Channel,  Channel2,   Timeout, Parkinglot,ActionID, Result)]]|Парковка вызова|
| [[doc:1cajam:api:ParkedCalls|ParkedCalls(ActionID, Result)]]|Список запаркованных вызовов|
| [[doc:1cajam:api:Parkinglots|Parkinglots( ActionID, Result)]]|Список парковочных слотов|
| [[doc:1cajam:api:PauseMonitor|PauseMonitor(Channel,  ActionID, Result)]]|Временная приостановка записи вызова|
| [[doc:1cajam:api:Ping|Ping(Result)]]|В ответ получим “Pong”|
| [[doc:1cajam:api:PlayDTMF|PlayDTMF(Channel,  Digit , ActionID, Result)]]|Генерация DTMF сигнала на заданном канале|
| [[doc:1cajam:api:PresenceState|PresenceState(Provider,ActionID, Result)]]|Получить состояние| 
| [[doc:1cajam:api:PRIShowSpans|PRIShowSpans( Span,  ActionID, Result)]]|Функция, аналогичная команде CLI «pri show spans»|
| [[doc:1cajam:api:QueueAdd|QueueAdd(Queue,  Interface,   Penalty,  Paused, MemberName, StateInterface, ActionID, Result)]]|Добавление интерфейса в очередь вызовов|
| [[doc:1cajam:api:QueueLog|QueueLog(Queue,  Event, Uniqueid, Interface, Message, ActionID, Result)]]|Добавить произвольную запись в queue_log|
| [[doc:1cajam:api:QueueMemberRingInUse|QueueMemberRingInUse(Interface,RingInUse,Queue,ActionID, Result)]]|Установить параметр RingInUse, отвечающий за то будет ли звонить телефон агента во время текущего разговора.|
| [[doc:1cajam:api:QueuePause|QueuePause(Queue, Interface, Paused, Reason, ActionID, Result)]]|Отмечает или снимает отметку временной недоступности участника, обрабатывающего очередь вызовов|
| [[doc:1cajam:api:QueuePenalty|QueuePenalty(Interface,  Penalty,Queue ,ActionID, Result)]]|Установка пенальти для участника, обрабатывающего очередь вызовов|
| [[doc:1cajam:api:QueueReload|QueueReload(Queue, Members, Rules, Parameters, ActionID, Result)]]|Перезагрузка очереди, очередей или любой подгруппы очереди или очередей вызова|
| [[doc:1cajam:api:QueueRemove|QueueRemove(Queue,  Interface,   ActionID, Result)]]|Удаление интерфейса из очереди вызовов|
| [[doc:1cajam:api:QueueReset|QueueReset(Queue, ActionID, Result)]]|Сброс статистики очереди вызовов|
| [[doc:1cajam:api:QueueRule|QueueRule(Rule, ActionID, Result)]]|Правила очереди вызовов|
| [[doc:1cajam:api:Queues|Queues(ActionID, Result)]]|Список очередей вызовов|
| [[doc:1cajam:api:QueueStatus|QueueStatus(Queue, Member, ActionID, Result)]]|Статус очереди вызова|
| [[doc:1cajam:api:QueueSummary|QueueSummary(Queue, ActionID, Result)]]|Основная информация очереди вызова|
| [[doc:1cajam:api:Redirect|Redirect(Channel, ExtraChannel, Exten, ExtraExten, Context, ExtraContext, Priority, ExtraPriority, ActionID, Result)]]| Перенаправление вызова.|
| [[doc:1cajam:api:Reload|Reload(Module ,  ActionID, Result)]]|Отправить команду на перезагрузку указанного модуля Asterisk|
| [[doc:1cajam:api:SendText|SendText(Channel,  Message ,  ActionID, Result)]]|Отправить текстовое сообщение в канал|
| [[doc:1cajam:api:SetVar|SetVar(Channel,  Variable,  Value,  ActionID, Result)]]|Установка переменной канала или глобальной переменной.| 
| [[doc:1cajam:api:ShowDialPlan|ShowDialPlan( Extension ,  Context,  ActionID, Result)]]|Отобразить диалплан или все диалпланы|
| [[doc:1cajam:api:SIPnotify|SIPnotify(Channel,  Variable ,  ActionID, Result)]]|Отправить уведомление в SIP канал|
| [[doc:1cajam:api:SIPpeers|SIPpeers(ActionID, Result)]]|Список SIP пиров. (текстовый формат)|
| [[doc:1cajam:api:SIPpeerstatus|SIPpeerstatus(Peer,ActionID, Result)]]|Отображает состояния одного или всех SIP пиров |
| [[doc:1cajam:api:SIPqualifypeer|SIPqualifypeer(Peer ,  ActionID, Result)]]|Показать состояние SIP пира(текстовый формат)|
| [[doc:1cajam:api:SIPshowPeer|SIPshowPeer(Peer,  ActionID, Result)]]|Получение данных SIP пира (текстовый формат)|
| [[doc:1cajam:api:SIPshowregistry|SIPshowregistry( ActionID, Result)]]|Отобразить зарегистрированных SIP пиров (текстовый формат)|
| [[doc:1cajam:api:SKINNYdevices|SKINNYdevices(ActionID, Result)]]|Списки Skinny устройств в текстовом формате c подробной информацией о текущем состоянии|
| [[doc:1cajam:api:SKINNYlines|SKINNYlines(ActionID, Result)]]|Списки Skinny линий в текстовом формате с подробной информацией о текущем состоянии|
| [[doc:1cajam:api:SKINNYshowdevice|SKINNYshowdevice(Device,  ActionID, Result)]]|Отображает одно Skinny устройство c подробной информацией о текущем состоянии|
| [[doc:1cajam:api:SKINNYshowline|SKINNYshowline(Line, ActionID, Result)]]|Отображает все Skinny устройства c подробной информацией о текущем состоянии|
| [[doc:1cajam:api:Status|Status(Channel,Variables, ActionID, Result)]]|Получение состояний активных каналов|
| [[doc:1cajam:api:StopMixMonitor|StopMixMonitor(Channel,MixMonitorID,ActionID, Result)]]|Останов записи разговора|
| [[doc:1cajam:api:StopMonitor|StopMonitor(Channel, ActionID, Result)]]| Останов записи разговора на заданном канале|
| [[doc:1cajam:api:UnpauseMonitor|UnpauseMonitor(Channel, ActionID, Result)]]|Возобновление остановленной записи вызова |
| [[doc:1cajam:api:UpdateConfig|UpdateConfig(SrcFilename, DstFilename, Reload,  Action, Cat,  Var,  Value,  Match, Line, ActionID, Result)]]|Перезапись файла конфигурации|
| [[doc:1cajam:api:UserEvent|UserEvent(UserEvent,Header1,Header2,Header3,Header4,Header5,Header6, ActionID, Result)]]|Отправка пользовательского события в AMI|
| [[doc:1cajam:api:VoicemailUsersList|VoicemailUsersList(ActionID, Result)]]|Команда отображает список всех пользователей голосовой почты|
===== Универсальная команда =====
Так как AMI интерфейс постоянно развивается, мы предусмотрели в компоненте возможность отправки команды универсальным способом. В результате вы сможете отправлять еще не реализованные в компоненте AMI команды из 1С:Предприятия.

  * [[doc:1cajam:api:RawCommand|RawCommand]] - отправка любой произвольной команды на Asterisk
  * [[doc:1cajam:api:RawCommandAsync|RawCommandAsync]] - отправка любой произвольной команды на Asterisk в асинхронном режиме

===== Отправка файлов через AJAM интерфейс Asterisk =====

  * [[doc:1cajam:api:PostFile|PostFile(FileName, Result)]] - отправка файла на сервер Asterisk используя проктокол AJAM. 
  
===== Параметры компонента =====
^Параметр^Описание^
|Host|Адрес сервера Asterisk|
|Port|Порт на котором опубликован AJAM интерфейс, по-умолчанию 8088|
|Prefix|Префикс AJAM интерфейса, по-умолчанию asterisk|
|Enabled|Состояние компонента, если true значит компонент соединен с Asterisk|
|DigestAutorization|Режима Digest авторизации в AJAM инетрфейсе|
|ObjectEventMode|Если установить в true, то все внешние события будут возбраняться в виде строки которая вычисляется функцией 1С "Вычислить"|
|SOAPEvents|Если установить в true включится режим отправки всех событий на указанный в следующем параметре адрес|
|SOAPUrl|Полный путь к вебсервису, способному обрабатывать события Asterisk|
|EventsTimeout|Таймаут обработки событий Asterisk|
|UseHTTPS|Если установить в true, компонент будет шифровать все сообщения AJAM|
|Version|Возвращает версию компонента|
|HaspLicenseServer|Адрес сервера лицензирования HASP|
|Proxy|Адрес HTTP прокси сервера|
|PorxyLogin|Логин на HTTP прокси|
|PorxySecret|Пароль на HTTP прокси|
|MikoLicense|Параметр для установки облачной лицензии МИКО SAAS|
|LicenseMode|Возвращает текущий режим лицензирования компонента| 
===== Полезные ссылки =====
  * [[kb:asterisk:ami|Список всех команд AMI Asterisk]]
  * [[doc:1cajam|SDK: Компонента связи 1C и Asterisk]]