ManualAPI ... · Lainformaciónycontenidodeestedocumentoseproporcionasóloparafinesinformativosyse...

Manual API

Muestra cómo mediante programación puede enviar faxes desdeaplicaciones personalizadas u otras aplicaciones utilizando las API de

GFI FaxMaker.

La información y contenido de este documento se proporciona sólo para fines informativos y seproporciona "tal cual", sin garantía de ningún tipo, ya sea expresa o implícita, incluyendo pero nolimitadas a las garantías implícitas de comercialización, idoneidad para un propósito particular yausencia de infracción. GFI Software no se hace responsable de ningún daño, incluyendo dañosconsecuentes, de cualquier naturaleza, que puedan deberse a la utilización de este documento. Lainformación se ha obtenido de fuentes disponibles públicamente. A pesar de los esfuerzosrazonables que se han hecho para asegurar la exactitud de los datos facilitados, GFI no reclama,promete o garantiza la integridad, exactitud, actualidad o adecuación de la información y no esresponsable de errores tipográficos, fuera de la información actualizada, o errores. GFI no ofreceninguna garantía, expresa o implícita, y no asume ninguna obligación legal ni responsabilidad por laexactitud o la exhaustividad de la información contenida en este documento.

Si estima que existe algún error objetivo en este documento, póngase en contacto con nosotros yrevisaremos sus dudas tan pronto como sea posible.

Windows, Exchange, IIS, .NET, Internet Explorer, Outlook, SQL Server y Microsoft son marcascomerciales registradas o marcas comerciales de Microsoft Corporation en Estados Unidos y/ootros países.

Todos los nombres de productos y empresas mencionados aquí pueden ser marcas comerciales desus respectivos titulares.

GFI FaxMaker es propiedad de GFI SOFTWARE Ltd. - 1999-2013GFI Software Ltd. Reservados todoslos derechos.

Versión del documento: 1.3.1

Última actualización (mes/día/año): 10/2/2013

Tabla de contenido

1 API de GFI FaxMaker 4

2 TextAPI 5

2.1 Funcionamiento de TextAPI 52.2 Cómo habilitar TextAPI en GFI FaxMaker 52.3 Creación de TextAPI 7

3 XMLAPI 11

3.1 Funcionamiento de XMLAPI 113.2 Cómo habilitar XMLAPI en GFI FaxMaker 123.3 Creación de XMLAPI 133.4 Campos y parámetros de fax 143.5 Campos y parámetros de SMS 22

4 API de servicios web 26

4.1 Requisitos y notas importantes 264.2 Introducción 264.3 Funciones de API 274.4 Clases 294.5 Enums 314.6 Administración de la cola de la API de servicios web 32

5 Solución de problemas y soporte técnico 33

5.1 Introducción 335.2 Base de conocimientos 335.3 Foro en la red 335.4 Solicitar soporte técnico 335.5 Documentación 33

1 API de GFI FaxMaker

Las API le permiten integrar software de terceros con GFI FaxMaker.

Esta automatización del proceso se puede utilizar para una amplia variedad de sectores yaplicaciones, como atención sanitaria, venta al por menor y banca.

Por ejemplo, puede usar XMLAPI con su software de facturación para crear una plantilla de informesXML para extractos de cuenta y balances. Periódicamente, genere este informe para cada cliente quedeba dinero y almacénelo en la carpeta de recogida de XMLAPI. GFI FaxMakertransmiteautomáticamente los extractos a los destinatarios previstos.

Tipos de API disponibles en GFI FaxMaker

XMLAPI Envía faxes o SMS utilizando archivos XML. Puede configurar software de terceros para generar APIautomáticamente y transmitir faxes en bloque. GFI FaxMaker recoge y transmite todos los archivos XMLalmacenados en una carpeta de recogida de XMLAPI personalizada.El formato de las XMLAPI debe seguir una convención estándar, es decir, debe utilizar campos y parámetrosque GFI FaxMaker pueda emplear para procesar faxes y SMS. Para obtener más información, consulte XMLAPI(página 11).

TextAPI Envía faxes utilizando archivos de texto sin formato. Puede configurar software de terceros para generar APIautomáticamente y transmitir faxes en bloque. GFI FaxMaker recoge y transmite todos los archivos de textoalmacenados en una carpeta de recogida de TextAPI personalizada.El formato de las TextAPI debe seguir una convención estándar, es decir, debe utilizar campos y parámetrosque GFI FaxMaker pueda emplear para procesar faxes y SMS. Para obtener más información, consulte TextAPI(página 5).

API deserviciosweb

La API de servicios web de GFI FaxMaker le permite desarrollar sus propias aplicaciones que pueden conec-tarse con GFI FaxMaker. Puede enviar y recibir faxes directamente desde su aplicación. Para obtener másinformación, consulte API de servicios web (página 26).

2 TextAPI

TextAPI es una característica de GFI FaxMaker que permite la transmisión de faxes a partir dearchivos de texto. El formato de estos archivos de texto debe seguir una convención estándar, esdecir, debe utilizar campos y parámetros que GFI FaxMaker pueda emplear para transmitir faxes.Almacene TextAPI en una carpeta dedicada. GFI FaxMaker recoge todas las TextAPI almacenadas enesta carpeta y transmite el contenido por fax.

Para configurar TextAPI:

Cree y dedique una carpeta a la que GFI FaxMaker pueda acceder en la que se almacenarán losarchivos de texto para la transmisión de faxes.

Habilite la característica TextAPI desde GFI FaxMaker. Para obtener más información, consulteCómo habilitar TextAPI en GFI FaxMaker (página 5).

Cree TextAPI utilizando campos y parámetros aceptados por GFI FaxMaker. Para obtener másinformación, consulte Creación de TextAPI (página 7).

2.1 Funcionamiento de TextAPI

Figura 1: Funcionamiento de TextAPI

Paso Descripción

Generación de TextAPINormalmente se configura una aplicación de terceros para generar automáticamente TextAPI. Asegúrese de queel archivo generado cumple los parámetros, los campos y los requisitos de GFI FaxMaker, según lo descrito eneste manual. Para obtener más información, consulte Creación de TextAPI (página 7).

Almacenamiento de la API en la carpeta de recogida de TextAPIEn GFI FaxMaker, configure las carpetas desde las que se recogerán las API. Almacene las API generadas en lacarpeta adecuada. Para obtener más información, consulte Cómo habilitar TextAPI en GFI FaxMaker (página 5).

GFI FaxMaker recupera APIPeriódicamente, GFI FaxMaker consulta las carpetas configuradas en busca de API *.txt.

GFI FaxMaker procesa y transmite faxesGFI FaxMaker procesa las API recuperadas y transmite el fax según los campos y los parámetros especificados enla API.

NOTA

Asegúrese de que los archivos adjuntos y los archivos del cuerpo se almacenantotalmente en la ubicación adecuada antes de almacenar las API en la carpeta derecogida. Almacene los archivos adjuntos en la carpeta TextAPI.

2.2 Cómo habilitar TextAPI en GFI FaxMaker

Para habilitar y configurar TextAPI:

