Docs For Class phpAMI

Class phpAMI

Description

phpAMI-(phpAstersikManaherInterface)

Esta clase ha sido creado con todas los AMI Actions de la documentacion de astersik 1.8

link: https://wiki.asterisk.org/wiki/display/AST/AMI+Actions

Located in /phpAMI.php (line 38)

Variable Summary

string $PORT

string $PRIVILEGE

string $SECRET

string $SERVER

sock $SOCK

string $USER

Method Summary

phpAMI __construct (string $username, string $password, [string $host = "localhost"], [string $port = "5038"])

void __destruct ()

array absoluteTimeout (string $channel, int $timeOut)

array agentLogoff (string $agent, [string $soft = null])

array agents ()

array agi (string $channel, string $command, [string $commandID = null])

void aocMessage (string $channel, string $msgType, string $chargeType, [string $channelPrefix = null], [array $unti = null], [string $currencyName = null], [string $currencyAmount = null], [string $currencyMultiplier = null], [string $totalType = null], [string $aocBillingId = null], [string $chargingAssociationId = null], [string $chargingAssociationNumber = null], [string $chargingAssociationPlan = null])

array aTxfer (string $channel, string $context, string $exten, stirng $priority)

array bridge (string $channel1, string $channel2, [string $tone = "no"])

void challenge ([string $authType = "MD5"])

array changeMonitor (string $channel, string $file)

void closeSock ()

array command (string $command)

array coreSettings ()

array coreShowChannels ()

array coreStatus ()

array createConfig (string $file)

array dahdiDialOffhook (string $channel, string $number)

array dahdiDNDOff (string $channel)

array dahdiDNDOn (string $channel)

array dahdiHangup (string $channel)

array dahdiRestart ()

array dahdiShowChannels ([string $channel = null])

array dahdiTransfer (string $channel)

array dataGet (string $path, [string $search = null], [ $filter = null], string $file)

array dbDel (string $family, array $key)

array dbDelTree (string $family, [array $key = null])

array dbGet (string $family, [string $key = ""], [string $path = ""])

array dbPut (string $family, array $key, [array $val = null])

array events (string $eventMask)

array eventSimple (string $action, [ $arg = array()], [bool $wm = null], array $arguments)

array extensionState (string $exten, string $context)

array getConfig (string $file, [string $category = null])

array getConfigJSON (string $file)

array getVar (string $var, [string $channel = null])

array hangup (string $channel, [string $cause = null])

array iaxNetstats ()

array iaxPeerList ()

array iaxPeers ()

array iaxRegistry ()

array jabberSend (string $jabber, string $jid, string $message)

array listCategories (string $file)

array listCommands ()

array listEvent (string $action, string $keys, [bool $conp = false], [string $items = "ListItems"])

array login ()

array logoff ()

array mailboxCount (string $mailbox)

array mailboxStatus (string $mailbox)

array meetmeList ([string $conference = null])

array meetmeMute (string $conference, int $usernum)

array meetmeUnmute (string $conference, int $usernum)

Ver mixMonitorMute (string $channel, int $state, [string $direction = null])

array moduleCheck (string $mod)

array moduleLoad (string $loadType, [string $mod = null])

array monitor (string $channel, [string $format = null], [string $file = null], [string $mix = null])

bool openSock ()

array originate (string $channel, string $exten, string $context, [string $priority = 1], [string $callerid = null], [string $timeout = null], [string $account = null], [string $codecs = null], [string $variable = null], [string $aplication = null], [string $data = null], [string $async = null])

array park (string $channel, string $channel2, string $parkinglot, [string $timeout = null])

array parkedCalls ()

array pauseMonitor (string $channel)

array ping ()

array playDTMF (string $channel, string $digit)

array queueAdd (string $queue, string $interface, [string $penalty = null], [string $paused = null], [string $memberName = null], [string $stateInterface = null])

array queueLog ( $queue, $event, [ $uniqueid = null], [ $interface = null], [ $message = null])

array queuePause (string $interface, string $paused, [string $queue = null], [string $reason = null])

array queuePenalty (string $interface, string $penalty, [string $queue = null])

array queueReload ([string $queue = null], [string $members = null], [string $rules = null], [string $parameters = null])

