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 de 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
-
Authorization:
Bearer [access token]
-
x-fax-clientid:
[client ID]
Para el cuerpo:
{
"fax_file": [file]
}
En el siguiente ejemplo, "self" se utiliza como ID de usuario para representar el identificador único del usuario que ha iniciado sesión actualmente:
Una vez que el archivo se haya subido correctamente, recibirá una ruta que conduce a la ubicación temporal del archivo en Fax.Plus.
Una vez subidos los archivos, 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]
Para el cuerpo de la solicitud:
{
"from": "",
"to": [
""
],
"files": [
""
],
"comment": {
"text": ""
},
"send_time": "",
}
Una vez programado correctamente el fax, se le proporcionará un ID de bandeja de salida. Este ID puede utilizarse para modificar 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 se debe a que la transmisión de fax funciona de forma asíncrona. En concreto, un fax saliente se identificará mediante dos ID distintos: el ID de bandeja de salida, que sirve hasta que el fax se envía correctamente, y el ID de fax, que pasa a ser el identificador definitivo del fax una vez transmitido correctamente.
Tras programar el fax, puede supervisar su estado revisando la lista de faxes de la bandeja de salida o de la categoría de enviados.
Como alternativa, puede configurar 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 Configuración de su panel de control.
- En la pestaña Integraciones, busque el cuadro de WebHooks.
- Busque Faxes entrantes y Faxes entrantes. Haga clic en Gestionar para modificar el webhook.
Una vez configurado el webhook, recibirá la siguiente notificación cuando se haya procesado 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 indicará la hora de transmisión, el resultado de la transmisión del fax (mediante el campo "status") y el ID de fax único. Este ID de fax puede utilizarse para recuperar el archivo del fax o obtener un informe de confirmación del fax.