1. En Configuración de GFI FaxMaker, haga clic con el botón secundario en el nodo Opcionesavanzadas Text-API/XMLAPI y seleccione Propiedades.

Captura de pantalla 1: Cómo habilitar TextAPI

2. En la ficha TextAPI, configure las siguientes opciones:

Opción Descripción

Habilitado Habilita TextAPI.

Carpetas que seexaminan

Especifique las carpetas en que se almacenarán las API de texto para que GFI FaxMaker las procese.Haga clic en Agregar para seleccionar las carpetas. Para ejecutar el examen recursivo de TextAPI ensubcarpetas, seleccione Incluir subcarpetas.

Almacenartodos los archi-vos de res-puesta en unacarpeta

Después de procesar un TextAPI, GFI FaxMaker crea un archivo de respuesta (extensión *.status). Demanera predeterminada, GFI FaxMaker almacena los archivos de respuesta en las carpetas de reco-gida. Para almacenar todos los archivos de respuesta en una sola ubicación, seleccione esta opción yespecifique una ubicación.

Formato detexto utilizandocarátula

Seleccione la carátula que va a usar para los faxes de TextAPI. Para obtener más información sobrecarátulas, consulte elGFI FaxMaker Manual de administración y configuración.

Tabla 1: Opciones de TextAPI

3. Haga clic en Aceptar.

Siguiente paso: Comience creando las API XML. Para obtener más información, consulte Creación deTextAPI (página 7).

2.3 Creación de TextAPI

Cuando utilice TextAPI, cree un archivo de texto (formato .txt) estructurado de la siguiente forma:

Línea Descripción

Primera línea Especifique el número de fax del destinatario precedido por dos puntos, con el formato siguiente:::número de fax

Por ejemplo:::12345678

También se pueden incluir otros parámetros con el formato siguiente:::nombre, empresa, apellidos, departamento, dirección de correo electrónico,número de fax

Por ejemplo, para enviar un fax a John Smith, que está en el departamento comercial de la empresaJohn Company y cuya dirección de correo electrónico y número de fax son [email protected] y12345678, respectivamente, la entrada será como la siguiente:::John, Empresa de John, Smith, ventas, [email protected], 12345678

Segunda línea(opcional)

Especifique otras opciones de envío precedidas por dos puntos. Por ejemplo:::S=listaprecios

Separe varios parámetros con comas. Por ejemplo:::c=carátula1,23:15,B=5

Para obtener más información, consulte Opciones de envío de TextAPI (página 7).

Otras líneas Introduzca el mensaje de texto que va a enviar por fax.

Tabla 2: Estructura del archivo TextAPI

2.3.1 Opciones de envío de TextAPI

Se puede especificar una serie de opciones de envío en la segunda línea de la API de texto.

NOTA

Se pueden especificar varias opciones. Separe varios parámetros con comas. Porejemplo:

::s=asunto,from=Peter,c=carátula1,23:15,B=5

NOTA

GFI FaxMaker no distingue entre mayúsculas y minúsculas. Se pueden especificarparámetros en mayúsculas y en minúsculas.

Opción de envío Parámetro Descripción

Asunto ::S=Este es el asunto

o bien::subject=Este es el asunto

Especifique el asunto del fax. Este texto se insertaen el campo <subject> de la carátula. ReemplaceEste es el asunto por el texto del asunto.

Tabla 3: Parámetros de TextAPI


Remitente ::fr=nombre

o bien::from=nombre

Utilice este parámetro para especificar el nombredel remitente del fax. El nombre especificado seincluye como el nombre del remitente en lacarátula. Reemplace nombre por el nombre delremitente.NOTA: Si esta opción no se especifica, GFI FaxMakerno tiene información sobre el remitente y, porconsiguiente, no puede devolver un informe detransmisión.

Adjunto ::A=NombreArchivo Especifique un archivo para adjuntar al fax. Elarchivo se debe almacenar en la misma carpeta derecogida de TextAPI.Sustituya NombreArchivo por el nombre y laextensión del archivo que se va a adjuntar.Por ejemplo, ::A=FaxAttachment.tifSe pueden adjuntar varios archivos especificando elcomando varias veces. Por ejemplo:::A=FaxAttachment.tif,A=disclaimer.tif

NOTA: Los archivos adjuntos se eliminanpermanentemente de la carpeta de recogida. Si serequiere una copia, asegúrese de que se realiza unacopia de seguridad antes de mover el archivoadjunto a la carpeta TextAPI.

Prioridad Prioridad alta::p=high

o bien::p=h

o bien::priority=high

o bien::priority=h

Prioridad baja::p=low

o bien::p=l

o bien::priority=low

o bien::priority=l

Especifique la prioridad de fax (baja o alta) que va ausar cuando se envíe el fax.

Código de fac-turación

::B=nnnn

o bien::billingcode=nnnn

Utilice este parámetro para especificar un código defacturación, si GFI FaxMaker se ha configurado parasolicitar un código de facturación. Reemplace nnnnpor el código de facturación.


Programación ::YYYY-MM-DD-hh:mm:ss

o bien::hh:mm

Especifique la fecha y la hora, o bien solo la hora deenvío del fax.Reemplace:

AAAA - año

MM - mes

DD - día

hh - horas en formato de reloj de 24 horas

mm - minutos

ss - segundos

Por ejemplo, ::2012-04-21-16:05:00

Carátula ::C=NombreCarátula

o bien::Coverpage=NombreCarátula

De forma predeterminada, GFI FaxMaker utiliza lacarátula predeterminada configurada enGFI FaxMaker. Utilice este parámetro para enviar unfax utilizando una carátula concreta. ReemplaceNombreCarátula por el nombre de la carátula queva a usar, según lo configurado en GFI FaxMaker.También puede utilizar ::C=none para evitaragregar una carátula.

Nota decarátula delantera

::F=NotaCarátulaDelantera

o bien::frontcover=NotaCarátulaDelantera

Utilice este parámetro para enviar un fax utilizandouna nota de carátula delantera concreta.Reemplace NotaCarátulaDelantera por elnombre de la nota de carátula delantera que va ausar, según lo configurado en GFI FaxMaker.

Línea de fax ::line=n

o bien::l=n

Especifique este parámetro para solicitar que el faxse envíe en una línea de fax concreta. Reemplace npor el número de línea de fax, según lo especificadoen Configuración de GFI FaxMaker.NOTA: Si la línea está ocupada o no está disponible,el fax se enviará por otra línea. Para enviar el faxexclusivamente desde una línea concreta, utilice elparámetro siguiente:::dl=n

El fax no se enviará hasta que esta línea de fax estédisponible.

Resolución Resolución alta::H

o bien::high

Resolución normal::N

o bien::normal

Utilice este parámetro para especificar la resolucióndel fax. Utilice una resolución alta (200 * 200 ppp) onormal (200 * 100 ppp).

Encabezado ::fh=encabezado

o bien::faxheader=encabezado

Utilice esta opción para definir un encabezado per-sonal personalizado, que se agregará al encabezadode fax predeterminado al principio del fax. Reem-place encabezado por el texto de encabezado quedesee agregar.