array queueRemove (string $queue, string $interface)

array queueReset ([string $queue = null])

array queueRule (string $rule)

Array queues ()

Array queueStatus ([string $queue = null], [string $member = null])

array queueSummary ([string $queue = null])

arry read (string $end)

array readEnd ([bool $sep = false])

array redirect (string $channel, string $context, string $exten, string $priority, [string $extraChannel = null], [string $extraContext = null], [string $extraExten = null], [string $extraPriority = null])

array responceInfo (string $action, bool $wm, [array $arg = array()])

void send (string $action, [array $arguments = array()])

array sendText (string $channel, string $message)

array setVar (string $var, string $value, [string $channel = null])

array showDialPlan ([string $context = null], [string $exten = null])

array sipPeers ()

array sipShowPeer ($string $peer)

array sipShowRegistry ()

array skinnyDevices ()

array skinnyLines ()

Array skinnyShowDevice ( $device, strinf $divice)

Array skinnyShowLine (strinf $line)

array status (string $channel, [string $variables = NULL])

array stopMonitor (string $channel)

array unpauseMonitor (string $channel)

array updateConfig (string $src, string $dst, [array $actions = null], [string $reload = null])

array userEvent (string $userEvent, [array $headers = null])

array voicemailUsersList ()

array waitEvent (int $timeout)

Variables

string $PORT (line 50)

Puerto a conectar

access: private

string $PRIVILEGE (line 74)

Privilegios del usuario

access: private

string $SECRET (line 62)

Clave de usuario

access: private

string $SERVER (line 44)

Host a conectar

access: private

sock $SOCK (line 68)

Socket

access: private

string $USER (line 56)

Usuario a conectar

access: private

Methods

Constructor __construct (line 83)

Constructor

phpAMI __construct (string $username, string $password, [string $host = "localhost"], [string $port = "5038"])

string $username: Nombre de usuario a conectar
string $password: Clave del usuario
string $host: Host a conertar
string $port: Puerto a conectar

Destructor __destruct (line 1923)

Destructor

void __destruct ()

absoluteTimeout (line 167)

Envia "ManagerAction_AbsoluteTimeout"

Cuelga el canal despues de cierto tiempo

return: ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_AbsoluteTimeout

array absoluteTimeout (string $channel, int $timeOut)

string $channel: Canal activo
int $timeOut: Tiempo de espera en segundos

agentLogoff (line 984)

Envia "ManagerAction_AgentLogoff"

Hace logoff aun agente

return: Ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_AgentLogoff
access: public

array agentLogoff (string $agent, [string $soft = null])

string $agent: ID del Agente
string $soft: True para esperar que cuelge si extente una llamada

agents (line 972)

Envia "ManagerAction_Agents"

Lista a todos los agentes y su estado

return: Ver listEvent()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Agents
access: public

array agents ()

agi (line 403)

Envia "ManagerAction_AGI"

Envia Un comando AGI

return: ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_AGI

array agi (string $channel, string $command, [string $commandID = null])

string $channel: Canal
string $command: Comando agi
string $commandID

aocMessage (line 428)

Envia "ManagerAction_AOCMessage"

link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_AOCMessage

string $channel: Canal
string $msgType: tipo de mensaje ("D" para AOC-D o "E" para AOC-E)
string $chargeType: Define que tipo de carga de este mensaje representa. (NA, FREE, Currency, Unit)
string $channelPrefix: Prefijo del canal
array $unti: array(0=>array("UnitAmount"=>"value","UnitType"=>"Value"),N=>array("UnitAmount"=>"value","UnitType"=>"Value"))
string $currencyName: Especifica el nombre del currency. (10 caracteres)
string $currencyAmount: Especifica la cantidad unidad de carga como un entero positivo
string $currencyMultiplier: Especifica el multiplicador del Currency
string $totalType: Define que tipo de AOC-D total se representa
string $aocBillingId: Representa un identificador de facturacion asociado con un AOC-D o mensaje de AOC-E
string $chargingAssociationId: AssociationId
string $chargingAssociationNumber: AssociationNumber
string $chargingAssociationPlan: AssociationPlan

aTxfer (line 261)

Envia "ManagerAction_Atxfer"

Trasferencia Antendida

return: ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Atxfer

