To send a fax using the API, you first need to upload your required files, followed by the preparing those files for faxing and scheduling their transmission.
Once your fax is scheduled, you can implement an HTTP server and leverage a webhook mechanism. Este enfoque asegura que un mensaje HTTP sea enviado tanto en caso de una transmisión exitosa de fax como en caso de un fallo de transmisión.
Note: Make sure that you have completed the initial authentication process, and successfully logged in to the 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 las siguientes cabeceras en su petición:
-
- Tipo de contenido:
datos de múltiples partes/formularios
- Tipo de contenido:
-
- Autorización:
Portador [token de acceso]
- Autorización:
-
- x-fax-clientid:
[ID del cliente]
- x-fax-clientid:
Para el cuerpo:
{
"fax_file": [file]
}
En el siguiente ejemplo, "self" se utiliza como el ID de usuario para representar la identificación única del usuario actualmente registrado:
Una vez que el archivo se ha subido con éxito, recibirá una ruta que llevará a la ubicación temporal del archivo en el archivo .Plus.
Una vez completadas las subidas, puedes comenzar a preparar tu fax para enviar. Para iniciar el proceso, realice una solicitud POST HTTP a la siguiente URL:
https://restapi.fax. lus/v3/accounts/[user ID]/outbox
Asegúrese de incluir los siguientes encabezados en su solicitud:
-
- Autorización:
Portador [token de acceso]
- x-fax-clientid:
[ID del cliente]
- Autorización:
Para el cuerpo de la solicitud:
{
"from": "",
"to": [
""
],
"files": [
""
],
"comentario": {
"text": ""
},
"send_time": "",
}
Una vez programado el fax, se le proporcionará un ID de la caja de salida. Este ID se puede utilizar para realizar modificaciones o eliminar el fax antes de que sea enviado realmente.
Note: Faxes are associated with multiple IDs with our API. Este diseño está en su lugar porque la transmisión de fax funciona de forma asincrónica. Específicamente, un fax saliente será identificado por dos IDs distintos: ID de salida, que cumple su propósito hasta que el fax sea enviado con éxito, y fax ID, que se convierte en el identificador definitivo para el fax una vez que se ha transmitido con éxito.
After scheduling the fax, you can monitor its status by reviewing the list of faxes located in the outbox or the sent category.
Alternativamente, tiene la opción de establecer un servidor HTTP y usar un webhook. Esto activará un mensaje HTTP que se enviará cuando el fax se envíe correctamente o si hay un fallo en el envío.
Sigue estos pasos para configurar el Webhook:
- Inicia sesión en tu cuenta .Plus , y ve a la sección Perfilen tu panel de control.
- Debajo de la pestaña Integraciones, encuentra la caja para Hooks Web.
- Encuentra Entradas y Entradas. Haga clic en Administrar para modificar el Webhook.
Una vez que haya configurado el Webhook, recibirá la siguiente notificación una vez que se haya procesado un fax saliente:
{
"hook": {
"id": "",
"event": "fax_sent",
"event_time": "2022-12-09 15:50:00",
"target": "http://www.example. om/callback/fax_sent"
},
"data": {
"id": "",
"pages": 1,
"from": "",
"to": "",
"start_time": "2022-12-09 15:50:00",
"file": "",
"file_name": "fax-from-1xxxxxxxxxxx",
"cost": 1,
"status": "success"
}
}
Este mensaje le proporcionará el tiempo de transmisión, indica el éxito de la transmisión de fax (a través del campo "status") y le proporciona el único fax ID. This fax ID can be utilized to retrieve the fax file or obtain a fax confirmation report.