nami-cc
Version:
fork https://github.com/marcelog/Nami An asterisk manager interface client, uses EventEmitter to communicate events, will allow you to send actions, and receive responses (and associated events), and also receive async events from server
1,506 lines (1,393 loc) • 44.3 kB
JavaScript
/*!
* Action message.
*
* Copyright 2011 Marcelo Gornstein <marcelog@gmail.com>
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
/**
* @fileoverview Base action class.
*
* @author Marcelo Gornstein - http://marcelog.github.com
* Website: http://marcelog.github.com/Nami
*/
'use strict';
const util = require('util');
let message = require(__dirname + '/message.js');
/**
* Base action class. Every action sent to AMI must be one of these.
* @constructor
* @param {String} name The name of the action, this is the actual value of the
* "Action" key in the action message.
* @see Message#marshall(String)
* @augments Message
*/
function Action(name) {
Action.super_.call(this);
this.id = ActionUniqueId();
this.set('ActionID', this.id);
this.set('Action', name);
}
let ActionUniqueId = (() => {
let nextId = 0;
return () => {
return nextId++;
}
})();
/**
* Login Action.
* @constructor
* @param {String} username The username. The value of the "Username" key.
* @param {String} secret The password. The value of the "Secret" key.
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Login">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Login</a>.
* @augments Action
*/
function Login(username, secret) {
Login.super_.call(this, 'Login');
this.set('Username', username);
this.set('Secret', secret );
}
/**
* CoreShowChannels Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_CoreShowChannels">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_CoreShowChannels</a>.
* @augments Action
*/
function CoreShowChannels() {
CoreShowChannels.super_.call(this, 'CoreShowChannels');
}
/**
* Ping Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Ping">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Ping</a>.
* @augments Action
*/
function Ping() {
Ping.super_.call(this, 'Ping');
}
/**
* Hangup Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Hangup">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Hangup</a>.
* @augments Action
* @property {String} Channel Channel to hangup.
*/
function Hangup() {
Hangup.super_.call(this, 'Hangup');
}
/**
* CoreStatus Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_CoreStatus">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_CoreStatus</a>.
* @augments Action
*/
function CoreStatus() {
CoreStatus.super_.call(this, 'CoreStatus');
}
/**
* Status Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Status">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Status</a>.
* @augments Action
* @property {String} Channel Optional channel to get status from. Do not set this property
* if you want to get all channels
*/
function Status() {
Status.super_.call(this, 'Status');
}
/**
* DahdiShowChannels Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_DAHDIShowChannels">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_DAHDIShowChannels</a>.
* @augments Action
*/
function DahdiShowChannels() {
DahdiShowChannels.super_.call(this, 'DahdiShowChannels');
}
/**
* CoreSettings Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_CoreSettings">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_CoreSettings</a>.
* @augments Action
*/
function CoreSettings() {
CoreSettings.super_.call(this, 'CoreSettings');
}
/**
* ListCommands Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_ListCommands">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_ListCommands</a>.
* @augments Action
*/
function ListCommands() {
ListCommands.super_.call(this, 'ListCommands');
}
/**
* Logoff Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Logoff">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Logoff</a>.
* @augments Action
*/
function Logoff() {
Logoff.super_.call(this, 'Logoff');
}
/**
* AbsoluteTimeout Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_AbsoluteTimeout">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_AbsoluteTimeout</a>.
* @augments Action
* @property {String} Channel to hangup.
* @property {Integer} Timeout in seconds.
*/
function AbsoluteTimeout() {
AbsoluteTimeout.super_.call(this, 'AbsoluteTimeout');
}
/**
* SIPShowPeer Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_SIPshowpeer">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_SIPshowpeer</a>.
* @augments Action
* @property {String} Peer SIP peer name
*/
function SipShowPeer() {
SipShowPeer.super_.call(this, 'SIPshowpeer');
}
/*
* Add by Tqc
* @see <a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+ManagerAction_SIPpeerstatus">SIPpeerstatus</a>
*/
function SIPpeerstatus(){
SIPpeerstatus.super_.call(this, 'SIPpeerstatus');
}
/**
* SIPShowRegistry Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_SIPshowregistry">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_SIPshowregistry</a>.
* @augments Action
*/
function SipShowRegistry() {
SipShowRegistry.super_.call(this, 'SIPshowregistry');
}
/**
* SIPQualifyPeer Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_SIPqualifypeer">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_SIPqualifypeer</a>.
* @augments Action
* @property {String} Peer SIP peer name
*/
function SipQualifyPeer() {
SipQualifyPeer.super_.call(this, 'SIPqualifypeer');
}
/**
* SIPPeers Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_SIPpeers">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_SIPpeers</a>.
* @augments Action
*/
function SipPeers() {
SipPeers.super_.call(this, 'SIPpeers');
}
/**
* PJSIPNotify Action.
* @constructor
* @see Action(String)
* @augments Action
*/
function PJSIPNotify() {
PJSIPNotify.super_.call(this, 'PJSIPNotify');
}
/**
* PJSIPQualify Action.
* @constructor
* @see Action(String)
* @augments Action
*/
function PJSIPQualify() {
PJSIPQualify.super_.call(this, 'PJSIPQualify');
}
/**
* PJSIPRegister Action.
* @constructor
* @see Action(String)
* @augments Action
*/
function PJSIPRegister() {
PJSIPRegister.super_.call(this, 'PJSIPRegister');
}
/**
* PJSIPShowAors Action.
* @constructor
* @see Action(String)
* @augments Action
*/
function PJSIPShowAors() {
PJSIPShowAors.super_.call(this, 'PJSIPShowAors');
}
/**
* PJSIPShowAuths Action.
* @constructor
* @see Action(String)
* @augments Action
*/
function PJSIPShowAuths() {
PJSIPShowAuths.super_.call(this, 'PJSIPShowAuths');
}
/**
* PJSIPShowContacts Action.
* @constructor
* @see Action(String)
* @augments Action
*/
function PJSIPShowContacts() {
PJSIPShowContacts.super_.call(this, 'PJSIPShowContacts');
}
/**
* PJSIPShowEndpoint Action.
* @constructor
* @see Action(String)
* @augments Action
*/
function PJSIPShowEndpoint() {
PJSIPShowEndpoint.super_.call(this, 'PJSIPShowEndpoint');
}
/**
* PJSIPShowEndpoints Action.
* @constructor
* @see Action(String)
* @augments Action
*/
function PJSIPShowEndpoints() {
PJSIPShowEndpoints.super_.call(this, 'PJSIPShowEndpoints');
}
/**
* PJSIPShowRegistrationInboundContactStatuses Action.
* @constructor
* @see Action(String)
* @augments Action
*/
function PJSIPShowRegistrationInboundContactStatuses() {
PJSIPShowRegistrationInboundContactStatuses.super_.call(this, 'PJSIPShowRegistrationInboundContactStatuses');
}
/**
* PJSIPShowRegistrationsInbound Action.
* @constructor
* @see Action(String)
* @augments Action
*/
function PJSIPShowRegistrationsInbound() {
PJSIPShowRegistrationsInbound.super_.call(this, 'PJSIPShowRegistrationsInbound');
}
/**
* PJSIPShowRegistrationsOutbound Action.
* @constructor
* @see Action(String)
* @augments Action
*/
function PJSIPShowRegistrationsOutbound() {
PJSIPShowRegistrationsOutbound.super_.call(this, 'PJSIPShowRegistrationsOutbound');
}
/**
* PJSIPShowResourceLists Action.
* @constructor
* @see Action(String)
* @augments Action
*/
function PJSIPShowResourceLists() {
PJSIPShowResourceLists.super_.call(this, 'PJSIPShowResourceLists');
}
/**
* PJSIPShowSubscriptionsInbound Action.
* @constructor
* @see Action(String)
* @augments Action
*/
function PJSIPShowSubscriptionsInbound() {
PJSIPShowSubscriptionsInbound.super_.call(this, 'PJSIPShowSubscriptionsInbound');
}
/**
* PJSIPShowSubscriptionsOutbound Action.
* @constructor
* @see Action(String)
* @augments Action
*/
function PJSIPShowSubscriptionsOutbound() {
PJSIPShowSubscriptionsOutbound.super_.call(this, 'PJSIPShowSubscriptionsOutbound');
}
/**
* PJSIPUnregister Action.
* @constructor
* @see Action(String)
* @augments Action
*/
function PJSIPUnregister() {
PJSIPUnregister.super_.call(this, 'PJSIPUnregister');
}
/**
* AgentLogoff Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_AgentLogoff">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_AgentLogoff</a>.
* @property {String} Agent Agent name
* @property {String} Soft Set to true to not hangup existing calls
* @augments Action
*/
function AgentLogoff() {
AgentLogoff.super_.call(this, 'AgentLogoff');
}
/**
* Agents Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Agents">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Agents</a>.
* @augments Action
*/
function Agents() {
Agents.super_.call(this, 'Agents');
}
/**
* AttendedTransfer Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Atxfer">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Atxfer</a>.
* @property {String} Channel Channel to transfer
* @property {String} Exten Extension to transfer to
* @property {String} Context Context to transfer to
* @property {String} Priority Priority to transfer to
* @augments Action
*/
function AttendedTransfer() {
AttendedTransfer.super_.call(this, 'Atxfer');
}
/**
* ChangeMonitor Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_ChangeMonitor">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_ChangeMonitor</a>.
* @property {String} Channel Channel to monitor
* @property {String} File File where to save the audio
* @augments Action
*/
function ChangeMonitor() {
ChangeMonitor.super_.call(this, 'ChangeMonitor');
}
/**
* Command Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Command">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Command</a>.
* @property {String} Command Command to send
* @augments Action
*/
function Command() {
Command.super_.call(this, 'Command');
}
/**
* CreateConfig Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_CreateConfig">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_CreateConfig</a>.
* @property {String} Filename Filename to create
* @augments Action
*/
function CreateConfig() {
CreateConfig.super_.call(this, 'CreateConfig');
}
/**
* DahdiDialOffHook Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_DAHDIDialOffhook">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_DAHDIDialOffhook</a>.
* @property {String} DAHDIChannel Dahdi Channel to use
* @property {String} Number Number to dial
* @augments Action
*/
function DahdiDialOffHook() {
DahdiDialOffHook.super_.call(this, 'DahdiDialOffHook');
}
/**
* DahdiDndOff Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_DAHDIDNDOff">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_DAHDIDNDOff</a>.
* @property {String} DAHDIChannel Dahdi Channel
* @augments Action
*/
function DahdiDndOff() {
DahdiDndOff.super_.call(this, 'DahdiDndOff');
}
/**
* DahdiDndOn Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_DAHDIDNDOn">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_DAHDIDNDOn</a>.
* @property {String} DAHDIChannel Dahdi Channel
* @augments Action
*/
function DahdiDndOn() {
DahdiDndOn.super_.call(this, 'DahdiDndOn');
}
/**
* DahdiHangup Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_DAHDIHangup">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_DAHDIHangup</a>.
* @property {String} DAHDIChannel Dahdi Channel
* @augments Action
*/
function DahdiHangup() {
DahdiHangup.super_.call(this, 'DahdiHangup');
}
/**
* DahdiRestart Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_DAHDIRestart">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_DAHDIRestart</a>.
* @augments Action
*/
function DahdiRestart() {
DahdiRestart.super_.call(this, 'DahdiRestart');
}
/**
* DbDel Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_DbDel">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_DbDel</a>.
* @property {String} Family Key Family
* @property {String} Key Key Name
* @augments Action
*/
function DbDel() {
DbDel.super_.call(this, 'DbDel');
}
/**
* DbDeltree Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_DbDeltree">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_DbDeltree</a>.
* @property {String} Family Key Family
* @property {String} Key Optional Key Name
* @augments Action
*/
function DbDeltree() {
DbDeltree.super_.call(this, 'DbDeltree');
}
/**
* DbGet Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_DbGet">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_DbGet</a>.
* @property {String} Family Key Family
* @property {String} Key Key Name
* @augments Action
*/
function DbGet() {
DbGet.super_.call(this, 'DbGet');
}
/**
* DbPut Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_DbPut">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_DbPut</a>.
* @property {String} Family Key Family
* @property {String} Key Key Name
* @property {String} Value Value
* @augments Action
*/
function DbPut() {
DbPut.super_.call(this, 'DbPut');
}
/**
* ExtensionState Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_ExtensionState">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_ExtensionState</a>.
* @property {String} Exten Extension
* @property {String} Context Context of the extension
* @augments Action
*/
function ExtensionState() {
ExtensionState.super_.call(this, 'ExtensionState');
}
/**
* ExtensionStateList Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_ExtensionStateList">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_ExtensionStateList</a>.
* @property {String} Exten Extension
* @property {String} Context Context of the extension
* @augments Action
*/
function ExtensionStateList() {
ExtensionStateList.super_.call(this, 'ExtensionStateList');
}
/**
* GetConfig Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_GetConfig">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_GetConfig</a>.
* @property {String} Filename File to get configuration from.
* @property {String} Category Optional category to retrieve.
* @augments Action
*/
function GetConfig() {
GetConfig.super_.call(this, 'GetConfig');
}
/**
* GetConfigJson Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_GetConfigJson">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_GetConfigJson</a>.
* @property {String} Filename File to get configuration from.
* @augments Action
*/
function GetConfigJson() {
GetConfigJson.super_.call(this, 'GetConfigJson');
}
/**
* UpdateConfig Action
* Add by Tqc
*
*/
function UpdateConfig()
{
UpdateConfig.super_.call(this,'UpdateConfig');
}
/**
* GetVar Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_GetVar">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_GetVar</a>.
* @property {String} Variable Variable Name
* @property {String} Channel Optional Channel name.
* @augments Action
*/
function GetVar() {
GetVar.super_.call(this, 'GetVar');
}
/**
* JabberSend Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_JabberSend">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_JabberSend</a>.
* @property {String} Jabber Client or transport Asterisk uses to connect to JABBER
* @property {String} JID XMPP/Jabber JID (Name) of recipient
* @property {String} Message Message to be sent to the buddy
* @augments Action
*/
function JabberSend() {
JabberSend.super_.call(this, 'JabberSend');
}
/**
* ListCategories Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_ListCategories">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_ListCategories</a>.
* @property {String} Filename File to get categories from.
* @augments Action
*/
function ListCategories() {
ListCategories.super_.call(this, 'ListCategories');
}
/**
* PauseMonitor Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_PauseMonitor">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_PauseMonitor</a>.
* @property {String} Channel Pause monitor on this channel
* @augments Action
*/
function PauseMonitor() {
PauseMonitor.super_.call(this, 'PauseMonitor');
}
/**
* UnpauseMonitor Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_UnpauseMonitor">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_UnpauseMonitor</a>.
* @property {String} Channel Continue monitor this channel
* @augments Action
*/
function UnpauseMonitor() {
UnpauseMonitor.super_.call(this, 'UnpauseMonitor');
}
/**
* StopMonitor Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_StopMonitor">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_StopMonitor</a>.
* @property {String} Channel Stop monitor this channel
* @augments Action
*/
function StopMonitor() {
StopMonitor.super_.call(this, 'StopMonitor');
}
/**
* LocalOptimizeAway Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_LocalOptimizeAway">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_LocalOptimizeAway</a>.
* @property {String} Channel Channel
* @augments Action
*/
function LocalOptimizeAway() {
LocalOptimizeAway.super_.call(this, 'LocalOptimizeAway');
}
/**
* SetVar Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_SetVar">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_SetVar</a>.
* @property {String} Variable Variable Name
* @property {String} Value Variable Value
* @property {String} Channel Optional Channel name.
* @augments Action
*/
function SetVar() {
SetVar.super_.call(this, 'SetVar');
}
/**
* Reload Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Reload">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Reload</a>.
* @property {String} Module Optional module name
* @augments Action
*/
function Reload() {
Reload.super_.call(this, 'Reload');
}
/**
* PlayDtmf Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_PlayDtmf">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_PlayDtmf</a>.
* @property {String} Channel Channel where to play the dtmf
* @property {String} Digit DTMF digit to play
* @augments Action
*/
function PlayDtmf() {
PlayDtmf.super_.call(this, 'PlayDtmf');
}
/**
* Park Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Park">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Park</a>.
* @property {String} Channel Channel name to park
* @property {String} Channel2 Channel to announce park info to (and return to if timeout)
* @property {String} Timeout Optional number of milliseconds to wait before callback
* @property {String} Parkinglot Optional parking lot to park channel in
* @augments Action
*/
function Park() {
Park.super_.call(this, 'Park');
}
/**
* ParkedCalls Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+ManagerAction_ParkedCalls">https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+ManagerAction_ParkedCalls</a>.
* @property {String} ParkingLot Optional parking lot to view
* @augments Action
*/
function ParkedCalls(lot) {
ParkedCalls.super_.call(this, 'ParkedCalls');
if (undefined !== lot) {
this.set('ParkingLot', lot);
}
}
/**
* Parkinglots Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+ManagerAction_Parkinglots">https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+ManagerAction_Parkinglots</a>.
* @augments Action
*/
function Parkinglots() {
Parkinglots.super_.call(this, 'Parkinglots');
}
/**
* Monitor Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Monitor">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Monitor</a>.
* @property {String} Channel Channel name to park
* @property {String} Filename Path where to save the audio
* @augments Action
*/
function Monitor() {
Monitor.super_.call(this, 'Monitor');
this.format = 'wav';
this.mix = 'true';
}
/**
* ModuleCheck Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_ModuleCheck">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_ModuleCheck</a>.
* @property {String} Module Module name, including .so
* @augments Action
*/
function ModuleCheck() {
ModuleCheck.super_.call(this, 'ModuleCheck');
}
/**
* ModuleLoad Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_ModuleLoad">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_ModuleLoad</a>.
* @property {String} Module Module name, including .so
* @augments Action
*/
function ModuleLoad() {
ModuleLoad.super_.call(this, 'ModuleLoad');
this.LoadType = 'load';
}
/**
* ModuleUnload Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_ModuleUnload">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_ModuleUnload</a>.
* @property {String} Module Module name, including .so
* @augments Action
*/
function ModuleUnload() {
ModuleUnload.super_.call(this, 'ModuleUnload');
this.LoadType = 'unload';
}
/**
* ModuleReload Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_ModuleReload">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_ModuleReload</a>.
* @property {String} Module Module name, including .so
* @augments Action
*/
function ModuleReload() {
ModuleReload.super_.call(this, 'ModuleReload');
this.LoadType = 'reload';
}
/**
* MailboxCount Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_MailboxCount">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_MailboxCount</a>.
* @property {String} Mailbox Mailbox to retrieve count from
* @augments Action
*/
function MailboxCount() {
MailboxCount.super_.call(this, 'MailboxCount');
}
/**
* MailboxStatus Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_MailboxStatus">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_MailboxStatus</a>.
* @property {String} Mailbox Mailbox to retrieve count from
* @augments Action
*/
function MailboxStatus() {
MailboxStatus.super_.call(this, 'MailboxStatus');
}
/**
* VoicemailUsersList Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_VoicemailUsersList">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_VoicemailUsersList</a>.
* @augments Action
*/
function VoicemailUsersList() {
VoicemailUsersList.super_.call(this, 'VoicemailUsersList');
}
/**
* Redirect Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Redirect">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Redirect</a>.
* @augments Action
* @property {String} Channel Channel to transfer
* @property {String} Exten Extension to transfer to
* @property {String} Context Context to transfer to
* @property {String} Priority Priority to transfer to
* @property {String} ExtraChannel Optional Second call leg to transfer
* @property {String} ExtraExten Optional Extension to transfer extra channel
* @property {String} ExtraContext Optional Context to transfer extra channel
* @property {String} ExtraPriority Optional Priority to transfer extra channel
*/
function Redirect() {
Redirect.super_.call(this, 'Redirect');
}
/**
* Bridge Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Bridge">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Bridge</a>.
* @augments Action
* @property {String} Channel1 Channel to Bridge to Channel2
* @property {String} Channel2 Channel to Bridge to Channel1
* @property {String} Tone Play courtesy tone to Channel 2 [yes/no]
*/
function Bridge() {
Bridge.super_.call(this, 'Bridge');
}
/**
* ShowDialPlan Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_ShowDialPlan">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_ShowDialPlan</a>.
* @property {String} Context Optional context to list
* @property {String} Extension Optional extension to list
* @augments Action
*/
function ShowDialPlan() {
ShowDialPlan.super_.call(this, 'ShowDialPlan');
}
/**
* SendText Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_SendText">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_SendText</a>.
* @property {String} Channel Channel where to send the message
* @property {String} Message Message to send
* @augments Action
*/
function SendText() {
SendText.super_.call(this, 'SendText');
}
/**
* Queues Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Queues">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Queues</a>.
* @augments Action
*/
function Queues() {
Queues.super_.call(this, 'Queues');
}
/**
* QueueReload Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_QueueReload">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_QueueReload</a>.
* @property {String} Queue Optional, Queue
* @property {String} Members Optional, yes/no
* @property {String} Rules Optional, yes/no
* @property {String} Parameters Optional, yes/no
* @augments Action
*/
function QueueReload(queue, members, rules, parameters) {
QueueReload.super_.call(this, 'QueueReload');
if (undefined !== queue) {
this.set('queue', queue);
}
if (undefined !== members) {
this.set('members', members);
}
if (undefined !== rules) {
this.set('rules', rules);
}
if (undefined !== parameters) {
this.set('parameters', parameters);
}
}
/**
* QueueUnpause Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_QueuePause">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_QueuePause</a>.
* @property {String} Interface Interface
* @property {String} Queue Optional, Queue
* @property {String} Reason Optional, reason description
* @augments Action
*/
function QueueUnpause(asteriskInterface, queue, reason) {
QueueUnpause.super_.call(this, 'QueuePause');
this.set('paused', 'false');
this.set('interface', asteriskInterface);
if (undefined !== queue) {
this.set('queue', queue);
}
if (undefined !== reason) {
this.set('reason', reason);
}
}
/**
* QueueUnpause Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_QueuePause">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_QueuePause</a>.
* @property {String} Interface Interface
* @property {String} Queue Optional, Queue
* @property {String} Reason Optional, reason description
* @augments Action
*/
function QueuePause(asteriskInterface, queue, reason) {
QueuePause.super_.call(this, 'QueuePause');
this.set('paused', 'true');
this.set('interface', asteriskInterface);
if (undefined !== queue) {
this.set('queue', queue);
}
if (undefined !== reason) {
this.set('reason', reason);
}
}
/**
* QueueSummary Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_QueueSummary">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_QueueSummary</a>.
* @property {String} Queue Optional, Queue
* @augments Action
*/
function QueueSummary(queue) {
QueueSummary.super_.call(this, 'QueueSummary');
if (undefined != queue) {
this.set('Queue', queue);
}
}
/**
* QueueRule Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_QueueRule">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_QueueRule</a>.
* @property {String} Rule Optional, Rule
* @augments Action
*/
function QueueRule() {
QueueRule.super_.call(this, 'QueueRule');
}
/**
* QueueStatus Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_QueueStatus">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_QueueStatus</a>.
* @property {String} Queue Optional, Queue
* @property {String} Member Optional, Member
* @augments Action
*/
function QueueStatus(queue, member) {
QueueStatus.super_.call(this, 'QueueStatus');
if (undefined != queue) {
this.set('Queue', queue);
}
if (undefined != member) {
this.set('Member', member);
}
}
/**
* QueueReset Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_QueueReset">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_QueueReset</a>.
* @property {String} Queue Optional, Queue
* @augments Action
*/
function QueueReset() {
QueueReset.super_.call(this, 'QueueReset');
}
/**
* QueueRemove Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_QueueRemove">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_QueueRemove</a>.
* @property {String} Queue Queue
* @property {String} Interface Interface
* @augments Action
*/
function QueueRemove(asteriskInterface, queue) {
QueueRemove.super_.call(this, 'QueueRemove');
this.set('interface', asteriskInterface);
this.set('queue', queue);
}
/**
* Originate Action
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Originate">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Originate</a>.
* @property {String} Channel Channel
* @property {String} Exten Exten
* @property {String} Priority Priority
* @property {String} Application Application
* @property {String} Data Data
* @property {String} Timeout Timeout
* @property {String} CallerID CallerID
* @property {String} Account Account
* @property {String} Async Async
* @property {String} Codecs Codecs
* @augments Action
*/
function Originate() {
Originate.super_.call(this, 'Originate');
}
/**
* QueueAdd Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_QueueAdd">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_QueueAdd</a>.
* @property {String} Queue Queue
* @property {String} Interface Interface
* @property {String} Paused Optional, 'true' or 'false
* @property {String} MemberName Optional, Member name
* @property {String} Penalty Optional, Penalty
* @property {String} StateInterface Optional, State interface
* @augments Action
*/
function QueueAdd(asteriskInterface, queue, paused, memberName, penalty) {
QueueAdd.super_.call(this, 'QueueAdd');
this.set('interface', asteriskInterface);
this.set('queue', queue);
if (undefined !== paused) {
this.set('paused', paused);
}
if (undefined !== memberName) {
this.set('membername', memberName);
}
if (undefined !== penalty) {
this.set('penalty', penalty);
}
}
/**
* QueueLog Action.
* @constructor
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/ManagerAction_QueueLog">https://wiki.asterisk.org/wiki/display/AST/ManagerAction_QueueLog</a>.
* @property {String} Queue Queue
* @property {String} Event Event
* @property {String} Message Optional, Message
* @property {String} Interface Optional, Interface
* @property {String} UniqueId Optional, UniqueId
* @augments Action
*/
function QueueLog() {
QueueLog.super_.call(this, 'QueueLog');
}
/**
* MeetmeList Action.
* @constructor
* @see Action(String)
* @augments Action
*/
function MeetmeList(conference) {
MeetmeList.super_.call(this, 'MeetmeList');
if(conference != null) {
this.set('Conference', conference);
}
}
/**
* MeetmeMute Action.
* @constructor
* @see Action(String)
* @augments Action
*/
function MeetmeMute(meetme, usernum) {
MeetmeMute.super_.call(this, 'MeetmeMute');
this.set('Meetme', meetme);
this.set('Usernum', usernum);
}
/**
* MeetmeUnmute Action.
* @constructor
* @see Action(String)
* @augments Action
*/
function MeetmeUnmute(meetme, usernum) {
MeetmeUnmute.super_.call(this, 'MeetmeUnmute');
this.set('Meetme', meetme);
this.set('Usernum', usernum);
}
/**
* ConfbridgeListRooms Action.
* @constructor
* @see Action(String)
* @augments Action
*/
function ConfbridgeListRooms() {
ConfbridgeListRooms.super_.call(this, 'ConfbridgeListRooms');
}
/**
* ConfbridgeList Action.
* @constructor
* @see Action(String)
* @param {String} conference room. The value of the "conference" key.
* @augments Action
*/
function ConfbridgeList(conference) {
ConfbridgeList.super_.call(this, 'ConfbridgeList');
this.set('Conference', conference);
}
/**
* ConfbridgeKick Action.
* @constructor
* @see Action(String)
* @param {String} conference room. The value of the "conference" key.
* @param {String} Channel. The value of the "Channel" key.
* @augments Action
*/
function ConfbridgeKick(conference, channel) {
ConfbridgeKick.super_.call(this, 'ConfbridgeKick');
this.set('Conference', conference);
this.set('Channel', channel);
}
/**
* ConfbridgeLock Action.
* @constructor
* @see Action(String)
* @param {String} conference room. The value of the "conference" key.
* @augments Action
*/
function ConfbridgeLock(conference) {
ConfbridgeLock.super_.call(this, 'ConfbridgeLock');
this.set('Conference', conference);
}
/**
* ConfbridgeUnlock Action.
* @constructor
* @see Action(String)
* @param {String} conference room. The value of the "conference" key.
* @augments Action
*/
function ConfbridgeUnlock(conference) {
ConfbridgeUnlock.super_.call(this, 'ConfbridgeUnlock');
this.set('Conference', conference);
}
/**
* ConfbridgeMute Action.
* @constructor
* @see Action(String)
* @param {String} conference room. The value of the "conference" key.
* @param {String} Channel. The value of the "Channel" key.
* @augments Action
*/
function ConfbridgeMute(conference, channel) {
ConfbridgeMute.super_.call(this, 'ConfbridgeMute');
this.set('Conference', conference);
this.set('Channel', channel);
}
/**
* ConfbridgeUnmute Action.
* @constructor
* @see Action(String)
* @param {String} conference room. The value of the "conference" key.
* @param {String} Channel. The value of the "Channel" key.
* @augments Action
*/
function ConfbridgeUnmute(conference, channel) {
ConfbridgeUnmute.super_.call(this, 'ConfbridgeUnmute');
this.set('Conference', conference);
this.set('Channel', channel);
}
/**
* AGI Action.
* @constructor
* @see Action(String)
* @see https://wiki.asterisk.org/wiki/display/AST/ManagerAction_AGI
* @param {String} Channel that is currently in Async AGI.
* @param {String} Application to execute.
* @param {String} This will be sent back in CommandID header of AsyncAGI exec event notification.
* @augments Action
*/
function AGI(channel, command, commandId) {
AGI.super_.call(this, 'AGI');
this.set('Channel', channel);
this.set('Command', command);
this.set('CommandID', commandId);
}
/**
* BlindTransfer Action.
* @constructor
* @see Action(String)
* @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+ManagerAction_BlindTransfer
* @param {String} Channel channel that wants to transfer the target channel.
* @param {String} Context to transfer the target channel to.
* @param {String} Exten inside the context to transfer the target channel to.
* @augments Action
*/
function BlindTransfer(channel, context, exten) {
BlindTransfer.super_.call(this, 'BlindTransfer');
this.set('Channel', channel);
this.set('Context', context);
this.set('Exten', exten);
}
/**
* Filter Action.
* @constructor
* @param {String} operation. The value of the "Operation" key.
* @param {String} filter. The value of the "Filter" key.
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+11+ManagerAction_Filter">https://wiki.asterisk.org/wiki/display/AST/Asterisk+11+ManagerAction_Filter</a>.
* @augments Action
*/
function Filter(operation, filter) {
Filter.super_.call(this, 'Filter');
this.set('Operation', operation);
this.set('Filter', filter);
}
/**
* UserEvent Action.
* @constructor
* @param {String} UserEvent. The name of the event.
* @see Action(String)
* @see See <a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+11+ManagerAction_UserEvent">https://wiki.asterisk.org/wiki/display/AST/Asterisk+11+ManagerAction_UserEvent</a>.
* @augments Action
*/
function UserEvent(event) {
UserEvent.super_.call(this, 'UserEvent');
this.set('UserEvent', event);
}
/**
*
* @param mask
* @constructor
* @see See https://wiki.asterisk.org/wiki/display/AST/Asterisk+11+ManagerAction_Events
*/
function Events(mask) {
Events.super_.call(this, 'Events');
this.set('Eventmask', mask);
}
/**
* List the current known presence states.
*/
function PresenceStateList() {
Events.super_.call(this, 'PresenceStateList');
}
// Inheritance for this module
util.inherits(Action, message.Message);
(function() {
let actions = [
Login,
Logoff,
Ping,
Hangup,
CoreShowChannels,
CoreStatus,
CoreSettings,
Status,
DahdiShowChannels,
ListCommands,
AbsoluteTimeout,
SipShowPeer,
SIPpeerstatus,
SipShowRegistry,
SipQualifyPeer,
SipPeers,
PJSIPNotify,
PJSIPQualify,
PJSIPRegister,
PJSIPShowAors,
PJSIPShowAuths,
PJSIPShowContacts,
PJSIPShowEndpoint,
PJSIPShowEndpoints,
PJSIPShowRegistrationInboundContactStatuses,
PJSIPShowRegistrationsInbound,
PJSIPShowRegistrationsOutbound,
PJSIPShowResourceLists,
PJSIPShowSubscriptionsInbound,
PJSIPShowSubscriptionsOutbound,
PJSIPUnregister,
AgentLogoff,
Agents,
AttendedTransfer,
ChangeMonitor,
Command,
CreateConfig,
DahdiDialOffHook,
DahdiDndOff,
DahdiDndOn,
DahdiHangup,
DahdiRestart,
DbDel,
DbDeltree,
DbGet,
DbPut,
ExtensionState,
ExtensionStateList,
GetConfig,
GetConfigJson,
UpdateConfig,
GetVar,
SetVar,
JabberSend,
ListCategories,
PauseMonitor,
LocalOptimizeAway,
Reload,
PlayDtmf,
Park,
ParkedCalls,
Parkinglots,
Monitor,
ModuleCheck,
ModuleLoad,
ModuleUnload,
ModuleReload,
MailboxCount,
MailboxStatus,
VoicemailUsersList,
Originate,
Redirect,
Bridge,
UnpauseMonitor,
StopMonitor,
ShowDialPlan,
SendText,
Queues,
QueueUnpause,
QueuePause,
QueueReset,
QueueSummary,
QueueStatus,
QueueRemove,
QueueRule,
QueueAdd,
QueueLog,
QueueReload,
MeetmeList,
MeetmeMute,
MeetmeUnmute,
ConfbridgeListRooms,
ConfbridgeList,
ConfbridgeKick,
ConfbridgeLock,
ConfbridgeUnlock,
ConfbridgeMute,
ConfbridgeUnmute,
AGI,
BlindTransfer,
Filter,
Events,
PresenceStateList,
UserEvent
];
for (let i in actions) {
util.inherits(actions[i], Action);
exports[actions[i].name] = actions[i];
}
})();