Kit de desarrollo de software IVM

Esta es la página del kit de desarrollo de software (SDK) de IVM, el contestador telefónico automático. Debería ser usado por programadores quienes desean escribir sus propios complementos o usar el API de IVM.

Este tema del SDK es de carácter avanzado. Para crear los sistemas IVR más comunes, no debería necesitar de ningún tipo de programación. Siga las instrucciones en el manual de IVM, compare los ejemplos de IVR y, de ser necesario, use uno de los complementos listos.

Antes de intentar la escritura de un código, debería familiarizarse con:

• El contestador telefónico IVM (presione en descargar).
• El manual de IVM (seleccionar los contenidos de ayuda desde el menú ayuda.
• Archivos para instalación de IVR de ejemplo
• Complementos IVM estándar

Temas del kit de desarrollo de software IVM

• Escribir complementos IVM
  • Ejemplos usando C++
  • Ejemplos usando Perl
  • Ejemplos usando Visual Basic
  • Ejemplos usando PHP
  • Ejemplos usando Java
• Depuración de complementos
• Servicios de desarrollo de complementos
• Usar el API de IVM
  • Ejecutar IVM
  • Envío de comandos a IVM
  • Comandos IVMAPI
  • Cambiar configuraciones de IVM
  • Añadiendo otras funciones al API de IVM
• Opciones de la línea de comandos
• Otra información (asistencia y distribución)

Acerca de los complementos

Una cantidad de complementos útiles que han sido creados por nuestros programados están disponibles para ser descargados gratis en www.nch.com.au/ivm/es/plugins.html. Para más información sobre el uso de los complementos, por favor consulte el manual de ayuda de IVM usando la página de complementos (ayuda->contenidos de ayuda).

Escribir complementos IVM

Esta documentación está dirigida a los programadores que deseen desarrollas sus propios complementos para IVM.

Los complementos pueden ser escritos en cualquier lenguaje que pueda hacer un ejecutable de línea de comandos en consola de 32 bits para Windows. Los ejemplos de abajo están escritos en C++ y Perl pero Dephi, VB y otra cantidad de lenguajes son adecuados.

Un complemento es un ejecutable de línea de comandos en modo de consola. Se ejecuta como una canal anónimo por IVM cuando se abre un mensaje saliente.

Las variables de llamada se pasan a los complementos como argumentos de línea de comandos. Por ejemplo, si crea un complemento llamado "plugin.exe" puede establecer que IVM abra "plugin.exe %linenumber% %cid% %variable1% %variable2%".

Cuando se ejecuta un exe como un complemento, IVM espera que el complemento vuelva (salir). El ejecutable del complemento debería volver cuando el mensaje saliente haya terminado de reproducirse. Si se deben de realizar más tareas que requieran más tiempo, su complemento debe crear/ejecutar otro proceso y salir.

El valor devuelto puede ser cualquier número de variables que son enviadas ("printed") por el complemento a STDOUT en pares de datos de nombre en el formato usado por HTTP. Por ejemplo, "numbervariable=101&textvariable=Space+as+plus". Para más información, consulte los libros sobre secuencia de comandos cgi. Generalmente, el valor devuelto más útil es el nombre del mensaje saliente que debería reproducirse a continuación. Esta variable puede ser usada como el nombre del "ir a MS..."

Ejemplos usando C++

El complemento tiene dos argumentos opcionales. El primero determina el rango de los valores devueltos. El valor predeterminado es 10 que ofrece los resultados posibles de 0 a 9. El segundo es el nombre de la variable devuelta (predeterminado "rand").

#include <stdlib.h>
#include <iostream>

int main(int argc, char *argv[], char *[])
{
 cout << ((argc > 2) ? argv[2] : "rand");
 cout << "=";
 int RandomModulus = (argc > 1) ? atoi(argv[1]) : 10;
 randomize();
 cout << rand() % RandomModulus;
}

  Volver al principio

Ejemplos usando Perl

print @ARGV > 1 ? $ARGV[1] : "rand";
print  "=";
$RandomModulus = (@ARGV > 0) ? int($ARGV[0]) : 10;
print (int(rand($RandomModulus)));

  Volver al principio

Ejemplos usando Visual Basic

Public Sub Main()
   Dim StdIO As clsStdIO
   Set StdIO = New clsStdIO
   StdIO.StdOut "rand=" & GetRandomNumber
End Sub

  Volver al principio

Ejemplos usando PHP

Para comenzar, se puede usar una secuencia de comandos PHP simple como el siguiente:

<?php

if (argv[1] == 1234)

{

 print NextOGM=CorrectPIN ;

}

else

{

 print NextOGM=IncorrectPIN ;

}


?>

Luego establezca Argumento 3 a %PIN% por ejemplo (habiendo recolectado el PIN en esta variable en un mensaje saliente anterior) y establezca la opción para ir a MS& a %NextOGM%.

  Volver al principio

Ejemplos usando Java

public class RandNumGen {
  public static void main(String[] args) {
   Calendar cal = Calendar.getInstance(java.util.TimeZone.getDefault());
   Random rand = new Random();
   rand.setSeed(cal.getTimeInMillis());    
   int numberOfOptions = Integer.parseInt(args[0])+1;
   System.out.print("rand=" + rand.nextInt(numberOfOptions));
 }
}

  Volver al principio

Depuración de complementos

• Ejecute el complemento desde la línea de comandos y verifique que devuelve los datos como se necesitan.
• Después de una llamada fallida con el simulador de prueba de llamadas, ver el registro de las llamadas más recientes desde IVM. Todos los datos enviados y devueltos desde el complemento se registran en el registro de las llamadas más recientes.

  Volver al principio

Servicios de desarrollo de complementos

  Volver al principio

Usar el API de IVM

Necesita IVM versión 2,30 o superior para usar esta API. Todos los ejemplos y demostraciones que se mostraron anteriormente son mostradas en C++ pero esperamos que no tenga dificultades implementando las mismas funciones usando otros lenguajes (por ejemplo Visual Basic). Los procedimientos a continuación usan un número de funciones API de Windows (ej. FindWindowEx, SendMessage etc.). Si necesita saber más acerca de estas funciones y cómo usarlas, consulte la documentación de API de Microsoft Windows.

Ejecutar IVM

Sin embargo, si por alguna razón necesita abrirlo desde su programa use WinExec, ShellExecute o CreateProcess para abrir:
  "C:\Program Files\NCH Swift Sound\IVM\ivm.exe"
Si desea que se ejecute en la bandeja de la bara de tareas añada el argumento /inicio de sesión así:
  "C:\Program Files\NCH Swift Sound\IVM\ivm.exe"
Si su programa no abre IVM, necesita esperar que cree su ventana antes que FindWindow tenga éxito (ver abajo).

  Volver al principio

Envío de comandos a IVM

#define IVMAPI_WINDOWCAPTION "IVM Answering Attendant"

#define WM_IVMAPI_COMMAND 0x7fff

int IVMAPISendCommand(int iIVMCommand, LPARAM ExtraData)
{
  HWND hwndIVM = FindWindowEx(NULL, NULL, NULL, IVMAPI_WINDOWCAPTION);
  if (hwndIVM == NULL) {
    // IVM not running.
    // Either attempt to run IVM 
    // or spit out error message here...
    return 0;
  }
  return SendMessage(hwndIVM, WM_IVMAPI_COMMAND, iIVMCommand, ExtraData);
}

La mayoría de los comandos no usan parámetos ExtraData, así que también podemos definir:

inline int IVMAPISendCommandSimple(int iIVMCommand) 
             { return IVMAPISendCommand(iIVMCommand, 0); }

Si el comando requiere de una cadena, debe usar un objeto Windows ATOM para pasar la cadena como se muestra en el siguiente código. Es importante resaltar que su código debe eliminar el ATOM usando GlobalDeleteAtom después que SendMessage vuelve.

int IVMAPISendCommandString(int iIVMCommand, const char* szStringToSend)
{
  ATOM atomExtraInfo = GlobalAddAtom(szStringToSend);
  int iReturnValue = IVMAPISendCommand(iIVMCommand, (LPARAM)atomExtraInfo);
  GlobalDeleteAtom(atomExtraInfo);
  return iReturnValue;
}

  Volver al principio

Comandos IVMAPI

inline int IVMAPIGetVersion() { return IVMAPISendCommandSimple(0); }
// Returns the current API version which is currently 1.
// If 0 is returned the IVM or API is not available.
// If 2 or above is returned please contact us for updated documentation.

inline void IVMAPITurnOn() { IVMAPISendCommandSimple(1); }
// Turns IVM On (so it answers calls).

inline void IVMAPITurnOff() { IVMAPISendCommandSimple(2); }
// Turns IVM Of (so it will not answer calls).

inline void IVMAPISelectAnswerOGM(const char* szOGMName) 
                { IVMAPISendCommandString(3, szOGMName); }
// Selects the current default answer OGM.

inline void IVMAPIAddOutboundNumber(const char* szNumber) 
                 { IVMAPISendCommandString(4, szNumber); }
// Adds another number to call in the outbound calls list.
// szNumber can include the number to call
// and extra variables for use during the call.
//    eg. 5551234567&msgid=666&customer=999
inline void IVMAPISetGlobalVariable(const char* szVariables) 
                 { IVMAPISendCommandString(5, szVariables); }
// Sets IVM Global variables. The variables are http encoded in the format
// variable=value&variable2=value2&variable3=value3 
//    eg. site=mainnch&SystemPromptsFolder=c:\defaultIVM

  Volver al principio

Cambiar configuraciones de IVM

  Volver al principio

Añadiendo otras funciones al API de IVM

  Volver al principio

Opciones de la línea de comandos

Las opciones de la línea de comandos son usadas para controlar la ejecución de IVM desde un archivo por lotes u otra aplicación. Son admitidas las siguientes opciones:

-on
enciende IVM para que comience a responder llamadas.

-off
detiene IVM para que no responda llamadas.

-ogm ogmname
establece el mensajes saliente llamado ogmname como el MS predeterminado.

-outbound nnnnnnnn
añade el número de teléfono nnnnnnn a la lista de las llamadas de salientes y comienza a marcar la lista de llamadas salientes. Tenga en cuenta que tal vez necesite colocar el número de teléfono entre comillas dobles si contiene espacios o caracteres especiales, por ejemplo -outbound "(01) 555 1234567"

-ogmoutboundanswer ogmname
establece el MS que será usado si una llamada saliente es contestada por una persona.

-ogmoutboundmachine ogmname
establece el MS que será usado si una llamada saliente es contestada por un contestador automático.

-outboundlist filename
reemplaza la lista de números telefónicos de las llamadas salientes con la lista en el nombre del archivo y comienza a marcar la lista. La lista debería estar en el formato
numerotelefono1;numerotelefono2;numerotelefono3;numerotelefono4
ejemplo: 5551234567;5559876543;5551111111;5552222222;5553333333;(01) 55554444444;(02)5557777777

filename
carga el nombre especificado como un archivo IVR.

-set variables
establece variables globales para su uso en los MS. La cadena si las variables están codificadas http y en el formato
variable=valor&variable2=valor2&variable3=valor3
Por favor tenga en cuenta que si usa & para combinar variables debe encerrar la cadena entre comillas.
ejemplo: -set “site=mainnch&SystemPromptsFolder=c:\defaultIVM”

Ejemplos:

IVM.exe -ogm OGM1 -on
iniciará IVM como el OGM1 (mensaje saliente 1) y empezará a responder inmediatamente.

IVM.exe -outbound 5551234567
añadirá el número de teléfono 5551234567 a la lista de números salientes y comenzará a marcar.

IVM.exe phonesystem.ivr -on
cargará el archivo de IVR phonesystem.ivr y comenzará a responder llamadas usando el mensaje saliente predeterminado.

  Volver al principio

Otra información

Ahora contamos con una lista de expertos en IVM en la nueva conexión con expertos de IVM www.nch.com.au/ivm/es/experts.html. Estos son profesionales de la informática quienes conocen cómo programar IVM y pueden ser consultados para que lo ayuden a configurar el sistema IVM complejo. Igualmente puede solicitar que sea añadido a la lista si es uno de esos profesionales.

También ofrecemos servicios de desarrollo de software corporativo, si desea que lo hagamos o si necesita cambios más sustanciales en IVM. Los precios van desde $100 dólares estadounidenses por una función simple pero se pueden incrementar hasta los $10,000 o más por el desarrollo de una nueva versión completa de la aplicación. Solicite un presupuesto desde www.nch.com.au/development/es.

También podemos personalizar y posicionar su marca en IVM con su logotipo e información por un pequeño cargo adicional (visite http://www.nch.com.au/reseller/es por más información).

Puede distribuir el archivo de instalación de IVM con su software (pero no puede, bajo ninguna circunstancia, distribuir las claves de registro o socavar y perjudicar el sistema de registro. Consulte las condiciones de licencia de IVM (en el archivo de ayuda). Generalmente sus clientes comprarían IVM directamente a través de nosotros. Igualmente, proporcionamos fáciles condiciones de licencia si necesita distribuir versiones registradas de IVM. Por favor visite http://www.nch.com.au/reseller/es bajo el título de licencia de software.

  Volver al principio