Informe resumende transmisión

Enviar informe resumen de transmisión::tr=summary

No enviar resumen nunca::tr=none

Use summary para recibir sólo un informe detransmisión al enviar un fax a varios destinatarios.Use none para no enviar un informe de transmisióndespués de la transmisión del fax.

2.3.2 Ejemplo de TextAPI

::John, Empresa de John, Smith, ventas, [email protected], 12345678

::from=Bob Jones,subject=Hola John,H,fh=Fax de prueba

Este es el mensaje de fax.

Saludos,

Paul

3 XMLAPI

XMLAPI es una característica de GFI FaxMaker que permite la transmisión de faxes a partir de archivosXML. El formato de estos archivos XML debe seguir una convención estándar, es decir, debe utilizarcampos y parámetros que GFI FaxMaker pueda emplear para transmitir faxes. Almacene XMLAPI enuna carpeta dedicada. GFI FaxMaker recoge todas las XMLAPI almacenadas en esta carpeta ytransmite el contenido por fax.

Para configurar XMLAPI:

Cree y dedique una carpeta a la que GFI FaxMaker pueda acceder en la que se almacenarán losarchivos XML para la transmisión de faxes.

Habilite la característica XMLAPI desde GFI FaxMaker. Para obtener más información, consulteCómo habilitar XMLAPI en GFI FaxMaker (página 12).

Cree XMLAPI utilizando campos y parámetros aceptados por GFI FaxMaker. Para obtener más infor-mación, consulte Creación de XMLAPI (página 13).

3.1 Funcionamiento de XMLAPI

Figura 2: Funcionamiento de XMLAPI

Paso Descripción

Generación de XMLAPINormalmente se configura una aplicación de terceros para generar automáticamente XMLAPI. Asegúrese de queel archivo generado cumple los parámetros, los campos y los requisitos de GFI FaxMaker. Para obtener másinformación, consulte Creación de XMLAPI (página 13).

Almacenamiento de la API en la carpeta de recogida de XMLAPIEn GFI FaxMaker, configure las carpetas desde las que se recogerán las API. Almacene las API generadas en lacarpeta adecuada. Para obtener más información, consulte Cómo habilitar XMLAPI en GFI FaxMaker (página 12).

GFI FaxMaker recupera API.Periódicamente, GFI FaxMaker consulta las carpetas configuradas en busca de API *.xml.

GFI FaxMaker procesa y transmite faxesGFI FaxMaker procesa las API recuperadas y transmite el fax/SMS según los campos y los parámetros especificadosen la API.

NOTA

Asegúrese de que los archivos adjuntos y los archivos del cuerpo se almacenantotalmente en la ubicación adecuada antes de almacenar las API en la carpeta derecogida. Almacene los archivos adjuntos o el archivo de cuerpo en la carpeta XMLAPI oen una ruta personalizada (según lo configurado en los parámetros XML de la API).

NOTA

Después de transmitir un fax utilizando XMLAPI, GFI FaxMaker genera un mensaje derespuesta (archivo *.status) en la carpeta XMLAPI que incluye detalles sobre latransmisión del fax. Los usuarios, los administradores o las aplicaciones de tercerospueden utilizarlo para supervisar la transmisión del fax. Para obtener más información,consulte Archivos de respuesta de fax (página 20).

3.2 Cómo habilitar XMLAPI en GFI FaxMaker

Para habilitar y configurar XMLAPI:

1. En Configuración de GFI FaxMaker, haga clic con el botón secundario en el nodo Opcionesavanzadas Text-API/XMLAPI y seleccione Propiedades.

Captura de pantalla 2: Habilitar XMLAPI

2. En la pestaña XMLAPI, haga clic en Agregar para seleccionar las carpetas en las que sealmacenarán los XMLAPI. Para marcar también subcarpetas para los XMLAPI, seleccione Incluirsubcarpetas.

3. Después de procesar un XMLAPI, GFI FaxMaker crea un archivo de respuesta (extensión *.status). Demanera predeterminada, GFI FaxMaker almacena los archivos de respuesta en las carpetas derecogida. Para almacenar todos los archivos de respuesta en una sola ubicación, seleccioneAlmacenar todos los archivos de respuesta en una carpeta y especifique la ubicación. Para obtenermás información, consulte Archivos de respuesta de fax (página 20).

3. Haga clic en Aceptar.

Siguiente paso: Comience creando las API XML. Para obtener más información, consulte Creación deXMLAPI (página 13).

3.3 Creación de XMLAPI

Si utiliza XMLAPI, cree un archivo XML (formato .xml) que contenga los parámetros del fax/SMS que vaa transmitir. Todos los parámetros de XMLAPI deben encontrarse en un contenedor XML<faxmakerdata>. Los datos a su vez deben estar incluidos en tres contenedores independientes dela siguiente forma:

Contenedores XMLAPI Descripción<fields> En este contenedor, especifique las propiedades de la transmisión del fax, como el asunto, el

archivo adjunto y el archivo del mensaje.

<sender> Escriba en este contenedor los detalles del remitente.

<recipients> Especifique la información del destinatario en este contenedor.

Tabla 4: Contenedores de campo XMLAPI

NOTA

También es necesario un encabezado XML. Suele ser:

<?xml version="1.0" encoding="utf-8"?>

Para obtener más información sobre los campos y parámetros de XMLAPI, diríjase a:

Campos y parámetros de fax

Campos y parámetros de SMS

3.3.1 XMLAPI de muestra


<faxmakerdata>

<fields>

<subject>Este es el asunto del fax</subject>

<bodyfile type="text/plain">c:\temp\bodyfile.txt</bodyfile>

<attachment>c:\temp\document.txt</attachment>

</fields>

<sender>

<emailaddress>[email protected]</emailaddress>

</sender>

<recipients>

<fax>

<recipient>

<faxnumber>+1 800 6565</faxnumber>

</recipient>

</fax>

</recipients>

</faxmakerdata>

En este manual se incluyen XMLAPI de ejemplo más extensos:

XMLAPI de fax de muestra

XMLAPI de SMS de muestra

3.4 Campos y parámetros de fax

Lista de campos y parámetros compatibles de XMLAPI para enviar faxes.

Campos de mensaje

Información del remitente

Información del destinatario del fax

Para referencia, consulte el XMLAPI de fax de ejemplo. Para obtener más información, consulteXMLAPI de fax de muestra (página 19).

3.4.1 Campos de mensaje

En el contenedor <fields>, especifique la siguiente información:

Asunto Ruta XML \faxmakerdata\fields\subject

Tipo Cadena

Disposición Opcional

Detalles Especifique el asunto del fax.

Ejemplo <subject>Este es un asunto del fax</subject>

Programación Ruta XML \faxmakerdata\fields\schedule

Tipo Cadena


Detalles Especifique la fecha y la hora en la que se va a enviar el fax, con el formato siguiente:YYYY-MM-DD-HH:mm:ss

Reemplace:AAAA - año

MM - mes

DD - día

hh - horas en formato de reloj de 24 horas

mm - minutos

ss - segundos