array aTxfer (string $channel, string $context, string $exten, stirng $priority)

string $channel: Canal
string $context: Contexto
string $exten: Extencion
stirng $priority: Prioridad de extentncion

bridge (line 273)

Envia "ManagerAction_Bridge"

Une dos canales

return: ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Bridge

array bridge (string $channel1, string $channel2, [string $tone = "no"])

string $channel1: primer canal
string $channel2: segundo canal
string $tone: "yes" para que suene un tono al canal 2 antes de unir (default: "no")

challenge (line 156)

Envia "ManagerAction_Challenge"

link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Challenge

void challenge ([string $authType = "MD5"])

string $authType: (default: MD5)

changeMonitor (line 1406)

Envia "ManagerAction_ChangeMonitor"

Cambia el archivo de un canal monitoriado

return: Ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_ChangeMonitor
access: public

array changeMonitor (string $channel, string $file)

string $channel: canal activo
string $file: archivo

closeSock (line 1917)

Cierra el Socket

access: private

void closeSock ()

command (line 177)

Envia "ManagerAction_Command"

Ejecuta un Comando CLI de Astersk

return: ver responceInfo()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Command

array command (string $command)

string $command: Comando CLI

coreSettings (line 798)

Envia "ManagerAction_CoreSettings"

return: Ver responceInfo()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_CoreSettings

array coreSettings ()

coreShowChannels (line 782)

Envia "ManagerAction_CoreShowChannels"

Lista todos los canales activos

return: Ver listEvent()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_CoreShowChannels
access: public

array coreShowChannels ()

coreStatus (line 790)

Envia "ManagerAction_CoreStatus"

return: Ver responceInfo()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_CoreStatus

array coreStatus ()

createConfig (line 610)

Envia "ManagerAction_CreateConfig"

Crea un Archivo de Configuracion

return: ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_CreateConfig

array createConfig (string $file)

string $file: nombre de archivo

dahdiDialOffhook (line 892)

Envia "ManagerAction_DAHDIDialOffhook"

Marca un numero si el canal DAHDI se encuentra descolgado

return: Ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_DAHDIDialOffhook
access: public

array dahdiDialOffhook (string $channel, string $number)

string $channel: canal DAHDI
string $number: Numero a marcar

dahdiDNDOff (line 870)

Envia "ManagerAction_DAHDIDNDoff"

Apaga el DND en un canal DAHDI

return: Ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_DAHDIDNDoff
access: public

array dahdiDNDOff (string $channel)

string $channel: canal DAHDI

dahdiDNDOn (line 859)

Envia "ManagerAction_DAHDIDNDon"

Enciende el DND en un canal DAHDI

return: Ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_DAHDIDNDon
access: public

array dahdiDNDOn (string $channel)

string $channel: canal DAHDI

dahdiHangup (line 903)

Envia "ManagerAction_DAHDIHangup"

cuelga un canal DAHDI

return: Ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_DAHDIHangup
access: public

array dahdiHangup (string $channel)

string $channel: canal DAHDI

dahdiRestart (line 880)

Envia "ManagerAction_DAHDIRestart"

Reinicia todos los canales DAHDI

return: Ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_DAHDIRestart
access: public

array dahdiRestart ()

dahdiShowChannels (line 843)

Envia "ManagerAction_DAHDIShowChannels"

obtiene el estado de canales DAHDI

return: Ver listEvent()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_DAHDIShowChannels
access: public

array dahdiShowChannels ([string $channel = null])

string $channel: canal DAHDI (default: todos)

dahdiTransfer (line 914)

Envia "ManagerAction_DAHDITransfe"

Transfiere un canal DAHDI

return: Ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_DAHDITransfer
access: public

array dahdiTransfer (string $channel)

string $channel: canal DAHDI

dataGet (line 1639)

Envia "ManagerAction_DataGet"

return: Lista el resultado del la consulta en un array
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_DataGet

array dataGet (string $path, [string $search = null], [ $filter = null], string $file)

string $path
string $search
string $file
$filter

dbDel (line 1306)

Envia "ManagerAction_DBDel"

return: ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_DBDel

array dbDel (string $family, array $key)

string $family
array $key

dbDelTree (line 1318)

Envia "ManagerAction_DBDelTree"

return: ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_DBDelTree

