AGI

De Asterisk Wiki
Saltar a: navegación, buscar

Asterisk Gateway Interface (AGI), o Interfaz Pasarela de Asterisk, es una interfaz del sistema Asterisk, que permite la comunicación con sistemas terceros, pero a diferencia de AMI, lo hace de forma directa, dado que ejecuta un script a voluntad, tan pronto la aplicación AGI sea invocada.

Funcionamiento

La interfaz AGI, fue diseñada originalmente, para servir de pasarela entre los distintos lenguajes de programación y Asterisk específicamente, los canales de comunicación especialmente.

El funcionamiento de AGI es relativamente sencillo:

  • Primero hay que establecer una pasarela, entre el canal en curso, y un script ejecutable a voluntad.
  • Cuando la conexión se establece, lanza una serie de variables al script ejecutado, que son accesibles desde el mismo. La mayoría de estas variables tienen algo que ver con el canal
  • El script puede ejecutar cualquier algoritmo, y entre sus secuencias, puede ejecutar comandos específicos de AGI para influenciar en el flujo de llamada en curso. Este script puede perdurar en ejecución incluso después de finalizar la llamada.

Pasarelas AGI

La pasarela AGI se establece directamente desde el Plan de Marcación, utilizando una de varias aplicaciones disponibles para efectuar esta gestión. Las disponibles actualmente son:

  • AGI: Sería la aplicación estándar. Ejecuta la aplicación en la misma máquina que asterisk, y se abre un flujo de entrada y salida clásico por la entrada y salida asociada correspondiente.
  • EAGI: Hace referencia a Enhanced AGI, es exactamente igual que AGI, pero además se incorpora a la entrada, el canal en curso, pero solo en modo "lectura".
  • Fast AGI: Se diferencia de AGI, dado que el proceso se establece a través de una conexión TCP/IP (el flujo de información), concretamente por el puerto 4573, y de esta forma es posible liberar el "peso" de la máquina Asterisk de forma bastante eficiente
  • Async AGI: Se establece una conexión con AMI, y el flujo se realizaría a través de dicha interfaz. Podría servir como una capa de abstracción de AMI dado que se considera de alguna forma un CTI y los problemas de estándares que acarrea.

Variables de Entrada

En el momento que se establece la conexión AGI con cualquiera de las Pasarelas, se lanzan todas las variables a la aplicación y estas son accesibles. Las variables tienen mucho que ver con el canal en curso, e incluso podemos mandar variables especificas de canal y otras posibilidades más concretas:

  • agi_request: Ese nombre de la aplicación externa AGI que va a ser ejectuada en caso de ser AGI/eAGI, para el caso de FastAGI, es la URL que ejecutara el proceso en la máquina remota
  • agi_channel: El nombre del canal que ha ejecutado AGI
  • agi_language: El idioma seleccionado en el canal que ejecuta AGI.
  • agi_type: El tipo de canal (SIP, IAX, etc)
  • agi_uniqueid: Identificador único para el canal
  • agi_version: Versión del sistema Asterisk en uso
  • agi_callerid: El identificador del llamante, de la llamada en curso
  • agi_dnid: El número marcado asociado al canal AGI
  • agi_rdnis: El número de redirección en caso que lo hubiera, asociado al canal, en otro caso pondría "unknown"
  • agi_context: El contexto donde se ejecuto la aplicación AGI
  • agi_extension: La extensión del contexto
  • agi_priority: La prioridad de la extensión
  • agi_enhanced: Indicación de si eAGI o AGI fue utilizado (1 significa que eAGI fue utilizado)
  • agi_accountcode: Código de cuenta en caso que utilicemos un sistema de billing
  • agi_threadid: El numero de proceso en el que Asterisk esta ejecutando la aplicación
  • agi_arg_<numero>: Considerando que numero puede ser cualquier numero natural, es la variable que almacena los argumentos que pasamos directamente desde la aplicación AGI, podría considerarse un método puro de entrada.

Procesamiento y Comandos

Una vez que la pasarela ha sido establecida, y los variables asignadas, llega el momento de aprovecharlo para lanzar los comandos a voluntad con la intención de interactuar desde fuera de nuestra máquina con nuestro sistema Asterisk.

Para ello existen una serie de comandos específicos que ejecutarán diversas funcionalidades del sistema como podemos ver algunos significativos a continuación [1] [2]:

  • ANSWER: Responde la llamada entrante
  • CHANNEL STATUS: Podemos sacar el estado de la llamada (contestada, llamando, o no responde)
  • DATABASE DEL/DELTRE/GET/PUT: Comandos basicos para editar valores en AstDB
  • EXEC: Ejecuta cualquiera aplicación como si estuviera en el Plan de Marcación
  • GET DATA: Recibe los tonos DTMF marcados por el llamante
  • NOOP: Igual que la Aplicación NoOp()
  • SAY ALPHA: Dice como audio una cadena de caracteres
  • RECORD: Tiene un funcionamiento similar a la aplicación Record() para grabar un sonido temporalmente.
  • SET VARIABLE: Podemos pasar una variable con contenido, a nuestro Plan de Marcación

Entornos de Programación

Logo PHP

Considerando que los comandos se pasan a Asterisk por la salida estándar e igual que ocurre con las variables que entran en nuestro script por la entrada, quiere decir que son escalables prácticamente a cualquier sistema o lenguaje de programación que pueda establecer esta comunicación con nuestro sistema UNIX.

Por tanto con la introducción de AGI, surgieron diferentes Interfaces de Programación de Aplicaciones (Application Programming Interface, API) para los lenguajes de programación más populares, y con esto se introdujo la posibilidad de convertir nuestros sistemas Asterisk en potentes IVRs de una forma relativamente sencilla.

La mayoría de las API para los diferentes lenguajes se basan en el paradigma de la Programación Orientada a Objetos con la intención de diseñar una clase llamada AGI, incorporando una serie de métodos especificos para tratar todos y cada uno de los comandos, e incluso, para recibir todas las variables de entrada.

PHP

Existe una variedad de API y Frameworks para PHP, los más destacados:

  • PHPAGI, es el más popular con diferencia, y simple de aplicar
  • AGISpeedy, es un servidor AGI, creado en PHP.

Instalando PHP-AGI

El metodo de instalación de PHP-AGI es muy sencillo, considerando que simplemente debemos meter la API en el directorio de AGI por defecto /var/lib/asterisk/agi-bin/:

# cd /usr/src


# wget http://sourceforge.net/projects/phpagi/files/latest/ -O phpagi.tgz


# tar –xvf phpagi.tgz


# mkdir /var/lib/asterisk/agi-bin/phpagi


# cp -r /usr/src/phpagi-<version_phpagi>/* /var/lib/asterisk/agi-bin/phpagi/


Perl

Tenemos componentes similares a los de otros lenguajes de programación como:

Python

También podemos encontrar una varidad de complementos:

  • StarPy, sirve tanto para interactuar con AMI como con FastAGI
  • Pyst, API Python para gestionar AGI

C

Para el lenguaje principal de Asterisk también existen extensiones:

  • cAGI, es un API específico para promover programas basados en AGI
  • QuIVR, hace referencia a QuickIVR para poder diseñar IVR basados en AGI, en lenguaje de programación C

Referencias

  1. Lista Comandos AGI Olle E. Johansson (2003)
  2. Comandos AGI Asteirsk 1.8 Leif Madsen, Jim Van Meggelen y Russell Bryant (2010)

Véase también

Enlaces Externos

  • PHP AGI, página oficial del proyecto PHP-AGI