Configurar Dropbox Fax API

Este artículo explica cómo configurar Dropbox Fax API utilizando los puntos de conexión v1, cómo asegurarse de que funciona y cómo contratar más líneas de fax si es necesario.

Configurar Dropbox Fax API con los puntos finales v1

Para comenzar a usar los puntos finales v1:

1. Envía un correo a support@hellosign.com con la dirección de correo electrónico que quieres utilizar para tu cuenta de Dropbox Fax. Recibirás una respuesta una vez que se habilite el acceso a Dropbox Fax API. Descubre más sobre los precios de Dropbox Fax API.
2. Inicia sesión en tu cuenta de Dropbox Fax. Anota el GUID de tu cuenta, ya que lo necesitarás para la mayoría de las solicitudes de la API (o puntos finales).
3. Haz tu primera solicitud de API y obtén la información para la configuración de tu cuenta:

Un ejemplo de ello sería:

Otro ejemplo (recuerda codificar la URL):

La respuesta será una representación JSON de la configuración de tu cuenta.

4. Para agregar URL de devolución de llamadas a tus faxes entrantes y salientes con un POST:

5. Para revisar las líneas de fax disponibles:

La respuesta incluirá la FaxLine que elegiste cuando te registraste para una suscripción Premium.

6. Para contratar un número de fax, necesitamos comprobar qué prefijos están disponibles con un GET:

7. Puedes contratar un número de fax con uno de los prefijos disponibles en el paso 6:

8. Para enviar un fax:

Esto inicia el proceso de envío de fax. Recibir una respuesta HTTP 200 no garantiza que el fax se envíe, ya que puede producirse un error de conversión de archivo. No obstante, una vez que el StatusCode del fax sea E (error) o S (satisfactorio), recibirás un POST en la URL de devolución de llamadas que indicaste en el paso 4. Más información sobre las devoluciones de llamadas.

Posibles valores de StatusCode:

• T = transmitiendo/enviando.
• P = pendiente/convirtiendo.
• S = satisfactorio/enviado correctamente.
• E = error. No se pudo convertir o enviar por completo.
• H = en espera. Este error se produce si tienes una cuenta no confirmada o si te quedaste sin páginas de fax y no dispones de una suscripción mensual.

Posibles valores de ErrorCode (consultar solo cuando StatusCode es E):

• B = señal de ocupado.
• N = no hay respuesta.
• A = número no asignado (generalmente significa que se desconectó).
• D = la línea está desconectada o ilocalizable.
• L = el número está en la lista de números rechazados (no debería ocurrir con ningún número de EE. UU.).
• U = error desconocido. Suele ocurrir cuando una persona contesta o se produce un error durante la transmisión del fax.
  

Notas:

• Si envías un fax y la máquina del destinatario admite la lectura de la denominada identificación de suscriptor (CSID), el identificador de llamadas mostrará tu número de fax principal o el que especifiques en el parámetro “De”. Recuerda que tu número de fax principal aparecerá en el propio fax. Si tienes varias líneas de Dropbox Fax, puedes elegir cuál usar para enviar faxes incluyendo el parámetro “De” en la URL:

Para conocer el formato del valor “De”, consulta el campo “Número” que se obtiene al llamar a /FaxLines (consulta el paso 5).

• Puedes cargar varios archivos y enviar varios faxes en una sola llamada. Solo tienes que crear matrices para los parámetros “archivo” o “Para”:

o

• Puedes agregar una portada generada por Dropbox Fax especificando uno o más de los siguientes parámetros: CoverPageTo, CoverPageFrom y CoverPageMessage.
• Los faxes enviados por la API no se almacenan en nuestros servidores una vez que el fax se enviaron correctamente, sino que se quiten. Por lo tanto, no podrás consultarlos en la interfaz de usuario. Sin embargo, los faxes entrantes enviados correctamente mediante POST a tu sistema de devolución de llamada se almacenan en nuestros servidores y están disponibles para consultarlos en la pantalla Documentos.
• Hay un límite de 200 faxes pendientes por día. Si lo alcanzas, aparecerá un error 429:

¿Cómo comprobar los estados de los faxes?

1. Puedes encontrar el GUID de transmisión en la respuesta JSON que te haya devuelto la llamada a la API en el paso 8. Además, puedes comprobar el estado de todas tus transmisiones omitiendo el GUID de transmisión:

Estos resultados incluyen un número de página. Puedes obtener diferentes páginas especificando los parámetros de URL "Page" y "PageSize". Consulta los elementos de respuesta "FirstPageUri", "NextPageUri", "PreviousPageUri" y "LastPageUri" para descubrir cómo funciona la paginación.

2. Una vez que el código de estado del fax se establezca como S o E, comprueba que se haya activado la URL de devolución de llamadas para los faxes salientes. Deberías recibir un POST con un parámetro llamado “json” que incluya toda la información que obtendrías en la respuesta a una llamada (consulta el paso 1).

Si un problema de servidor o de red impide que se complete la devolución de la llamada POST, Dropbox volverá a intentarlo en estos intervalos:

• 15 minutos
• 45 minutos
• 1 hora y 30 minutos
• 2 horas y 45 minutos
• 4 horas
• 8 horas y 15 minutos
• 16 horas y 30 minutos

En cada intervalo, Dropbox puede intentar el POST varias veces si no se recibe un código de respuesta 200.

3. Si enviaste el fax a tu propio número de Dropbox Fax (una opción que te resultará útil para hacer pruebas), asegúrate de verificar que también esté activa la URL de devolución de llamadas para los faxes entrantes.
4. Indica las líneas de fax que contrataste:

5. Para eliminar una línea de fax, haz una llamada DELETE al URI de esa línea (lo encontrarás en la respuesta del paso anterior):

Si la operación se realiza correctamente, recibirás una respuesta 200.