Ejemplo <schedule>2012-10-10-08:15:00</schedule>

Tabla 5: Campos y parámetros de mensaje

Prioridad Ruta XML \faxmakerdata\fields\priority

Tipo Cadena


Detalles Establezca la prioridad del mensaje. Los valores válidos son:low

normal

high

veryhigh

Ejemplo <priority>high</priority>

Código de fac-turación

Ruta XML \faxmakerdata\fields\billingcode

Tipo Cadena

Disposición Opcional. Necesario cuando Facturación está habilitado.

Detalles Establece el código de facturación del remitente del mensaje.

Ejemplo <billingcode>25</billingcode>

Resolución Ruta XML \faxmakerdata\fields\resolution

Tipo Cadena


Detalles Utilice este parámetro para especificar la resolución del fax. Los valores válidos son:Normal (200 * 100 ppp)

High (200 * 200 ppp)

Ejemplo <resolution>high</resolution>

Carátula Ruta XML \faxmakerdata\fields\coverpage

Tipo Cadena


Detalles De forma predeterminada, el fax se envía utilizando la carátula predeterminadaconfigurada en GFI FaxMaker. Utilice este parámetro para enviar un fax utilizando unacarátula concreta. Escriba el nombre de la carátula que se va a usar, utilizando uno delos siguientes:

Nombre de la carátula según lo configurado en GFI FaxMaker.

Nombre de archivo de una carátula almacenada en <carpeta de instalación deGFI FaxMaker>\Carátula. Por ejemplo, genérico.htm.

Ejemplo <coverpage>corporativo</coverpage>

Nota de cará-tula delan-tera

Ruta XML \faxmakerdata\fields\frontcovernote

Tipo Cadena


Detalles De forma predeterminada, el fax se envía utilizando la nota de carátula delanterapredeterminada configurada en GFI FaxMaker. Utilice este parámetro para enviar un faxutilizando una nota de carátula delantera concreta. Escriba el nombre de la nota decarátula delantera que se va a usar, utilizando uno de los siguientes:

Nombre de la nota de carátula delantera según lo configurado en GFI FaxMaker.

Nombre de archivo de una nota de carátula delantera almacenada en <carpeta deinstalación de GFI FaxMaker>\Carátula. Por ejemplo, MiNotaCarátula.htm.

Ejemplo <frontcovernote>membrete</frontcovernote>

Línea de fax Ruta XML \faxmakerdata\fields\faxline

Tipo Número


Detalles Utilice este parámetro para solicitar que el fax se envíe en una línea de fax concreta.Especifique el número de línea de fax, según lo especificado en Configuración deGFI FaxMaker.NOTA: Si la línea está ocupada o no está disponible, el fax se enviará por otra línea. Paraenviar el fax exclusivamente desde una línea concreta, utilice el atributo siguiente:demandline=”true”

Ejemplo <faxline demandline="true">3</faxline>

Encabezado Ruta XML \faxmakerdata\fields\faxheader

Tipo Cadena


Detalles Introduzca un encabezado personal personalizado, que se agregará al encabezado de faxal principio del fax.

Ejemplo <faxheader>Este es un encabezado del fax</faxheader>

Id. único Ruta XML \faxmakerdata\fields\uid

Tipo Cadena [máx. 255 caracteres]


Detalles Especifique un identificador que se usa para marcar el mensaje. El carácter único de esteidentificador depende del creador del mensaje. El número máximo de caracteres es 255.

Ejemplo <uid>3a5a90s7de3g20k9y4d5e7e6fse28se5e097</uid>

TextAPI Ruta XML \faxmakerdata\fields\textapi

Tipo Cadena


Detalles Se usa para especificar una sola línea de comandos de TextAPI (incluido el prefijo '::').Este campo se puede especificar varias veces.

Ejemplo <textapi>::billingcode=25,line=3</textapi>

Archivo decuerpo delmensaje

Ruta XML \faxmakerdata\fields\bodyfile

Tipo Ruta completa o nombre de archivo


Detalles Utilice el contenido del archivo como cuerpo del mensaje en la carátula de fax.Escriba la ruta completa o el archivo o bien introduzca solo el nombre de archivo si elarchivo de cuerpo se ha almacenado en la carpeta de carátulas: <carpeta deinstalación de GFI FaxMaker>\Carátula.NOTA: Si se introduce la ruta de acceso completa, el archivo se elimina una vezprocesado.Especifique el tipo de archivo. Use uno de los atributos siguientes:

type="text/html" - Especifique este atributo cuando el texto del cuerpo del men-saje esté en formato HTML.

type="text/rtf" - Especifique este atributo cuando el texto del cuerpo del men-saje esté en formato RTF.

type="text/plain" - Especifique este atributo cuando el texto del cuerpo del men-saje esté en formato de texto sin formato.

Si no se especifica ningún atributo de tipo de archivo, el mensaje se introduce como textosin formato.

Ejemplo <bodyfile type="text/plain">c:\temp\bodyfile.txt</bodyfile>

Adjunto Ruta XML \faxmakerdata\fields\attachment


Disposición Opcional (máximo de 60 archivos adjuntos)

Detalles Adjunta el contenido del archivo especificado al fax.Escriba la ruta completa o el archivo o bien introduzca solo el nombre de archivo si elarchivo de cuerpo se ha almacenado en la misma carpeta que el XMLAPI.NOTA: Asegúrese de que los archivos adjuntos se almacenan totalmente en la ubicaciónadecuada antes de almacenar los archivos de la API en la carpeta de recogida.NOTA: Si se introduce la ruta de acceso completa, el archivo se elimina una vezprocesado.

Ejemplo <attachment>c:\temp\document.doc</attachment>

NOTASe necesita un archivo adjunto o un archivo de cuerpo de mensaje de fax.

3.4.2 Campos del remitente

En el contenedor <sender>, especifique la información de remitente siguiente:

Nombre Ruta XML \faxmakerdata\sender\firstname

Tipo Cadena


Detalles Establece el nombre del remitente.

Ejemplo <firstname>John</firstname>

Apellidos Ruta XML \faxmakerdata\sender\lastname

Tipo Cadena


Detalles Establece los apellidos del remitente.

Ejemplo <lastname>Smith</lastname>

Empresa Ruta XML \faxmakerdata\sender\company

Tipo Cadena


Detalles Establece el nombre de empresa del remitente.

Ejemplo <company>MiNombre de empresa</company>

Departamento Ruta XML \faxmakerdata\sender\department

Tipo Cadena


Detalles Establece el departamento del remitente.

Ejemplo <department>Ventas</department>

Número de teléfono Ruta XML \faxmakerdata\sender\voicenumber

Tipo Cadena


Detalles Establece el número de voz (teléfono) del remitente.

Ejemplo <voicenumber>+1(800)1234 5678</voicenumber>

Dirección de correo electrónico Ruta XML \faxmakerdata\sender\emailaddress

Tipo Cadena

Disposición Obligatorio

Detalles Establece la dirección de correo electrónico del remitente.

Ejemplo <emailaddress>[email protected]</emailaddress>

Tabla 6: Campos y parámetros de remitente

