Campos y parámetros de fax
Lista de campos y parámetros compatibles de XMLAPI para enviar faxes.
Consulte el XMLAPI de fax de ejemplo como referencia.
Campos de mensaje
En el contenedor <fields>
, especifique la siguiente información:
Asunto | Ruta de 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 de XML | \faxmakerdata\fields\schedule |
Tipo | Cadena | |
Disposición | Opcional | |
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:
|
|
Ejemplo |
<schedule>2018-10-10-08:15:00</schedule> |
|
Prioridad | Ruta de XML | \faxmakerdata\fields\priority |
Tipo | Cadena | |
Disposición | Opcional | |
Detalles |
Establezca la prioridad del mensaje. Los valores válidos son:
|
|
Ejemplo |
<priority>high</priority> |
|
Código de facturación | Ruta de XML | \faxmakerdata\fields\billingcode |
Tipo | Cadena | |
Disposición | Opcional. Necesario cuando la opción Facturación está habilitada. | |
Detalles | Establece el código de facturación del remitente del mensaje. | |
Ejemplo |
<billingcode>25</billingcode> |
|
Resolución | Ruta de XML | \faxmakerdata\fields\resolution |
Tipo | Cadena | |
Disposición | Opcional | |
Detalles |
Utilice este parámetro para especificar la resolución del fax. Los valores válidos son:
|
|
Ejemplo |
<resolution>high</resolution> |
|
Carátula | Ruta de XML | \faxmakerdata\fields\coverpage |
Tipo | Cadena | |
Disposición | Opcional | |
Detalles |
De forma predeterminada, el fax se envía utilizando la carátula predeterminada configurada en GFI FaxMaker. Utilice este parámetro para enviar un fax utilizando una carátula concreta. Escriba el nombre de la carátula que se va a usar, utilizando uno de los siguientes:
|
|
Ejemplo |
<coverpage>corporativo</coverpage> |
|
Nota de carátula delantera | Ruta de XML | \faxmakerdata\fields\frontcovernote |
Tipo | Cadena | |
Disposición | Opcional | |
Detalles |
De forma predeterminada, el fax se envía utilizando la nota de carátula delantera predeterminada configurada en GFI FaxMaker. Utilice este parámetro para enviar un fax utilizando una nota de carátula delantera concreta. Escriba el nombre de la nota de carátula delantera que se va a usar, utilizando uno de los siguientes:
|
|
Ejemplo |
<frontcovernote>membrete</frontcovernote> |
|
Línea de faxLínea telefónica física o línea basada en software (FoIP), conectada a un dispositivo de fax (módem o RDSI/tarjeta de fax). | Ruta de XML | \faxmakerdata\fields\faxline |
Tipo | Número | |
Disposición | Opcional | |
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 establecido en la 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 fax exclusivamente desde una línea concreta, utilice el siguiente atributo:
|
|
Ejemplo |
<faxline demandline="true">3</faxline> |
|
Encabezado | Ruta de XML | \faxmakerdata\fields\faxheader |
Tipo | Cadena | |
Disposición | Opcional | |
Detalles | Introduzca un encabezado personal personalizado, que se agregará al encabezado de fax al principio del fax. | |
Ejemplo |
<faxheader>Este es un encabezado del fax</faxheader> |
|
Id. único | Ruta de XML | \faxmakerdata\fields\uid |
Tipo | Cadena [máx. 255 caracteres] | |
Disposición | Opcional | |
Detalles | Especifique un identificador que se usa para marcar el mensaje. El carácter único de este identificador depende del creador del mensaje. El número máximo de caracteres es 255. | |
Ejemplo |
<uid>3a5a90s7de3g20k9y4d5e7e6fse28se5e097</uid> |
|
TextAPI | Ruta de XML | \faxmakerdata\fields\textapi |
Tipo | Cadena | |
Disposición | Opcional | |
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 de cuerpo del mensaje | Ruta de XML | \faxmakerdata\fields\bodyfile |
Tipo | Ruta completa o nombre de archivo | |
Disposición |
Opcional NOTA: Se necesita un archivo adjunto o un archivo de cuerpo de mensaje de fax. |
|
Detalles |
Utilice el contenido del archivo como cuerpo del mensaje en la carátula de fax. Especifique el archivo del cuerpo con el siguiente formato:
NOTA: Asegúrese de que los archivos del cuerpo se almacenan totalmente en la ubicación adecuada antes de almacenar los archivos XMLAPI en la carpeta de recogida. Si GFI FaxMaker no puede acceder al archivo del cuerpo del mensaje durante la recogida, el fax mostrará un error. Utilice el atributo tipo para especificar el tipo de archivo del cuerpo del mensaje. Use uno de los atributos siguientes:
Si no se especifica ningún atributo de tipo de archivo, el mensaje se introduce como texto sin formato. |
|
Ejemplo |
<bodyfile type="text/plain">c:\temp\bodyfile.txt</bodyfile> |
|
Adjunto | Ruta de XML | \faxmakerdata\fields\attachment |
Tipo | Ruta completa o nombre de archivo | |
Disposición |
Opcional (máximo de 60 archivos adjuntos) NOTA: Se necesita un archivo adjunto o un archivo de cuerpo de mensaje de fax. |
|
Detalles |
Agrega el contenido del archivo especificado al fax. Especifique el archivo del cuerpo con el siguiente formato:
NOTA: Asegúrese de que los archivos adjuntos se almacenan totalmente en la ubicación adecuada antes de almacenar los archivos XMLAPI en la carpeta de recogida. Si GFI FaxMaker no puede acceder a los archivos adjuntos durante la recogida, el fax mostrará un error. NOTA: Los archivos adjuntos se eliminan al recogerse. |
|
Ejemplo |
<attachment>c:\temp\document.doc</attachment> |
Campos del remitente
En el campo <remitente>
, especifique la información del remitente como se indica a continuación:
Nombre | Ruta de XML | \faxmakerdata\sender\firstname |
Tipo | Cadena | |
Disposición | Opcional | |
Detalles | Establece el nombre del remitente. | |
Ejemplo |
<firstname>John</firstname> |
|
Apellidos | Ruta de XML | \faxmakerdata\sender\lastname |
Tipo | Cadena | |
Disposición | Opcional | |
Detalles | Establece los apellidos del remitente. | |
Ejemplo |
<lastname>Smith</lastname> |
|
Empresa | Ruta de XML | \faxmakerdata\sender\company |
Tipo | Cadena | |
Disposición | Opcional | |
Detalles | Establece el nombre de empresa del remitente. | |
Ejemplo |
<company>MiNombre de empresa</company> |
|
Departamento | Ruta de XML | \faxmakerdata\sender\department |
Tipo | Cadena | |
Disposición | Opcional | |
Detalles | Establece el departamento del remitente. | |
Ejemplo |
<department>Ventas</department> |
|
Número de teléfono | Ruta de XML | \faxmakerdata\sender\voicenumber |
Tipo | Cadena | |
Disposición | Opcional | |
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 de XML | \faxmakerdata\sender\emailaddress |
Tipo | Cadena | |
Disposición | Obligatorio | |
Detalles | Establece la dirección de correo electrónico del remitente. | |
Ejemplo |
<emailaddress>jsmith@midominio.com</emailaddress> |
Campos de destinatario de fax
En el contenedor <recipient>
, especifique la siguiente información. En el caso de los faxes, agregue un contenedor <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.
Inserte otros parámetros y campos en el contenedor <recipient> del siguiente modo:
Nombre | Ruta de XML | \faxmakerdata\recipients\fax\recipient\firstname |
Tipo | Cadena | |
Disposición | Opcional | |
Detalles | Establece el nombre del destinatario. | |
Ejemplo |
<firstname>Joe</firstname> |
|
Apellidos | Ruta de XML | \faxmakerdata\recipients\fax\recipient\lastname |
Tipo | Cadena | |
Disposición | Opcional | |
Detalles | Establece los apellidos del destinatario. | |
Ejemplo |
<lastname>Bloggs</lastname> |
|
Empresa | Ruta de XML | \faxmakerdata\recipients\fax\recipient\company |
Tipo | Cadena | |
Disposición | Opcional | |
Detalles | Establece el nombre de la empresa del destinatario. | |
Ejemplo |
<company>Empresa de DestinatarioFax SL</company> |
|
Departamento | Ruta de XML | \faxmakerdata\recipients\fax\recipient\department |
Tipo | Cadena | |
Disposición | Opcional | |
Detalles | Establece el departamento del destinatario. | |
Ejemplo |
<department>Marketing</department> |
|
Número de fax | Ruta de XML | \faxmakerdata\recipients\fax\recipient\faxnumber |
Tipo | Cadena | |
Disposición | Obligatorio | |
Detalles | Establece el número de fax del destinatario. | |
Ejemplo |
<faxnumber>+1(800)8765 4321</faxnumber> |
|
Número de teléfono | Ruta de XML | \faxmakerdata\recipients\fax\recipient\voicenumber |
Tipo | Cadena | |
Disposición | Opcional | |
Detalles | Establece el número de teléfono (voz) del destinatario. | |
Ejemplo |
<voicenumber>+1(800)8765 4444</voicenumber> |
|
Dirección de correo electrónico | Ruta de XML | \faxmakerdata\recipients\fax\recipient\emailaddress |
Tipo | Cadena | |
Disposición | Opcional | |
Detalles | Establece la dirección de correo electrónico del destinatario. | |
Ejemplo |
<emailaddress>John@dominiodestinatariofax.com</emailaddress> |
Envío de un fax a varios destinatarios
Un fax se puede enviar a varios destinatarios. Para ello, incluya varios contenedores <recipient>...</recipient>
. Por ejemplo:
<recipients>
<fax>
<recipient>
<firstname>Bob</firstname>
<faxnumber>+1 800 1111 1111</faxnumber>
</recipient>
<recipient>
<firstname>John</firstname>
<faxnumber>+1 800 2222 2222</faxnumber>
</recipient>
</fax>
</recipients>