Para enviar un fax mediante la API, primero debe subir los archivos necesarios y, a continuación, preparar esos archivos para el envío por fax y programar su transmisión.
Una vez programado el fax, puede implementar un servidor HTTP y aprovechar un mecanismo de webhook. Este enfoque garantiza que se envíe un mensaje HTTP tanto en caso de transmisión exitosa del fax como en caso de fallo en la transmisión.
Nota: Asegúrese de haber completado el proceso de autenticación inicial y haber iniciado sesión correctamente en la API. Para obtener instrucciones adicionales, consulte nuestra guía aquí.
Para subir un archivo, inicie una solicitud HTTP POST a la siguiente URL: https://restapi.fax.plus/v3/accounts/[user ID]/files?format=[file format, 'pdf' or 'tiff']
Asegúrese de incluir los siguientes encabezados en su solicitud:
-
- Content-Type:
multipart/form-data
- Content-Type:
-
- Authorization:
Bearer [access token]
- Authorization:
-
- x-fax-clientid:
[client ID]
- x-fax-clientid:
Para el cuerpo de la solicitud:
{
"fax_file": [file]
}
En el siguiente ejemplo, se utiliza "self" como el ID de usuario para representar la identificación única del usuario actualmente conectado:
Una vez que el archivo se haya subido correctamente, recibirá una ruta que lleva a la ubicación temporal del archivo en Fax.Plus.
Una vez completadas las cargas, puede comenzar a preparar su fax para el envío. Para iniciar el proceso, realice una solicitud HTTP POST a la siguiente URL:
https://restapi.fax.plus/v3/accounts/[user ID]/outbox
Asegúrese de incluir los siguientes encabezados en su solicitud:
-
- Authorization:
Bearer [access token]
- x-fax-clientid:
[client ID]
- Authorization:
Para el cuerpo de la solicitud:
{
"from": "",
"to": [
""
],
"files": [
""
],
"comment": {
"text": ""
},
"send_time": "",
}
Tras programar correctamente el fax, se le proporcionará un ID de bandeja de salida (Outbox ID). Este ID se puede utilizar para realizar modificaciones o eliminar el fax antes de que se envíe realmente.
Nota: Los faxes se asocian con varios ID en nuestra API. Este diseño existe porque la transmisión del fax funciona de forma asíncrona. Específicamente, un fax saliente se identificará mediante dos ID distintos: el ID de bandeja de salida (Outbox ID), que cumple su función hasta que el fax se envía correctamente, y el ID de fax (Fax ID), que se convierte en el identificador definitivo del fax una vez que se ha transmitido correctamente.
Después de programar el fax, puede supervisar su estado revisando la lista de faxes ubicada en la bandeja de salida o en la categoría de enviados.
Alternativamente, tiene la opción de establecer un servidor HTTP y usar un webhook. Esto activará el envío de un mensaje HTTP cuando el fax se envíe correctamente o si se produce un error en el envío.
Siga estos pasos para configurar el Webhook:
- Inicie sesión en su cuenta de Fax.Plus y vaya a la sección de Configuración en su panel de control.
- En la pestaña de Integraciones, busque el cuadro de WebHooks.
- Busque Faxes entrantes y Faxes entrantes. Haga clic en Gestionar para modificar el Webhook.
Una vez que haya configurado el Webhook, recibirá la siguiente notificación cuando se procese un fax saliente:
{
"hook": {
"id": "",
"event": "fax_sent",
"event_time": "2022-12-09 15:50:00",
"target": "http://www.example.com/callback/fax_sent"
},
"data": {
"id": "",
"pages": 1,
"from": "",
"to": "",
"start_time": "2022-12-09 15:50:00",
"file": "",
"file_name": "fax-from-1xxxxxxxxxxxx",
"cost": 1,
"status": "success"
}
}
Este mensaje le proporcionará la hora de transmisión, indicará el éxito de la transmisión del fax (a través del campo "status") y le facilitará el ID de fax único. Este ID de fax se puede utilizar para recuperar el archivo del fax u obtener un informe de confirmación del fax.