CTIBridgeClient V1.0 DOCUMENTACION DEL

CTIBridgeClient V1.0
DOCUMENTACION DEL PROGRAMADOR
DATAVOICE S.A
Para preguntas relativas a esta documentación :
Dpto. Ingeniería de DATAVOICE S.A.
Tlfno :
+34 91 361 40 16
Fax
:
+34 91 725 43 97
Está prohibida la copia, divulgación, reproducción total o parcial
de este documento tanto en su versión impresa como en soporte
informático sin el permiso expreso de DATAVOICE S.A
Introducción
CTIBridgeClient es un control ActiveX que permite a las aplicaciones desarrolladas en
entornos que soportan este tipo de objetos, recibir notificaciones de eventos telefónicos,
enviados por el control CTIBridgeServer, incorporado en el PhoneScreen de DataVoice.
Distribución del Software
La versión actual de CTIBridgeClient necesita tener conexión TCP con la parte
servidora CTIBridgeServer. Tanto la parte cliente, como la parte servidora deberán estar en la
misma máquina.
Se deberá copiar CTICLI.OCX en el directorio de sistema de Windows.
Con el archivo copiado en el directorio del sistema, deberemos registrar el OCX con el
programa REGSVR32. La línea de comandos a introducir sería la siguiente:
REGSVR32 CTICLI.OCX
Con esto el OCX queda listo para funcionar.
CTIBridgeClient V1.0
Documentación del programador
1
CTIBridgeClient
Métodos del objeto CTIBridgeClient
•
Initialize
•
LoadPort
•
NotifyDial
•
NotifyDialer
•
NotifyHangup
•
NotifyPickup
•
SavePort
CTIBridgeClient V1.0
Documentación del programador
2
Initialize
Inicializa el control. Prepara las comunicaciones con el servidor. Antes de llamar a
cualquier otro método del control, debe haberse producido una llamada exitosa a este método.
Formato
<objeto>.Initialize
Donde <objeto> es una referencia a un CTIBridgeClient.
Valor de retorno
Long
Si el método tiene éxito devolverá 0, si no devolverá un código de error del API de
Windows.
Ejemplo
Sub Form_Load()
Dim lRetVal as Long
lRetVal = CTIBridgeClient1.Initialize()
If lRetVal <> 0 Then
MsgBox “Error:“ & Str$(lRetVal)
End If
End Sub
CTIBridgeClient V1.0
Documentación del programador
3
LoadPort
Carga de la Registry el puerto IP donde debe conectarse para hablarse con el
servidor.
Formato
<objeto>.LoadPort
Donde <objeto> es una referencia a un CTIBridgeClient.
Valor de retorno
Integer
En caso de no producirse errores devolverá el nº de puerto almacenado
anteriormente en la Registry de Windows. En caso que no lo pueda cargar,
devolverá –1.
Ejemplo
Sub Configure_Click()
Dim nPort as integer
Dim strValue as string
nPort = CTIBridgeClient.LoadPort
If nPort = -1 Then
strValue = InputBox(“Introduzca puerto”)
If strValue <> “” then
nPort = val(strValue)
CTIBrigeClient.SavePort nPort
End If
End If
End Sub
CTIBridgeClient V1.0
Documentación del programador
4
NotifyDial
Indica al servidor que marque un número, con una información opcional asociada.
Formato
<objeto>.NotifyDial Número, Información
Donde <objeto> es una referencia a un CTIBridgeClient.
Número es el nº de teléfono a marcar.
Información es la información opcional asociada al nº de teléfono, este parámetro
deberá pasarse vacío (“”) cuando no se quiera información asociada.
Valor de retorno
Long
Si el método tiene éxito devolverá 0, si no, un código de error del API de Windows.
Ejemplo
Sub LLamar_Click()
If CTIBridgeClient1.NotifyDial(Phone1.Text, “”) <> 0 Then
MsgBox "No se ha podido notificar la llamada"
End If
End Sub
CTIBridgeClient V1.0
Documentación del programador
5
NotifyDialer
Manda un mensaje al marcador.
Formato
<objeto>.NotifyDialer Campaña, Mensaje
Donde <objeto> es una referencia a un CTIBridgeClient.
Campaña es el nombre de la campaña a la que va dirigida el mensaje.
Mensaje es el mensaje que se quiere enviar a la campaña.
Valor de retorno
Long
Si el método tiene éxito devolverá 0, si no, un código de error del API de Windows.
Ejemplo
Sub Login_Click()
If CTIBridgeClient1.NotifyDialer(“Actualizacion de nombres,
“Login puesto 388”) <> 0 Then
MsgBox "No se ha podido notificar al marcador"
End If
End Sub
CTIBridgeClient V1.0
Documentación del programador
6
NotifyHangup
Este método notifica al servidor que cuelge la llamada que tenga activa.
Formato
<objeto>.Hangup
Donde <objeto> es una referencia a un CTIBrigdeClient.
Valor de retorno
Long.
Si el método tiene éxito devolverá 0, si no, un código de error del API de Windows.
Ejemplo
Sub Colgar_Click()
Dim lRetVal as Long
lRetVal = CTIBridgeClient1.NotifyHangup()
If lRetVal = 0 Then
Display1.Text = “Libre”
Else
Display1.Text = “Error” & Str$(lRetVal) & “al colgar”
End If
End Sub
CTIBridgeClient V1.0
Documentación del programador
7
NotifyPickup
Notifica al servidor que descuelgue la llamada.
Formato
<objeto>.NotifyPickup
Donde <objeto> es una referencia a un CTIBridgeClient.
Valor de retorno
Long
Si el método tiene éxito devuelve 0, si no, devolverá un código de error del API de
Windows.
Ejemplo
Sub Pickup_Click()
Dim lRetVal as Long
lRetVal = CTIBridgeClient1.NotifyPickup()
If lRetVal = 0 Then
Display.Text = “Llamada en curso”
Else
Display.Text = “No se puede descolgar la llamada”
End If
End Sub
CTIBridgeClient V1.0
Documentación del programador
8
SavePort
Guarda el puerto pasado en la Registry de Windows.
Formato
<objeto>.SavePort Port
Donde <objeto> es una referencia a un CTIBridgeClient.
Port es el puerto que queremos salvar en Registry.
Valor de retorno
Long
El valor de retorno será 0 si el método tiene éxito. Un código de error del API de
Windows si el método falla.
Ejemplo
Dim lRetVal As Long
lRetVal = CTIBridgeClient1.SavePort(3020)
MsgBox “Error” & Str$(lRetVal) & “ al salvar el puerto”
CTIBridgeClient V1.0
Documentación del programador
9
Eventos del objeto CTIBridgeClient
•
AgentLog
•
CallEntry
•
Connect
CTIBridgeClient V1.0
Documentación del programador
10
AgentLog
Evento que avisa cuando se activa un agente.
Ejemplo
Sub CTIBridgeClient1_AgentLog(NewAgent As String, NewPosition
As String)
Display.Text = “Agente: ” & NewAgent
End Sub
CTIBridgeClient V1.0
Documentación del programador
11
CallEntry
Este evento informa cuando entra una llamada en el puesto.
Ejemplo
Sub CTIBridgeClient1_CallEntry(ANI As String, Info As String)
MsgBox “Nueva llamada: ” & ANI
End Sub
CTIBridgeClient V1.0
Documentación del programador
12
Connect
Este evento informa cuando se ha establecido o se ha perdido la conexión con el
servidor.
Ejemplo
Sub CTIBridgeClient1_Connect (Connect As Boolean)
If Connect = True Then
Display1.Text = “Conexión con servidor establecida”
Else
Display1.Text = “Conexión con servidor perdida”
End If
End Sub
CTIBridgeClient V1.0
Documentación del programador
13