array dbDelTree (string $family, [array $key = null])

string $family
array $key

dbGet (line 1333)

Envia "ManagerAction_DBGet"

return: ver listEvent()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_DataGet

array dbGet (string $family, [string $key = ""], [string $path = ""])

string $family
string $key
string $path

dbPut (line 1291)

Envia "ManagerAction_DBPut"

return: ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_DBPut

array dbPut (string $family, array $key, [array $val = null])

string $family
array $key
array $val

events (line 187)

Envia "ManagerAction_Events"

Habilita o deshabilita el envio de eventos al cliente

return: ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Events

array events (string $eventMask)

string $eventMask: (on/off/system,call,log,...)

eventSimple (line 1782)

Obtiene respuesta de eventos

return: Respuesta de eventos Array ( [Response] => "Success" or "Error" [Message] => xxxxxxxxx )
access: private

array eventSimple (string $action, [ $arg = array()], [bool $wm = null], array $arguments)

string $action: ManagerAction
array $arguments: arra("RequiredHeader" => Value,"OptionalHeader" => Value)
bool $wm: without Message Algunas acciones des satisfactorio sin dar un mensaje
$arg

extensionState (line 520)

Envia "ManagerAction_ExtensionState"

Chequea estado de una extension

return: ver responceInfo()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_ExtensionState

array extensionState (string $exten, string $context)

string $context: Contexto de extension
string $exten: Extension

getConfig (line 576)

Envia "ManagerAction_GetConfig"

Obtiene un archivo de configuracion