3.4.3 Campos de destinatario de fax

En el contenedor <recipient>, especifique la información de destinatario. Para faxes, agregue uncontenedor <fax> y un contenedor <recipient>.

Por ejemplo:

<recipients>

<fax>

<recipient>

<faxnumber>+1 800 1234 5678</faxnumber>

</recipient>

</fax>

</recipients>

NOTA

Un fax también se puede enviar a varios destinatarios. Para obtener más información,consulte Envío de un fax a varios destinatarios (página 19).

Inserte otros parámetros y campos en el contenedor <recipient> de la siguiente forma:

Nombre Ruta XML \faxmakerdata\recipients\fax\recipient\firstname

Tipo Cadena


Detalles Establece el nombre del destinatario.

Ejemplo <firstname>Joe</firstname>

Apellidos Ruta XML \faxmakerdata\recipients\fax\recipient\lastname

Tipo Cadena


Detalles Establece los apellidos del destinatario.

Ejemplo <lastname>Bloggs</lastname>

Empresa Ruta XML \faxmakerdata\recipients\fax\recipient\company

Tipo Cadena


Detalles Establece el nombre de la empresa del destinatario.

Ejemplo <company>Empresa de DestinatarioFax SL</company>

Departamento Ruta XML \faxmakerdata\recipients\fax\recipient\department

Tipo Cadena


Detalles Establece el departamento del destinatario.

Ejemplo <department>Marketing</department>

Número de fax Ruta XML \faxmakerdata\recipients\fax\recipient\faxnumber

Tipo Cadena


Detalles Establece el número de fax del destinatario.

Ejemplo <faxnumber>+1(800)8765 4321</faxnumber>

Tabla 7: Campos y parámetros de destinatario de fax

Número de teléfono Ruta XML \faxmakerdata\recipients\fax\recipient\voicenumber

Tipo Cadena


Detalles Establece el número de teléfono (voz) del destinatario.


Dirección de correo elec-trónico

Ruta XML \faxmakerdata\recipients\fax\recipient\emailaddress

Tipo Cadena


Detalles Establece la dirección de correo electrónico del destinatario.


Envío de un fax a varios destinatarios

Un fax se puede enviar a varios destinatarios. Para ello, incluya varioscontenedores <recipient>...</recipient>. Por ejemplo:

<recipients>

<fax>

<recipient>

<firstname>Bob</firstname>


</recipient>

<recipient>

<firstname>John</firstname>


</recipient>

</fax>

</recipients>

3.4.4 XMLAPI de fax de muestra

NOTA

Para este ejemplo, se utilizan otros dos archivos:

Archivo adjunto: un archivo adjunto archivomsword.doc se almacena en c:\temp\

Archivo de cuerpo: un archivo de texto sin formato archivocuerpo.txt se almacenaen c:\temp\

Estos archivos se eliminarán de c:\temp\ cuando GFI FaxMaker recupere el fax.


<faxmakerdata>

<fields>

<subject>este es el asunto del fax</subject>

<schedule>2012-10-10-08:15:00</schedule>

<priority>high</priority>

<billingcode>25</billingcode>

<resolution>high</resolution>

<coverpage>corporativo</coverpage>

<frontcovernote>membrete</frontcovernote>

<faxline demandline="true">3</faxline>

<faxheader>este es el texto de encabezado del fax</faxheader>


<attachment>c:\temp\mswordfile.doc</attachment>

<uid>3a5a90s7de3g20k9y4d5e7e6fse28se5e097</uid>

</fields>

<sender>


<lastname>Smith</lastname>

<company>MiEmpresa SL</company>

<department>Ventas</department>

<faxnumber>1234 5678</faxnumber>

<voicenumber>9876 5432</voicenumber>


</sender>

<recipients>

<fax>

<recipient>

<firstname>Joe</firstname>

<lastname>Bloggs</lastname>

Empresa<company>Empresa de JohnBloggs</company>

<department>Marketing</department>

<faxnumber>1122 3344</faxnumber>

<voicenumber>5566 7788</voicenumber>


</recipient>

</fax>

</recipients>

</faxmakerdata>

3.4.5 Archivos de respuesta de fax

Después de procesar un XMLAPI, GFI FaxMaker crea un archivo de respuesta en la carpeta XMLAPI quese puede utilizar para revisar la transmisión del fax. El archivo de respuesta tiene una extensión*.status. Se pueden configurar herramientas de terceros para consultar esta carpeta y recuperarautomáticamente el estado de los faxes transmitidos.

NOTA

La transmisión de SMS no genera el archivo de respuesta.

Captura de pantalla 3: Mensaje de respuesta XMLAPI de muestra

El mensaje de respuesta contiene los contenedores XML siguientes:

Contenedor Descripción<fax>...</fax> Contenedor para cada transmisión de fax. Si un archivo API XML contiene varios

destinatarios, se crea un contenedor <fax> para cada destinatario, que con-tiene todos los detalles de esa transmisión concreta.

<errorcode>...</errorcode> Devuelve el código de error para la transmisión de fax. Una transmisióncorrecta devuelve un código de error 0.

<description>...</description> Contiene un informe de transmisión para transmisiones realizadas con éxito oque han generado error. Incluye parámetros importantes sobre el fax.

<uid>...</uid> Si se ha especificado un Id. único (uid) en el XMLAPI, se genera este con-tenedor.

<faxfile>...</faxfile> Contiene la ruta completa al archivo de imagen del fax.

<recipient>...</recipient> Muestra el número de fax al que se ha enviado el fax.

Tabla 8: Contenedores de mensaje de respuesta

3.5 Campos y parámetros de SMS

Lista de campos y parámetros compatibles de XMLAPI para enviar SMS.

Campos de mensaje

Información del remitente

Información del destinatario del SMS

Para referencia, consulte el XMLAPI de SMS de ejemplo. Para obtener más información, consulteXMLAPI de SMS de ejemplo (página 25).

3.5.1 Campos de mensaje

En el contenedor <fields>, especifique la siguiente información:

MensajeSMS

Ruta XML \faxmakerdata\fields\bodyfile



Detalles Usa el contenido del archivo comomensaje SMS.Escriba la ruta de acceso completa del archivo.Especifique el tipo de archivo:

type="text/html": el texto del cuerpo del mensaje está en formato HTML.

type="text/rtf": el texto del cuerpo del mensaje está en formato RTF.

type="text/plain": el texto del cuerpo del mensaje no tiene formato.

Si no se especifican atributos del tipo de archivo, el mensaje se procesa como texto sinformato.

Ejemplo <bodyfile type="text/plain">c:\temp\bodyfile.txt</bodyfile>

Líneade SMS

Ruta XML \faxmakerdata\fields\gsmline

Tipo Número (puerto COM) o cadena (nombre configurado para la línea GSM)


Detalles Solicite que se envíe un SMS por una línea GSM concreta. Especifique el nombre o el númerodel puerto COM tal como aparece configurado en GFI FaxMaker.Utilice el parámetro demandline para especificar cómo enviar el SMS si la línea especificadaestá ocupada o no existe. Utilice demandline=”true” para enviar el SMS exclusivamentedesde la línea GSM especificada. Utilice demandline para enviar el SMS desde la siguientelínea GSM disponible si la línea especificada está ocupada o no existe.

