Elastix Web Services (WSDL) Especificaciones Funcionales
Contents
1. Petici n SOAP XML Petici n SOAP XML No objetivos Por ahora se mencionan los puntos que no est n incluidos en este desarrollo Todos los m dulos de Elastix que tengan para hacer exportaci n se los podr a convertir tambi n como Web Services elastix FREEDOM TO COMMUNICATE2. PhoneNumberCallForwardBusy positivelnteger n mero para la opci n call forward on busy M dulo Voicemail e Creaci n de un Web Service para el m dulo voicemail al cual se le incluir n los siguientes m todos o listVoicemail Lista los voicemails que tiene la extensi n del usuario autenticado Par metros de entrada startdate date fecha inicio de los registros enddate date fecha final de los registros Par metros de salida totalVoicemail positivelnteger n mero total de registros voicemail array arreglo con los siguientes datos date date fecha del voicemail time date hora del voicemail e callerid string extensi n a la que le pertenece el voicemail extension string extensi n que gener el voicemail duration positivelnteger duraci n en segundos del voicemail o delVoicemail Elimina un voicemail asociado a la extensi n del usuario autenticado Par metros de entrada file string nombre del archivo voicemail Par metros de salida return bool true si el voicemail fue eliminado caso contrario false o setConfiguration Realiza la configuraci n del voicemail de la extensi n asociada al usuario autenticado Par metros de entrada enable bool true para habilitar la configuraci n del voicemail caso contrario false email string email para el voicemail pagerEmail string opcional email secundario password string c
3. Elastix Web Services WSDL Especificaciones Funcionales Elaborado por Departamento de Desarrollo de Elastix Versi n Elastix 2 0 4 Beta 2 FREEDOM TO COMMUNICATE VERSIONAMIENTO Versi n Versi n de Fecha Editado por Aprobado Por Detalles Elastix 1 2 0 4 beta2 20 Abr 2011 Ing Alberto Santos Ing Bruno Macias Documentaci n Inicial elastix FREEDOM TO COMMUNICATE Elastix Web Services en Elastix 2 0 4 Generalidades En la actualidad la obtenci n y manipulaci n de datos es el centro funcional de cualquier tipo de empresa Es por esto que hemos decidido crear Web Services para Elastix de esta manera podremos obtener o manipular los datos de nuestro servidor Elastix desde diversos escenarios Objetivo Crear Web Services para Elastix que nos permitan obtener o modificar informaci n importante de ciertos m dulos del servidor Elastix Dicha informaci n debe pertenecer al usuario autenticado Herramientas de Desarrollo Todas las funcionalidades de los Elastix Web Services han sido desarrolladas en PHP Funcionalidad A continuaci n se detallan los m dulos a los que se crearon Web Services M dulo Calendar Creaci n de un Web Service para el m dulo calendar al cual se le incluir n los siguientes m todos o listCalendarEvents Lista los eventos del m dulo calendar pertenecientes al usuario autenticado y en el rango de fecha establecido Par metros
4. id positivelnteger id del fax en la base de datos Modemodev string dispositivo TTY del fax enviado o recibido errormsg string opcional mensaje de error en caso de existir company_name string descripci n de la compa a company fax string descripci n del n mero de la compa a date datetime fecha y hora del fax type string in para faxes recibidos y out para faxes enviados destiny_name string nombre del dispositivo fax destino destiny fax string n mero del fax destino elastix FREEDOM TO COMMUNICATE o delFaxDoc Elimina un fax y el documento PDF asociado a l en caso de que exista Par metros de entrada id positivelnteger id del fax que ser eliminado Par metros de salida return bool true si el fax fue eliminado caso contrario false M dulo My_ Extension Creaci n de un Web Service para el m dulo my_extension al cual se le incluir n los siguientes m todos o o setCallWaiting Habilita la opci n de call waiting para la extensi n del usuario autenticado Par metros de entrada CallWaiting bool true para activar el call waiting caso contrario false Par metros de salida return bool true si se activ el call waiting caso contrario false setCallMonitor Habilita las opciones de call monitor para la extensi n del usuario autenticado Par metros de entrada recordincoming string sta opci n puede ser Always Never o
5. Adhoc Se habilita para llamadas entrantes recordOutgoing string sta opci n puede ser Always Never o Adhoc Se habilita para llamadas salientes Par metros de salida return bool true si las opciones de call monitor fueron habilitadas caso contrario false setDoNotDisturb Habilita la opci n de do not disturb para la extensi n del usuario autenticado Par metros de entrada doNotDisturb bool true para habilitar do not disturb caso contrario false Par metros de salida return bool true si la opci n de do not disturb fue habilitada caso contrario false setCallForward Habilita las opciones de call forward para la extensi n del usuario autenticado Par metros de entrada CallForward bool true para habilitar la opci n de call forward caso contrario false phoneNumberCallForward positivelnteger n mero para la opci n call forward callForwardUnavailable bool true para habilitar la opci n de call forward on unavailable caso contrario false elastix FREEDOM TO COMMUNICATE _ _ _ _ _ _ _ _ _ _ oooooooo o ooo SS phoneNumberCallForwardUnavailable positivelnteger n mero para la opci n call forward on unavailable CallForwardBusy bool true para habilitar la opci n de call forward on busy caso contrario false
6. positivelnteger opcional l mite de registros o todos si es omitido Par metros de salida M dulo Fax totalcdrcount positivelnteger n mero total de registros cdrs array arreglo con los siguientes datos calldate datetime fecha y hora de la llamada src string extensi n origen en la llamada dst string extensi n destino en la llamada channel string canal donde se origin la llamada dstchannel string canal destino de la llamada disposition string descripci n del estado de la llamada uniqueid string id de la llamada duration positivelnteger duraci n en segundos de la llamada billsec positivelnteger duraci n en segundos de la llamada a cobrar accountcode string c digo de la cuenta Creaci n de un Web Service para el m dulo faxviewer al cual se le incluir n los siguientes m todos o listFaxDocs Lista los faxes enviados y recibidos por el servidor Elastix Par metros de entrada date date opcional fecha en que los faxes fueron enviados o recibidos o todos si es omitido direction string opcional in para faxes recibidos y out para faxes enviados o todos si es omitido offset positivelnteger opcional inicio de registros o O si es omitido limit positivelnteger opcional l mite de registros o todos si es omitido Par metros de salida totalfaxcount positivelnteger n mero total de registros faxes array arreglo con los siguientes datos
7. cual se llamar para el recordatorio reminder_timer string opcional n mero de minutos antes de que la llamada de recordatorio se realice emails_notification array string emails que ser n notificados con un mensaje cuando se crea el evento color string opcional color que tendr el evento Par metros de salida return bool true si el evento fue creado caso contrario false delCalendarEvent Elimina un evento perteneciente al usuario autenticado Par metros de entrada id positivelnteger id del evento que ser eliminado Par metros de salida return bool true si el evento fue eliminado caso contrario false elastix FREEDOM TO COMMUNICATE Creaci n de un Web Service para el m dulo address_book al cual se le incluir n los siguientes m todos M dulo AddressBook o listAddressBook Lista los contactos que tiene ingresado el usuario autenticado Par metros de entrada addressBookType string tipo de libreta puede ser internal o external Offset positivelnteger opcional inicio de registros o O si es omitido limit positivelnteger opcional l mite de registros o todos si es omitido Par metros de salida totalCount positivelnteger total de registros extension array arreglo con los siguientes datos id positivelnteger id del contacto en la base de datos phone string tel fono del contacto name string nombre completo del contac
8. de entrada startdate date fecha inicial del evento enddate date fecha final del evento elastix FREEDOM TO COMMUNICATE Par metros de salida id positivelnteger id del evento en la base de datos startdate date fecha de inicio del evento enddate date fecha en que finaliza el evento starttime datetime hora de inicio del evento endtime datetime hora en que finaliza el evento subject string asunto del evento description string descripci n del evento asterisk_call bool true si debe ser generada una llamada de recordatorio recording string opcional nombre del archivo de grabaci n usado para la llamada call_to string opcional extensi n a la cual se llamar para el recordatorio reminder_timer string opcional n mero de minutos antes de que la llamada de recordatorio se realice emails_notification array string emails que ser n notificados con un mensaje cuando se crea el evento addCalendarEvent Agrega un nuevo evento al calendar del usuario autenticado Par metros de entrada startdate date fecha de inicio del evento enddate date fecha en que finaliza el evento subject string asunto del evento description string descripci n del evento asterisk_call bool true si debe ser generada una llamada de recordatorio recording string opcional nombre del archivo de grabaci n usado para la llamada call_to string opcional extensi n a la
9. lave para el voicemail confirmPassword string confirmaci n de clave debe ser igual a password emailAttachment bool true para encender la opci n de email attachment caso contrario false playCID bool true para encender la opci n de play CID caso contrario false playEnvelope bool true para encender la opci n de play envelope caso elastix FREEDOM TO COMMUNICATE contrario false deleteVmail bool true para encender la opci n de delete Vmail caso contrario false Par metros de salida return bool true si la configuraci n fue realizada caso contrario false o downloadVoicemail Permite obtener el tama o el tipo de contenido y el contenido en s de un voicemail asociado a la extensi n del usuario autenticado Con estos datos se puede realizar la descarga de un voicemail siguiendo los pasos descritos en el Manual de Usuario Par metros de entrada file string nombre del archivo voicemail Par metros de salida audio string contenido del archivo de audio codificado en base64 contentType string tipo de contenido del archivo size string tama o del archivo Clase para generar el WSDL Para la generaci n del WSDL se cre una clase llamada WSDLcreator class php Esta clase consta con las siguientes funciones generate Esta funci n se encarga de generar el WSDL Par metros que recibe o arrFP array arreglo con los puntos funcionales del WSDL Re
10. que recibe o ObjElement object elemento tipo nodo para crear recursivamente elementos complexType o arrParamType array arreglo con los tipos de par metros de entrada y salida Retorun un bool true si la entidad fue creada caso contrario false isValid_DataType Verifica si el tipo de dato es v lido Par metros que recibe o datatype string tipo de dato a validar o param string nombre del par metro que tiene el tipo de dato a validar Retorna un string con el nombre correcto de tipo de dato o false si el tipo de dato no existe setPortType_Operation Crea la entidad Operation PortType en el WSDL Par metros que recibe o function string nombre del punto funcional para la entidad wsdl operation Retorna un bool true si la entidad Operation PortType fue creada caso contrario false setBinding_Operation Crea la entidad Operation Binding en el WSDL Par metros que recibe o function string nombre del punto funcional para la entidad wsdl operation secci n binding Retorna un bool true si la entidad Operation Binding fue creada caso contrario false elastix FREEDOM TO COMMUNICATE Clase para el manejo de SOAP Para el manejo de SOAP se cre una clase llamada SOAPhandler class php Esta clase consta con las siguientes funciones exportWSDL Esta funci n exporta el WSDL si es que todav a no se lo ha hecho Par metros que recibe o mode string los modos p
11. to first_name string opcional primer nombre del contacto last_name string opcional apellido del contacto email string opcional email del contacto addAddressBookContact Agrega un nuevo contacto para la lista external del usuario autenticado Par metros de entrada phone string tel fono del contacto first name string opcional nombre del contacto last name string opcional apellido del contacto email string opcional email del contacto Par metros de salida return bool true si el contacto fue agregado caso contrario false delAddressBookContact Elimina un contacto de la lista external del usuario autenticado adem s borra cualquier archivo relacionado a ese contacto Par metros de entrada id positivelnteger id del contacto a ser eliminado Par metros de salida return bool true si el contacto fue eliminado caso contrario false Creaci n de un Web Service para el m dulo cdrreport al cual se le incluir n los siguientes m todos o listCDR Lista las llamadas realizadas y recibidas que est n relacionadas al usuario autenticado elastix FREEDOM TO COMMUNICATE Par metros de entrada startdate date opcional fecha de inicio para los registros o todos si es omitido enddate date opcional fecha m xima para los registros o todos si es omitido offset positivelnteger opcional inicio de registros o O si es omitido limit
12. torna un bool true en caso de haberse generado el WSDL caso contrario false enableCache Habilita la cache Retorna un bool true si la cache fue activada y se escribi el archivo exitosamente caso contrario false export Esta funci n realiza la exportaci n del WSDL Par metros que recibe o mode string los modos pueden ser download file o print por default este par metro es print o targetFile string si modo es file esta variable debe ser la ruta del archivo getError Retorna el atributo error de la clase getWSDL Obtiene el WSDL como string y lo retorna create WSDL_TPL Crea la plantilla WSDL como un objeto XML Retorna un bool true si fue creado exitosamente caso contrario false elastix FREEDOM TO COMMUNICATE setMessage Crea la entidad message en el WSDL Par metros que recibe o function string nombre del punto funcional para colocarlo en la entidad wsdl message o arrParams array arreglo de par metros de entrada y salida del punto funcional Retorna un bool true si la entidad message fue creada caso contrario false setSchemaTypes Crea la entidad element en el WSDL Par metros que recibe o nameElement string nombre del elemento en el esquema o arrParamType array arreglo con los tipos de par metros de entrada y salida Retorna un bool true si la entidad element fue creada caso contrario false addElements_SchemaTypes Par metros
13. ueden ser download file o print por default este par metro es print o targetFile string si modo es file esta variable debe ser la ruta del archivo Retorna un bool true si la exportaci n se realiz con xito caso contrario false authentication Esta funci n verifica que el usuario en la variable SERVER PHP_AUTH_USER est correctamente autenticado Retorna un bool true si la autenticaci n es correcta caso contrario false execute Este procedimiento inicia el servidor SOAP Par metros que recibe o cache bool true para habilitar la cache caso contrario false getError Esta funci n retorna el error ocurrido en caso de haberlo y lo lanza como un SOAP fault createSOAPFault Crea un SOAP fault Par metros que recibe o faultcode string c digo del SOAP fault o faultmsg string breve descripci n del SOAP fault o faultdesc string descripci n detallada del SOAP fault o classname string nombre de la clase donde se inici el error Retorna el xml con el SOAP fault elastix FREEDOM TO COMMUNICATE Interacci n entre SOAPHandler y WSDLCreator WSDLCreator SOAPhHandler request response request response M dulo response request response request elastix FREEDOM TO COMMUNICATE Diagrama de Flujo Consulta Respuesta SOAP XML Petici n SOAP XML Respuesta Respuesta SOAP XML SOAP XML
Download Pdf Manuals
Related Search