return: Array ( [Response] => Success [list] => Array ( [category] => Array ( [Variable] => Value [Variable] => Value )
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_GetConfig

array getConfig (string $file, [string $category = null])

string $file: Archivo de configuracion (ver astersik.conf)
string $category: Caregoria (default: null)

getConfigJSON (line 678)

Envia "ManagerAction_GetConfigJSON"

Obtiene un archivo de configuracion en formato JSON

return: ver responceInfo()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_GetConfigJSON

array getConfigJSON (string $file)

string $file: Archivo de configuracion

getVar (line 301)

Envia "ManagerAction_Getvar"

Obtiene el valor de una variable Global o de canal

return: ver responceInfo()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Getvar

array getVar (string $var, [string $channel = null])

string $var: Nombre de la variable
string $channel: canal (Default: null)

hangup (line 316)

Envia "ManagerAction_Hangup"

Cuelga un canal

return: ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Hangup

array hangup (string $channel, [string $cause = null])

string $channel: canal
string $cause: Numeric hangup cause (Default: null)

iaxNetstats (line 944)

Envia "ManagerAction_IAXnetstats"

Obtiene lineas de netstat iax

return: Ver listEvent()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_IAXnetstats
access: public

array iaxNetstats ()

iaxPeerList (line 934)

Envia "ManagerAction_IAXpeerlist"

lista de IAX peer

return: Ver listEvent()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_IAXpeerlist
access: public

array iaxPeerList ()

iaxPeers (line 924)

Envia "ManagerAction_IAXpeers"

lista de IAX peer

return: Ver listEvent()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_IAXpeers
access: public

array iaxPeers ()

iaxRegistry (line 962)

Envia "ManagerAction_IAXregistry"

Ver los registros iax

return: Ver listEvent()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_IAXregistry
access: public

array iaxRegistry ()

jabberSend (line 391)

Envia "ManagerAction_JabberSend"

Envia un mensaje a cliente Jabber

return: ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_JabberSend

array jabberSend (string $jabber, string $jid, string $message)

string $jabber: Cliente o usuario Astersik cata conectar a JABBER
string $jid: - XMPP/Jabber JID (Name)
string $message: Mensaje

listCategories (line 698)

Envia "ManagerAction_ListCategories"

Lista las categorias en un archivo de configuracion

return: Array ( [Response] => Success [list] => Array ( [0] => general [1] => eltercera ) )
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_ListCategories
access: public

array listCategories (string $file)

string $file: Archivo

listCommands (line 541)

Envia "ManagerAction_ListCommands"

Lista de Comandos

return: Lista de Comanods Array ( [Response] => Success [list] => Array ( [0] => Array ( [command] => WaitEvent [des] => Wait for an event to occur. [priv] => <none> ) )
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_ExtensionState

array listCommands ()

listEvent (line 1693)

Obtiene respuesta de listas

return: Respuesta de Listas Array ( [Response] => "Success" or "Error"... [EventList] => start [Message] => ..... [list] => Array ( [ID] => Array ( [Event] => List... [Variable] => Value ... ) ) [listInfo] => Array ( [Event] => ...Complete [EventList] => Complete [ListItems] => XX .... ) )
access: private

array listEvent (string $action, string $keys, [bool $conp = false], [string $items = "ListItems"])

bool $conp: true compueba el numero de resultados obtenidos cuando $items es diferente a "ListItems"
string $items: Cadena de respuesta de numero de itens obtenidos ListItems-Items... (Default: ListItems)
string $action: array $action array("actions"=>"ManagerAction" ,"RequiredHeader" => Value,"OptionalHeader" => Value) or "ManagerAction"
string $keys: array $keys Valores para tomar como llaves array("Header","Header") or "Header"

Comienza la Conexion y envia "ManagerAction_Login"

return:
Autentificacion aceptada Array ( [0] => Asterisk Call Manager/1.1 [Response] => Success [Message] => Authentication accepted)
Autentificacion Fallida Array ( [0] => Asterisk Call Manager/1.1 [Response] => Error [Message] => Authentication failed )
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Login

array login ()

logoff (line 138)

Envia "ManagerAction_Logoff" y cierra el Socket

return: Array ( [Response] => Goodbye )
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Logoff

array logoff ()

mailboxCount (line 762)

Envia "ManagerAction_MailboxCount"

Chequea la cuenta de VM, Todos los mensajes

return: Ver responceInfo()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_MailboxCount

array mailboxCount (string $mailbox)

string $mailbox: usuario VM

mailboxStatus (line 772)

Envia "ManagerAction_MailboxStatus"

Chequea la cuenta de VM, mensajes en espera

return: Ver responceInfo()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_MailboxStatus

array mailboxStatus (string $mailbox)

string $mailbox: usuario VM

meetmeList (line 1435)

Envia "ManagerAction_MeetmeList"

Lista los participantes en una conferencia

return: Ver listEvent()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_MeetmeList
access: public

array meetmeList ([string $conference = null])

string $conference: Numero meetme (Default: todas las activas)

meetmeMute (line 1454)

Envia "ManagerAction_MeetmeMute"

Coloca el mute a un usuario dentro de una sala Meetme

return: Ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_MeetmeMute
access: public

array meetmeMute (string $conference, int $usernum)

string $conference: Numero meetme
int $usernum: Numero de usuario

meetmeUnmute (line 1468)

Envia "ManagerAction_MeetmeUnmute"

Quita el mute a un usuario dentro de una sala Meetme

return: Ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_MeetmeUnmute
access: public

array meetmeUnmute (string $conference, int $usernum)

string $conference: Numero meetme
int $usernum: Numero de usuario

mixMonitorMute (line 1419)

Envia "ManagerAction_MixMonitorMute"

Habilita o deshabilita el mute en canales motitoriados tipo mix

link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_MixMonitorMute
access: public

Ver mixMonitorMute (string $channel, int $state, [string $direction = null])

string $channel: canal activo
int $state: 1 on 0 off
string $direction: read, write o both (default: both)

moduleCheck (line 197)

Envia "ManagerAction_ModuleCheck"

Chequea si un modulo de asteris esta cargado

return: ver responceInfo() agreva vercion de revicion del modulo
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_ModuleCheck

array moduleCheck (string $mod)

string $mod: Modulo de astersik sin la extension

moduleLoad (line 216)

Envia "ManagerAction_ModuleLoad" Carga,descarga o recarga modulos de asterisk en el systema.

return: ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_ModuleLoad

array moduleLoad (string $loadType, [string $mod = null])

string $loadType: (load/unload/reload) Lo que se va a hacer en el modulo
string $mod: Modulo de astersik sin la extension (default: todos los modulos / all modules)

monitor (line 1351)

Envia "ManagerAction_Monitor"

Inicia el monitoreo de un canal

return: Ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Monitor
access: public

array monitor (string $channel, [string $format = null], [string $file = null], [string $mix = null])

string $channel: canal activo
string $format: formato para el archivo (gsm, ulaw...)
string $file: Nombre del archivo
string $mix: Si va a ser de tipo mix (true or false)

openSock (line 1905)

Abre el secket

return: true si abrio el socket false ocurrio un error
access: private

bool openSock ()

originate (line 241)

Envia "ManagerAction_Originate"

Origina una llamada

return: ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Originate

string $channel: Canal a llamar
string $exten: Extension a usar
string $context: Contexto de la extension
string $priority: Prioridad de la Extension (Default: 1)
string $callerid: Identificador de llamada (Default: null)
string $timeout: Tiempo de espera para que la llamada sea contestada (en ms) (default: Default timeout for astersik)
string $account: Codigo de cuenta (Default: null)
string $codecs: Separado por comas los codecs a utilizar para esta llamada
string $variable: Variables para el canal (Default: null)
string $aplication: Aplicacion a ejecutar (Default: null)
string $data: Datos requeridos para la aplicacion
string $async: Colocar true para una originacion rapida

park (line 737)

Envia "ManagerAction_park"

Estaciona un canal

return: Ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Park
access: public

array park (string $channel, string $channel2, string $parkinglot, [string $timeout = null])

string $channel: canal a estacionar
string $channel2: Canal de terorno si timeout expira
string $parkinglot: Numero de estacionamiento
string $timeout: Tiempo para retorno

parkedCalls (line 723)

Envia "ManagerAction_ParkedCalls"

Lista llamadas estacionadas

return: Ver listEvent()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_ParkedCalls
access: public

array parkedCalls ()

pauseMonitor (line 1372)

Envia "ManagerAction_UnpauseMonitor"

Pausa el monitoreo en un canal

return: Ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_PauseMonitor
access: public

array pauseMonitor (string $channel)

string $channel: canal activo

ping (line 148)

Envia "ManagerAction_Ping"

return: ver responceInfo()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Ping

array ping ()

playDTMF (line 331)

Envia "ManagerAction_PlayDTMF"

Reproduce un DTMF en un canal especifico

return: ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_PlayDTMF

array playDTMF (string $channel, string $digit)

string $channel: canal
string $digit: Digito DTMF

queueAdd (line 1134)

envia "ManagerAction_QueueAdd"

Agraga una interface a una cola

return: ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_QueueAdd

array queueAdd (string $queue, string $interface, [string $penalty = null], [string $paused = null], [string $memberName = null], [string $stateInterface = null])

string $queue: Cola
string $interface: Interface (SIP/testphone,DAHDI/1...)
string $penalty: Priorida del usuario o interface
string $paused: Si el usuario podra pausar
string $memberName: Nombre del miembro
string $stateInterface

queueLog (line 1244)

Envia "ManagerAction_QueueLog"

return: ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_QueueLog

array queueLog ( $queue, $event, [ $uniqueid = null], [ $interface = null], [ $message = null])

$queue
$event
$uniqueid
$interface
$message

queuePause (line 1202)

Envia "ManagerAction_QueuePause"

Pausa Una interface

return: ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_QueuePause

array queuePause (string $interface, string $paused, [string $queue = null], [string $reason = null])

string $interface: Interface (SIP/testphone,DAHDI/1...)
string $paused: (tuue or false)
string $queue: Cola
string $reason

queuePenalty (line 1221)

Envia "ManagerAction_QueuePenalty"

return: ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_QueuePenalty

array queuePenalty (string $interface, string $penalty, [string $queue = null])

string $interface: Interface (SIP/testphone,DAHDI/1...)
string $penalty: Prioridad de la interface
string $queue: Cola

queueReload (line 1173)

Envia "ManagerAction_QueueReload"

return: ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_QueueReload

array queueReload ([string $queue = null], [string $members = null], [string $rules = null], [string $parameters = null])

string $queue: Cola
string $members: (yes or no)
string $rules: (yes or no)
string $parameters: (yes or no)

queueRemove (line 1159)

envia "ManagerAction_QueueRemove"

Elimina una interface a una cola

return: ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_QueueRemove

array queueRemove (string $queue, string $interface)

string $queue: Cola
string $interface: Interface (SIP/testphone,DAHDI/1...)

queueReset (line 1114)

Envia "ManagerAction_QueueReset"

reinicia las estadisticas de las colas

return: Ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_QueueReset

array queueReset ([string $queue = null])

string $queue: cola (default: todos)

queueRule (line 1235)

Envia "ManagerAction_QueueRule"

return: ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_QueueRule

array queueRule (string $rule)

string $rule: Regla

queues (line 1007)

Envia "ManagerAction_Queues"

return: ( [0] => queue1 has 0 calls (max unlimited) in 'ringall' strategy (0s holdtime, 16s talktime), W:0, C:3, A:2, SL:33.3% within 0s [1] => Members: [2] => Agent/1001 (Unavailable) has taken 3 calls (last was 221365 secs ago) [3] => No Callers [4] => queue2 has 0 calls (max unlimited) in 'ringall' strategy (0s holdtime, 0s talktime), W:0, C:0, A:0, SL:0.0% within 0s [5] => Members: [6] => Agent/1001 (Unavailable) has taken no calls yet [7] => No Callers )
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Queues
access: public

Array queues ()

queueStatus (line 1054)

Envia "ManagerAction_Member"

Obtiene indormacion de colas y agentes

return: ( [Response] => Success [Message] => Queue status will follow [list] => Array ( [queue2] => Array ( [Event] => QueueParams [Queue] => queue2 ...... [mNumber] => 1 [members] => Array ( [Agent/1001] => Array ( [Event] => QueueMember [Queue] => queue2 ..... ) ) ) ) [nQueues] => 1 )
access: public

Array queueStatus ([string $queue = null], [string $member = null])

string $queue: cola (default: todos)
string $member: Miembro (default: todos)

queueSummary (line 1098)

Envia "ManagerAction_QueueSummary"

Sumari de colas

return: Ver listEvent()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_QueueSummary
access: public

array queueSummary ([string $queue = null])

string $queue: cola (default: todos)

read (line 1854)

Obtiene respuestas de servidor hasta una linea en definida

access: private

arry read (string $end)

string $end: texto de la ultima linea a leer

readEnd (line 1876)

Obtiene respuestas de servidor hasta una linea en blanco

access: private

array readEnd ([bool $sep = false])

bool $sep: true para no separar por ":"

redirect (line 350)

Envia "ManagerAction_Redirect"

Redirecciona una llamda

return: ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Redirect

string $channel: canal
string $context: Contexto de extension
string $exten: Extension
string $priority: Prioridad
string $extraChannel: canal extra (Default: null)
string $extraContext: Contexto de extension (Default: null)
string $extraExten: (Default: null)
string $extraPriority: (Default: null)

responceInfo (line 1813)

Obtiene respuesta de informacion

return: Respuesta de informacion Array ( [Response] => "Follows" or "Success" or "Error" [list] => Array ( [x] => Linea simpre de respuesta / Simpre line response ... [variable] => valor / Value ... ) )
access: private

array responceInfo (string $action, bool $wm, [array $arg = array()])

string $action: ManagerAction
bool $wm: without Message Algunas acciones dan satisfactorio sin dar un mensaje
array $arg: arra("RequiredHeader" => Value,"OptionalHeader" => Value)

send (line 1837)

Envia peticion al server

link: see
access: private

void send (string $action, [array $arguments = array()])

string $action: ManagerAction
array $arguments: arra("RequiredHeader" => Value,"OptionalHeader" => Value)

sendText (line 377)

Envia "ManagerAction_SendText"

Envia un mensaje de texto para el canal

return: ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_SendText

array sendText (string $channel, string $message)

string $channel: canal
string $message: Mensaje a enviar

setVar (line 285)

Envia "ManagerAction_SetVar"

Crea una variable Global o de canal

return: ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Setvar

array setVar (string $var, string $value, [string $channel = null])

string $var: Nombre de la variable .
string $value: Valor para la variable
string $channel: canal (Default: null)

showDialPlan (line 478)

Envia "ManagerAction_ShowDialPlan"

Lista Contextos, Extensiones, y prioridades

return: ver listEvent()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_ShowDialPlan

array showDialPlan ([string $context = null], [string $exten = null])

string $context: Contexto de extension (Default: null)
string $exten: Extension (Default: null)

sipPeers (line 808)

Envia "ManagerAction_SIPpeers"

Lista todos los Peer SIP

return: Ver listEvent()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_SIPpeers
access: public

array sipPeers ()

sipShowPeer (line 818)

Envia "ManagerAction_SIPshowpeer"

obtiene informacion sobre un peer sip

return: Ver responceInfo()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_SIPshowpeer

array sipShowPeer ($string $peer)

$string $peer: peerID

sipShowRegistry (line 828)

Envia "ManagerAction_SIPshowregistry"

Lista los registro SIP

return: Ver listEvent()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_SIPshowregistry
access: public

array sipShowRegistry ()

skinnyDevices (line 1480)

Envia "ManagerAction_SKINNYdevices"

Lista los Dispositivos SKINNY

return: Ver listEvent()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_SKINNYdevices
access: public

array skinnyDevices ()

skinnyLines (line 1527)

Envia "ManagerAction_SKINNYlines"

Lista las lineas SKINNY

return: Ver listEvent()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_SKINNYlines
access: public

array skinnyLines ()

skinnyShowDevice (line 1582)

Envia "ManagerAction_SKINNYshowdevice"

Obtiene informacion de un dispositivo SKINNY

return: ( [Channeltype] => SKINNY [ObjectName] => florian [ChannelObjectType] => device ......... ) En caso de error el arra estara Vacio
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_SKINNYshowdevice
access: public

Array skinnyShowDevice ( $device, strinf $divice)

strinf $divice: Id del Dispisitivo SKINNY
$device

skinnyShowLine (line 1614)

Envia "ManagerAction_SKINNYshowline"

Obtiene informacion de na linea SKINNY

return: ( [Channeltype] => SKINNY [ObjectName] => florian [ChannelObjectType] => line ......... ) En caso de error el arra estara Vacio
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_SKINNYshowline
access: public

Array skinnyShowLine (strinf $line)

strinf $line: Id de la linea SKINNY

status (line 501)

Envia "ManagerAction_Status"

Lista estados de canales

return: Ver listEvent()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Status

array status (string $channel, [string $variables = NULL])

string $channel: Canal
string $variables: Lista de Variables a incluir separadas por coma (Default: null)

stopMonitor (line 1394)

Envia "ManagerAction_StopMonitor"

Detiene el monitoreo en un canal

return: Ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_StopMonitor
access: public

array stopMonitor (string $channel)

string $channel: canal activo

unpauseMonitor (line 1383)

Envia "ManagerAction_UnpauseMonitor"

prosige el monitoreo en un canal

return: Ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_UnpauseMonitor
access: public

array unpauseMonitor (string $channel)

string $channel: canal activo

updateConfig (line 637)

Envia "ManagerAction_UpdateConfig"

Actualizar una configuracion

return: Ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_UpdateConfig

array updateConfig (string $src, string $dst, [array $actions = null], [string $reload = null])

string $src: Archivo a leer
string $dst: Archivo a escribir
array $actions
: array(
1. => array("action"=>"...","cat"=>"...","var"=>"...","value"=>"...","match"=>"...","line"=>"..."),
2. => array("action"=>"...","cat"=>"...","var"=>"...","value"=>"...","match"=>"...","line"=>"..."),
xxxxxx => array("action"=>"...","cat"=>"...","var"=>"...","value"=>"...","match"=>"...","line"=>"...") ); action: -NewCat -RenameCat -DelCat -EmptyCat -Update -Delete -Append -Insert
string $reload: Si recarga o no se puede colocar el numbre del modulo.

userEvent (line 1265)

Envia "ManagerAction_UserEvent"

return: ver eventSimple()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_UserEvent

array userEvent (string $userEvent, [array $headers = null])

string $userEvent: evento
array $headers: array("header1"="value","headerN"="value")

voicemailUsersList (line 752)

Envia "ManagerAction_VoicemailUsersList"

Lista todos los VM

return: Ver listEvent()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_VoicemailUsersList
access: public

array voicemailUsersList ()

waitEvent (line 1278)

Envia "ManagerAction_WaitEvent"

return: ver listEvent()
link: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_WaitEvent

array waitEvent (int $timeout)

int $timeout

Documentation generated on Wed, 29 Feb 2012 15:21:25 -0430 by phpDocumentor 1.4.3