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
void
__destruct
()
Envia "ManagerAction_AbsoluteTimeout"
Cuelga el canal despues de cierto tiempo
array
absoluteTimeout
(string $channel, int $timeOut)
-
string
$channel: Canal activo
-
int
$timeOut: Tiempo de espera en segundos
Envia "ManagerAction_AgentLogoff"
Hace logoff aun agente
array
agentLogoff
(string $agent, [string $soft = null])
-
string
$agent: ID del Agente
-
string
$soft: True para esperar que cuelge si extente una llamada
Envia "ManagerAction_Agents"
Lista a todos los agentes y su estado
array
agents
()
Envia "ManagerAction_AGI"
Envia Un comando AGI
array
agi
(string $channel, string $command, [string $commandID = null])
-
string
$channel: Canal
-
string
$command: Comando agi
-
string
$commandID
Envia "ManagerAction_AOCMessage"
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])
-
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
Envia "ManagerAction_Atxfer"
Trasferencia Antendida
array
aTxfer
(string $channel, string $context, string $exten, stirng $priority)
-
string
$channel: Canal
-
string
$context: Contexto
-
string
$exten: Extencion
-
stirng
$priority: Prioridad de extentncion
Envia "ManagerAction_Bridge"
Une dos canales
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")
Envia "ManagerAction_Challenge"
void
challenge
([string $authType = "MD5"])
-
string
$authType: (default: MD5)
Envia "ManagerAction_ChangeMonitor"
Cambia el archivo de un canal monitoriado
array
changeMonitor
(string $channel, string $file)
-
string
$channel: canal activo
-
string
$file: archivo
Cierra el Socket
void
closeSock
()
Envia "ManagerAction_Command"
Ejecuta un Comando CLI de Astersk
array
command
(string $command)
-
string
$command: Comando CLI
Envia "ManagerAction_CoreSettings"
array
coreSettings
()
Envia "ManagerAction_CoreShowChannels"
Lista todos los canales activos
array
coreShowChannels
()
Envia "ManagerAction_CoreStatus"
array
coreStatus
()
Envia "ManagerAction_CreateConfig"
Crea un Archivo de Configuracion
array
createConfig
(string $file)
-
string
$file: nombre de archivo
Envia "ManagerAction_DAHDIDialOffhook"
Marca un numero si el canal DAHDI se encuentra descolgado
array
dahdiDialOffhook
(string $channel, string $number)
-
string
$channel: canal DAHDI
-
string
$number: Numero a marcar
Envia "ManagerAction_DAHDIDNDoff"
Apaga el DND en un canal DAHDI
array
dahdiDNDOff
(string $channel)
-
string
$channel: canal DAHDI
Envia "ManagerAction_DAHDIDNDon"
Enciende el DND en un canal DAHDI
array
dahdiDNDOn
(string $channel)
-
string
$channel: canal DAHDI
Envia "ManagerAction_DAHDIHangup"
cuelga un canal DAHDI
array
dahdiHangup
(string $channel)
-
string
$channel: canal DAHDI
Envia "ManagerAction_DAHDIRestart"
Reinicia todos los canales DAHDI
array
dahdiRestart
()
Envia "ManagerAction_DAHDIShowChannels"
obtiene el estado de canales DAHDI
array
dahdiShowChannels
([string $channel = null])
-
string
$channel: canal DAHDI (default: todos)
Envia "ManagerAction_DAHDITransfe"
Transfiere un canal DAHDI
array
dahdiTransfer
(string $channel)
-
string
$channel: canal DAHDI
Envia "ManagerAction_DataGet"
array
dataGet
(string $path, [string $search = null], [ $filter = null], string $file)
-
string
$path
-
string
$search
-
string
$file
-
$filter
Envia "ManagerAction_DBDel"
array
dbDel
(string $family, array $key)
-
string
$family
-
array
$key
Envia "ManagerAction_DBDelTree"
array
dbDelTree
(string $family, [array $key = null])
-
string
$family
-
array
$key
Envia "ManagerAction_DBGet"
array
dbGet
(string $family, [string $key = ""], [string $path = ""])
-
string
$family
-
string
$key
-
string
$path
Envia "ManagerAction_DBPut"
array
dbPut
(string $family, array $key, [array $val = null])
-
string
$family
-
array
$key
-
array
$val
Envia "ManagerAction_Events"
Habilita o deshabilita el envio de eventos al cliente
array
events
(string $eventMask)
-
string
$eventMask: (on/off/system,call,log,...)
Obtiene respuesta de eventos
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
Envia "ManagerAction_ExtensionState"
Chequea estado de una extension
array
extensionState
(string $exten, string $context)
-
string
$context: Contexto de extension
-
string
$exten: Extension
Envia "ManagerAction_GetConfig"
Obtiene un archivo de configuracion
array
getConfig
(string $file, [string $category = null])
-
string
$file: Archivo de configuracion (ver astersik.conf)
-
string
$category: Caregoria (default: null)
Envia "ManagerAction_GetConfigJSON"
Obtiene un archivo de configuracion en formato JSON
array
getConfigJSON
(string $file)
-
string
$file: Archivo de configuracion
Envia "ManagerAction_Getvar"
Obtiene el valor de una variable Global o de canal
array
getVar
(string $var, [string $channel = null])
-
string
$var: Nombre de la variable
-
string
$channel: canal (Default: null)
Envia "ManagerAction_Hangup"
Cuelga un canal
array
hangup
(string $channel, [string $cause = null])
-
string
$channel: canal
-
string
$cause: Numeric hangup cause (Default: null)
Envia "ManagerAction_IAXnetstats"
Obtiene lineas de netstat iax
array
iaxNetstats
()
Envia "ManagerAction_IAXpeerlist"
lista de IAX peer
array
iaxPeerList
()
Envia "ManagerAction_IAXpeers"
lista de IAX peer
array
iaxPeers
()
Envia "ManagerAction_IAXregistry"
Ver los registros iax
array
iaxRegistry
()
Envia "ManagerAction_JabberSend"
Envia un mensaje a cliente Jabber
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
Envia "ManagerAction_ListCategories"
Lista las categorias en un archivo de configuracion
array
listCategories
(string $file)
Envia "ManagerAction_ListCommands"
Lista de Comandos
array
listCommands
()
Obtiene respuesta de listas
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"
array
login
()
Envia "ManagerAction_Logoff" y cierra el Socket
array
logoff
()
Envia "ManagerAction_MailboxCount"
Chequea la cuenta de VM, Todos los mensajes
array
mailboxCount
(string $mailbox)
-
string
$mailbox: usuario VM
Envia "ManagerAction_MailboxStatus"
Chequea la cuenta de VM, mensajes en espera
array
mailboxStatus
(string $mailbox)
-
string
$mailbox: usuario VM
Envia "ManagerAction_MeetmeList"
Lista los participantes en una conferencia
array
meetmeList
([string $conference = null])
-
string
$conference: Numero meetme (Default: todas las activas)
Envia "ManagerAction_MeetmeMute"
Coloca el mute a un usuario dentro de una sala Meetme
array
meetmeMute
(string $conference, int $usernum)
-
string
$conference: Numero meetme
-
int
$usernum: Numero de usuario
Envia "ManagerAction_MeetmeUnmute"
Quita el mute a un usuario dentro de una sala Meetme
array
meetmeUnmute
(string $conference, int $usernum)
-
string
$conference: Numero meetme
-
int
$usernum: Numero de usuario
Envia "ManagerAction_MixMonitorMute"
Habilita o deshabilita el mute en canales motitoriados tipo mix
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)
Envia "ManagerAction_ModuleCheck"
Chequea si un modulo de asteris esta cargado
array
moduleCheck
(string $mod)
-
string
$mod: Modulo de astersik sin la extension
Envia "ManagerAction_ModuleLoad" Carga,descarga o recarga modulos de asterisk en el systema.
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)
Envia "ManagerAction_Monitor"
Inicia el monitoreo de un canal
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)
Abre el secket
bool
openSock
()
Envia "ManagerAction_Originate"
Origina una llamada
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])
-
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
Envia "ManagerAction_park"
Estaciona un canal
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
Envia "ManagerAction_ParkedCalls"
Lista llamadas estacionadas
array
parkedCalls
()
Envia "ManagerAction_UnpauseMonitor"
Pausa el monitoreo en un canal
array
pauseMonitor
(string $channel)
-
string
$channel: canal activo
Envia "ManagerAction_Ping"
array
ping
()
Envia "ManagerAction_PlayDTMF"
Reproduce un DTMF en un canal especifico
array
playDTMF
(string $channel, string $digit)
-
string
$channel: canal
-
string
$digit: Digito DTMF
envia "ManagerAction_QueueAdd"
Agraga una interface a una cola
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
Envia "ManagerAction_QueueLog"
array
queueLog
( $queue, $event, [ $uniqueid = null], [ $interface = null], [ $message = null])
-
$queue
-
$event
-
$uniqueid
-
$interface
-
$message
Envia "ManagerAction_QueuePause"
Pausa Una interface
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
Envia "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
Envia "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)
envia "ManagerAction_QueueRemove"
Elimina una interface a una cola
array
queueRemove
(string $queue, string $interface)
-
string
$queue: Cola
-
string
$interface: Interface (SIP/testphone,DAHDI/1...)
Envia "ManagerAction_QueueReset"
reinicia las estadisticas de las colas
array
queueReset
([string $queue = null])
-
string
$queue: cola (default: todos)
Envia "ManagerAction_QueueRule"
array
queueRule
(string $rule)
Envia "ManagerAction_Queues"
Array
queues
()
Envia "ManagerAction_Member"
Obtiene indormacion de colas y agentes
Array
queueStatus
([string $queue = null], [string $member = null])
-
string
$queue: cola (default: todos)
-
string
$member: Miembro (default: todos)
Envia "ManagerAction_QueueSummary"
Sumari de colas
array
queueSummary
([string $queue = null])
-
string
$queue: cola (default: todos)
Obtiene respuestas de servidor hasta una linea en definida
arry
read
(string $end)
-
string
$end: texto de la ultima linea a leer
Obtiene respuestas de servidor hasta una linea en blanco
array
readEnd
([bool $sep = false])
-
bool
$sep: true para no separar por ":"
Envia "ManagerAction_Redirect"
Redirecciona una llamda
array
redirect
(string $channel, string $context, string $exten, string $priority, [string $extraChannel = null], [string $extraContext = null], [string $extraExten = null], [string $extraPriority = null])
-
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)
Obtiene respuesta de informacion
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)
Envia peticion al server
void
send
(string $action, [array $arguments = array()])
-
string
$action: ManagerAction
-
array
$arguments: arra("RequiredHeader" => Value,"OptionalHeader" => Value)
Envia "ManagerAction_SendText"
Envia un mensaje de texto para el canal
array
sendText
(string $channel, string $message)
-
string
$channel: canal
-
string
$message: Mensaje a enviar
Envia "ManagerAction_SetVar"
Crea una variable Global o de canal
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)
Envia "ManagerAction_ShowDialPlan"
Lista Contextos, Extensiones, y prioridades
array
showDialPlan
([string $context = null], [string $exten = null])
-
string
$context: Contexto de extension (Default: null)
-
string
$exten: Extension (Default: null)
Envia "ManagerAction_SIPpeers"
Lista todos los Peer SIP
array
sipPeers
()
Envia "ManagerAction_SIPshowpeer"
obtiene informacion sobre un peer sip
array
sipShowPeer
($string $peer)
Envia "ManagerAction_SIPshowregistry"
Lista los registro SIP
array
sipShowRegistry
()
Envia "ManagerAction_SKINNYdevices"
Lista los Dispositivos SKINNY
array
skinnyDevices
()
Envia "ManagerAction_SKINNYlines"
Lista las lineas SKINNY
array
skinnyLines
()
Envia "ManagerAction_SKINNYshowdevice"
Obtiene informacion de un dispositivo SKINNY
Array
skinnyShowDevice
( $device, strinf $divice)
-
strinf
$divice: Id del Dispisitivo SKINNY
-
$device
Envia "ManagerAction_SKINNYshowline"
Obtiene informacion de na linea SKINNY
Array
skinnyShowLine
(strinf $line)
-
strinf
$line: Id de la linea SKINNY
Envia "ManagerAction_Status"
Lista estados de canales
array
status
(string $channel, [string $variables = NULL])
-
string
$channel: Canal
-
string
$variables: Lista de Variables a incluir separadas por coma (Default: null)
Envia "ManagerAction_StopMonitor"
Detiene el monitoreo en un canal
array
stopMonitor
(string $channel)
-
string
$channel: canal activo
Envia "ManagerAction_UnpauseMonitor"
prosige el monitoreo en un canal
array
unpauseMonitor
(string $channel)
-
string
$channel: canal activo
Envia "ManagerAction_UpdateConfig"
Actualizar una configuracion
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(
- => array("action"=>"...","cat"=>"...","var"=>"...","value"=>"...","match"=>"...","line"=>"..."),
- => 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.
Envia "ManagerAction_UserEvent"
array
userEvent
(string $userEvent, [array $headers = null])
-
string
$userEvent: evento
-
array
$headers: array("header1"="value","headerN"="value")
Envia "ManagerAction_VoicemailUsersList"
Lista todos los VM
array
voicemailUsersList
()
Envia "ManagerAction_WaitEvent"
array
waitEvent
(int $timeout)