Ejemplo <gsmline demandline="true">3</gsmline>

o bien

<gsmline demandline="false">MiLíneaGSM</gsmline>

3.5.2 Campos del remitente

En el contenedor <sender>, especifique la información de remitente siguiente:

Nombre Ruta XML \faxmakerdata\sender\firstname

Tipo Cadena


Detalles Establece el nombre del remitente.

Ejemplo <firstname>John</firstname>

Tabla 9: Campos y parámetros de remitente

Apellidos Ruta XML \faxmakerdata\sender\lastname

Tipo Cadena


Detalles Establece los apellidos del remitente.

Ejemplo <lastname>Smith</lastname>

Empresa Ruta XML \faxmakerdata\sender\company

Tipo Cadena


Detalles Establece el nombre de empresa del remitente.

Ejemplo <company>MiNombre de empresa</company>

Departamento Ruta XML \faxmakerdata\sender\department

Tipo Cadena


Detalles Establece el departamento del remitente.

Ejemplo <department>Ventas</department>

Número de teléfono Ruta XML \faxmakerdata\sender\voicenumber

Tipo Cadena


Detalles Establece el número de voz (teléfono) del remitente.


Dirección de correo electrónico Ruta XML \faxmakerdata\sender\emailaddress

Tipo Cadena


Detalles Establece la dirección de correo electrónico del remitente.


3.5.3 Campos de destinatario de SMS

En el contenedor <recipient>, especifique la información de destinatario. Para SMS, agregue uncontenedor <sms> y un contenedor <recipient>.

Por ejemplo:

<recipients>

<sms>

<recipient>

<smsnumber>+1 800 1234 5678</smsnumber>

</recipient>

</sms>

</recipients>

NOTA

Un SMS también se puede enviar a varios destinatarios. Para obtener más información,consulte Envío de un SMS a varios destinatarios (página 24).

Inserte otros parámetros y campos en el contenedor <recipient> de la siguiente forma:

Nombre Ruta XML \faxmakerdata\recipients\sms\recipient\firstname

Tipo Cadena


Detalles Establece el nombre del destinatario.

Ejemplo <firstname>Joe</firstname>

Apellidos Ruta XML \faxmakerdata\recipients\sms\recipient\lastname

Tipo Cadena


Detalles Establece los apellidos del destinatario.

Ejemplo <lastname>Bloggs</lastname>

Empresa Ruta XML \faxmakerdata\recipients\sms\recipient\company

Tipo Cadena


Detalles Establece el nombre de la empresa del destinatario.

Ejemplo <company>Empresa de DestinatarioSMS SL</company>

Departamento Ruta XML \faxmakerdata\recipients\sms\recipient\department

Tipo Cadena


Detalles Establece el departamento del destinatario.

Ejemplo <department>Marketing</department>

Número de SMS Ruta XML \faxmakerdata\recipients\sms\recipient\smsnumber

Tipo Cadena


Detalles Establece el número de SMS del destinatario.

Ejemplo <smsnumber>+1(800)8765 4321</smsnumber>

Número de mensajeríade voz

Ruta XML \faxmakerdata\recipients\sms\recipient\voicenumber

Tipo Cadena


Detalles Establece el número de teléfono (voz) del destinatario.


Dirección de correo elec-trónico

Ruta XML \faxmakerdata\recipients\sms\recipient\emailaddress

Tipo Cadena


Detalles Establece la dirección de correo electrónico del destinatario.


Tabla 10: Campos y parámetros de destinatario de SMS

Envío de un SMS a varios destinatarios

Un SMS se puede enviar a varios destinatarios. Para ello, incluya varioscontenedores <recipient>...</recipient>. Por ejemplo:

<recipients>

<sms>

<recipient>



</recipient>

<recipient>

<firstname>Bob</firstname>


</recipient>

</sms>

</recipients>

3.5.4 XMLAPI de SMS de ejemplo

NOTA

Para este ejemplo, se utiliza otro archivo. El archivo bodyfile.txtalmacenado enc:\temp\ contiene el textos del mensaje SMS.

Este archivo se eliminará de c:\temp\ cuando GFI FaxMaker recupera el SMS.


<faxmakerdata>

<fields>


</fields>

<sender>


</sender>

<recipients>

<sms>

<recipient>


</recipient>

</sms>

</recipients>

</faxmakerdata>

4 API de servicios web

La API de servicios web de GFI FaxMaker le permite desarrollar sus propias aplicaciones que puedenconectarse con GFI FaxMaker.

NOTA

Este tema está dirigido a usuarios que conocen las tecnologías Visual Studio, Serviciosweb XML y SOAP.

4.1 Requisitos y notas importantes 26

4.2 Introducción 26

4.3 Funciones de API 27

4.4 Clases 29

4.5 Enums 31

4.6 Administración de la cola de la API de servicios web 32

4.1 Requisitos y notas importantes

Para crear la API, utilice un entorno de desarrollo compatible con Servicios web XML y SOAP.

Acceda al servicio web de GFI FaxMaker desde los Servicios web XML a través del puerto HTTPS8555 usando la dirección URL:http://<GFI FaxMaker Servidor>:8555/faxmaker/wsapiReemplace <GFI FaxMaker Servidor> por el nombre o la dirección IP del servidor de GFIFaxMaker. Por ejemplo: http://192.168.1.1:8555/faxmaker/wsapi.

También puede utilizar una conexión segura por HTTPS puerto 8556. Por ejemplo, http-s://192.168.1.1:8556/faxmaker/wsapi. Para utilizar una conexión segura, vincule un cer-tificado a la dirección IP y al puerto 8556. Para obtener más información, consultehttp://go.gfi.com/?pageid=HowToSSL.

Desde el nodo Usuarios con licencia, registre los usuarios que usarán la API de servicios web. Uti-lice esas credenciales de los usuarios para las llamadas de API.

Los faxes recibidos que se enrutan a los usuarios registrados para usar la API de servicios web sealmacenan en la cola de la API de servicios web y no se reenvían al usuario por correo electrónico.Configure las reglas de enrutamiento para enrutar los faxes que debe recoger la API de servicios webpara los usuarios registrados.

GFI FaxMaker conserva los faxes recibidos en la cola de la API de servicios web durante 30 días. LaAPI de servicios web no puede recuperar los faxes expirados. Para obtener más información, consulteAdministración de la cola de la API de servicios web (página 32).

4.2 Introducción

1. En Visual Studio, cree una aplicación C# Windows o de consola.

http://go.gfi.com/?pageid=HowToSSL

2. En Explorador de soluciones, haga clic con el botón secundario en Referencia y haga clic en Agre-gar referencia web.

3. Inserte la Dirección URL del servicio web (enlace WSDL) y haga clic en Ir.

4. Para crear las clases necesarias, haga clic en Agregar referencia.

5. En su código, agregue una referencia al espacio de nombres creado por Visual Studio.

6. Use las clases de espacio de nombres siguientes como clases típicas de C#.

4.3 Funciones de API

4.3.1 SendFax

Use esta función para enviar un fax. Esta función devuelve una matriz de FaxJobID. Para cadadestinatario especificado, se crea una FaxJobID. Esa ID permite supervisar el estado de ese faxenviado a ese destinatario concreto.

FMResult SendFax

(

FMUser user,

UserDetails senderdetails,

List<UserDetails> recipients,

MessageDetails messagedetails,

out FaxJobID[] faxjobids

);

Parámetros:

Parámetro Descripciónuser Credenciales de usuario de la API web.

senderdetails Detalles del usuario.

recipients[] Lista de destinatarios del fax.

messagedetails El fax que se enviará.

Valores devueltos:

Parámetro DescripciónFMResult Devuelve el resultado de la función.

Faxjobids Una matriz de faxjobid. Por cada destinatario hay un id. de tarea. Ese id. de tarea se puede usar másadelante para conocer el estado de un fax concreto.

4.3.2 CheckForUnreadFaxes

Utilice esta función para obtener una lista de los faxes en cola. Esta cola contiene todos los faxes queno se han descargado anteriormente.

Cada elemento de esta lista contiene únicamente los detalles de ese fax; no incluye una imagen delfax real. Para descargar el fax, utilice GetNextFax().

FMResult CheckForUnreadFaxes

(

FMUser user,

out ReceivedFaxDetails[] receivedfaxes

);

Parámetros:


Valores devueltos:


receivedfaxes Una matriz de ReceivedFaxDetails.

4.3.3 GetNextFax

Use este método para obtener el fax más antiguo de la cola. Esta cola contiene todos los faxes que nose han descargado anteriormente.

Al obtener el fax más antiguo, no se elimina automáticamente de la cola. Para eliminar el fax másantiguo de la cola, use DeleteFax(), que además le permite obtener el fax siguiente. Si no seelimina el fax más antiguo, recibirá el mismo fax de nuevo.

FMResult GetNextFax

(

FMUser user,

out ReceivedFaxDetails faxdetails,

out FileData fax

);

Parámetros:


Valores devueltos:


faxdetails ReceivedFaxDetails conservará los detalles del fax.

fax La imagen del fax.

4.3.4 GetNextFaxByCriteria

Use este método para obtener el fax más antiguo de la cola según los criterios especificados. Estacola contiene todos los faxes que no se han descargado anteriormente.

Al obtener el fax más antiguo, no se elimina automáticamente de la cola. Para eliminar el fax másantiguo de la cola, use DeleteFax(), que además le permite obtener el fax siguiente. Si no seelimina el fax más antiguo, recibirá el mismo fax de nuevo.

FMResult GetNextFaxByCriteria

(

FMUser user,

SearchCriteria criteria,

stringcriteriavalue,

out ReceivedFaxDetails faxdetails,

out FileData fax

);

Parámetros:


Criteria DTMB o Id. remoto.

Criteriavalue El valor de los criterios.

Valores devueltos:


faxdetails ReceivedFaxDetails conservará los detalles del fax.

Fax FileData contiene los datos de la imagen del fax real.

4.3.5 DeleteFax

Use esta función para eliminar un fax concreto.

FMResult DeleteFax

(

FMUser user,

int FaxID

);

Parámetros:


FaxID El id. del fax que se eliminará. Este valor puede recuperarse de la salida de CheckForUnreadFaxes(),GetNextFax() o GetNextFaxByCriteria().

Valores devueltos:


4.4 Clases

4.4.1 UserDetails

Esta clase contiene los detalles de un destinatario/remitente.

Todos campos son opcionales, excepto la propiedad Faxnumber si se usa como destinatario.

Miembros de datos Tipo DescripciónFirstname Cadena El nombre de pila.

Lastname Cadena Los apellidos.

Company Cadena Nombre de la compañía

Department Cadena Nombre del departamento

Faxnumber Cadena El número de fax.

Email Cadena La dirección de correo electrónico.

4.4.2 MessageDetails

Un objeto de esta clase contiene los detalles de un fax nuevo.

Todos campos son opcionales, excepto Billingcode si está habilitada la opción Facturación.

Miembros de datos Tipo DescripciónSubject Cadena El asunto del fax.

Schedule DateTime La fecha y la hora específicas en que se enviará el fax.

Priority FaxPriority Establece la prioridad del fax.

BillingCode Cadena Especifica el código de facturación. Necesario cuando Facturación estáhabilitado.

Resolution FaxResolution La resolución que se usará.

Coverpage Cadena De forma predeterminada, el fax se envía utilizando la portada predeterminadaconfigurada en GFI FaxMaker. Utilice este parámetro para enviar un fax uti-lizando una carátula concreta.

FrontCoverNote Cadena De forma predeterminada, el fax se envía utilizando la nota de portada pre-determinada configurada en GFI FaxMaker. Utilice este parámetro para enviar unfax utilizando una nota de carátula delantera concreta.

FaxLine Númeroentero.

Utilice este parámetro para solicitar que el fax se envíe en una línea de fax con-creta. Especifique el número de línea de fax según lo establecido en la con-figuración de GFI FaxMaker.

Demandline Booleano. Al especificar una línea de fax concreta (atributo FaxLine), si la línea está ocu-pada o no está disponible, el fax se enviará por otra línea. Para enviar el faxexclusivamente desde una línea concreta, establezca el valor de este atributocomo true.

header Cadena Introduzca un encabezado personal personalizado, que se agregará al enca-bezado de fax al principio del fax.

UniqueID Cadena Especifica un identificador que se usa para marcar el mensaje. El carácter únicode este identificador depende del creador del mensaje.

TextAPI Cadena Especifica una sola línea de comandos de TextAPI.Para obtener una lista de los comandos de TextAPI, consulte Comandos deTextAPI.

MessageBodyFile. FileData Una instancia de FileData con un archivo de texto que contiene el cuerpo delmensaje del fax.

Attachments List<FileData> Matriz de archivos adjuntos.

4.4.3 FMUser

Un usuario de la API web.

Miembrosde datos

Tipo Descripción

Email Cadena La dirección de correo electrónico del usuario, según aparece configurada en el nodo Usuarioscon licencia de la configuración de GFI FaxMaker. El usuario debe ser un usuario de API webregistrado.

Miembrosde datos

Tipo Descripción

Password Cadena En Active Directory, es la contraseña configurada del usuario.En entornos SMTP, la contraseña es una GUID generada automáticamente que está disponible enel nodo Usuarios con licencia de la configuración de GFI FaxMaker para los usuarios de API webregistrados.

4.4.4 FaxJobID

GFI FaxMaker asigna un identificador único a cada destinatario de un fax saliente. Use eseidentificador para supervisar el estado de los faxes.

Miembros de datos Tipo DescripciónRecipient Cadena El número de fax del destinatario

ID Cadena El identificador único asignado por GFI FaxMaker.

4.4.5 ReceivedFaxDetails

Se recibe un objeto de esta clase cuando se utiliza GetNextFax().

Miembros de datos Tipo DescripciónFaxUID Cadena El identificador único del fax. Utilice este identificador al eliminar un fax.

WhenReceived DateTime Fecha y hora en que se ha recibido el fax.

NosPages Cadena Número de páginas recibidas.

Resolution FaxResolution La resolución del fax recibido.

RemoteID Cadena El nombre del equipo de fax del remitente.

DTMF_DID Cadena El número de extensión DTMF/DID de la línea del destinatario.

4.4.6 FileData

Un objeto de esta clase contiene los datos reales de un archivo.

Miembros dedatos

Tipo Descripción

Filename Cadena El nombre de archivo del archivo; usado principalmente para determinar el formato delarchivo.

Data Byte[] Los datos del archivo en una matriz de bytes.

4.5 Enums

4.5.1 FaxPriority

Valor DescripciónNone No se ha especificado ninguna prioridad.

Low Prioridad baja.

Normal Prioridad normal.

High Prioridad alta.

VeryHigh Prioridad muy alta.

4.5.2 FaxResolution

Valor DescripciónNonSet No se ha especificado ninguna resolución de fax personalizada.

High Resolución alta.

Normal Resolución de fax normal.

4.5.3 SearchCriteria

Valor DescripciónRemoteID Buscar faxes por id. de remitente o por nombre de equipo de fax.

DTMF Buscar faxes por el número de extensión de la línea del destinatario.

4.5.4 FMResult

Valor DescripciónSuccess La función ha finalizado correctamente.

Failure Se ha producido un error en la función.

UserNotValid Los detalles del usuario no son válidos.

DBError Error al escribir o leer en la base de datos.

FaxImageNotFound No se ha encontrado la imagen de fax necesaria.

NoSender No se ha especificado ningún remitente o el remitente especificado no es válido.

NoRecipients No se ha especificado ningún destinatario o el destinatario especificado no es válido.

InvalidFaxDescription Uno o más campos obligatorios se han dejado en blanco.

4.6 Administración de la cola de la API de servicios web

Cuando un fax se enruta a un usuario registrado de la API de servicios web, GFI FaxMaker almacena elfax en la cola de la API de servicios web.

Utilice las diversas funciones documentadas en API de servicios web para obtener faxes de la cola. Alobtener un fax, no se elimina automáticamente de la cola. Para eliminarlo, utilice DeleteFax().

4.6.1 Faxes expirados en cola

Los faxes recibidos se almacenan en la cola de la API de servicios web durante 30 días. Si los faxespermanecen en ella más de 30 días, se quitan automáticamente de la cola y la API de servicios web nopuede recuperarlos.

De forma predeterminada, los faxes expirados se mueven a la carpeta siguiente:

<GFI FaxMaker carpeta de instalación>/WSAPI/Retention/

Por cada fax expirado que se mueve a esta carpeta, GFI FaxMaker almacena la imagen del fax enformato .fax (se puede abrir con un visor de imágenes) y un archivo XML que contiene los metadatosdel fax.

Para cambiar la carpeta predeterminada:

1. Detenga todos los servicios de GFI FaxMaker.

2. Vaya hasta la carpeta de instalación de GFI FaxMaker.

3. Abra el archivo ML.Svc.Attendant.exe.config en un editor de texto.

4. Busque la clave RetentionFolder y cambie su valor por la ruta nueva.

5. Inicie los servicios detenidos en el paso 1.

NOTA

Tenga cuidado al cambiar los archivos de instalación del software. Los errores deconfiguración pueden provocar problemas en la funcionalidad del producto.

5 Solución de problemas y soporte técnico

5.1 Introducción

En este tema se explica cómo resolver los problemas que puedan surgir durante la instalación de GFIFaxMaker. Las principales fuentes de información disponibles para solucionar estos problemas son:

Este manual (la mayoría de los problemas se pueden solucionar con la información de este sistemade ayuda).

Artículos de la Base de conocimientos de GFI

Foro en la red

Contacto con el Centro de soporte de GFI

5.2 Base de conocimientos

GFI mantiene un exhaustivo repositorio de su Base de conocimientos, que incluye respuestas a losproblemas de instalación más habituales. Si la información de esta manual no soluciona los problemasde instalación, consulte la Base de conocimientos. La Base de conocimientos tiene siempre la listamás actualizada de preguntas y revisiones de soporte técnico. Para acceder a la Base deconocimientos diríjase a: http://kb.gfi.com/.

5.3 Foro en la red

El soporte técnico de usuario a usuario está disponible a través del foro en la red de GFI. Paraacceder al foro en la red, diríjase a: http://forums.gfi.com/.

5.4 Solicitar soporte técnico

Si ninguno de los recursos especificados anteriormente le permite solucionar los problemas, póngaseen contacto con el equipo de Soporte técnico de GFI rellenando un formulario de solicitud de soportetécnico en línea, o bien de forma telefónica.

En línea: cumplimente el formulario de solicitud de soporte técnico y siga las instrucciones de estapágina para enviar dicha solicitud: http://support.gfi.com/supportrequestform.asp.

Teléfono: para obtener el número telefónico correcto del Centro de soporte de su área geo-gráfica, visite: http://www.gfi.com/company/contact.htm.

NOTA

Antes de ponerse en contacto con el Centro de soporte técnico, tenga su identificaciónde cliente a mano. Su identificación de cliente es el número de cuenta en línea que se leasigna cuando registra las claves de su licencia en el área del cliente de GFI en:http://customers.gfi.com.

Le responderemos en 24 horas, o antes, en función de su huso horario.

5.5 Documentación

Si este manual no cumple sus expectativas o si cree que esta documentación se puede mejorar,indíquenoslo enviando un correo electrónico a: [email protected].

http://kb.gfi.com/

http://forums.gfi.com/

http://support.gfi.com/supportrequestform.asp

http://www.gfi.com/company/contact.htm

http://customers.gfi.com/

mailto:[email protected]

EE.UU., CANADÁ, AMÉRICA CENTRAL Y AMÉRICA DEL SUR

15300 Weston Parkway, Suite 104, Cary, NC 27513, EE.UU.

Teléfono: +1 (888) 243-4329

Fax: +1 (919) 379-3402

[email protected]

REINO UNIDO Y REPÚBLICA DE IRLANDA

Magna House, 18-32 London Road, Staines-upon-Thames, Middlesex, TW18 4BP, REINO UNIDO

Teléfono: +44 (0) 870 770 5370

Fax: +44 (0) 870 770 5377

[email protected]

EUROPA, ORIENTE MEDIO Y ÁFRICA

GFI House, San Andrea Street, San Gwann, SGN 1612, Malta

Teléfono: +356 2205 2000

Fax: +356 2138 2419

[email protected]

AUSTRALIA Y NUEVA ZELANDA

83 King William Road, Unley 5061, South Australia

Teléfono: +61 8 8273 3000

Fax: +61 8 8273 3099

[email protected]





ManualAPI ... · Lainformaciónycontenidodeestedocumentoseproporcionasóloparafinesinformativosyse...

Documents

Transcript of ManualAPI ... · Lainformaciónycontenidodeestedocumentoseproporcionasóloparafinesinformativosyse...