API de Hosted PBX: registros de fax y envío

Utilice HTTPS y autenticación básica HTTP con credenciales de API aprobadas. Mantenga las credenciales en su servidor de aplicaciones. Estos endpoints de Hosted PBX utilizan /hpbx/ en api.multitel.net; no inserte /v3. Compruebe tanto el resultado HTTP como el estado de la aplicación en la respuesta JSON.

Leer registros de fax

curl --request POST --user "USERNAME:PASSWORD" \
  "https://api.multitel.net/hpbx/fax/list/YOUR_BILLING_CODE"

Sustituya el código de facturación por el de su PBX. Los registros devueltos incluyen la hora del fax, el sentido de la comunicación, el origen, el destino, el estado de entrega, los intentos, los errores y el número de páginas. La entrega aún puede estar pendiente cuando se acepta una solicitud de envío.

Parámetros de envío

El punto final de envío es POST /hpbx/fax/send/{billing_code}. El envío ejecuta una operación real. Prepare el archivo y el destino autorizado por la cuenta antes de enviarlo; no reintente a ciegas un envío incierto.

CampoSignificado
numberNúmero de fax de destino.
cidnumIdentificador de llamada aprobado para el remitente.
scheduleHora de envío programada, cuando se utiliza.
faxquality / pagesize / pagerotateOpciones admitidas de calidad, tamaño de papel y rotación.
statusemailDirección autorizada para las notificaciones de entrega.
deleteaftersendSi debe eliminarse el archivo subido y almacenado después del envío.
filenameLa referencia de documento que espera este flujo de trabajo de fax; no es una ruta de archivo local arbitraria.

Seguimiento de la finalización

Después del envío, revise el estado, los intentos y el error del registro del fax. Confirme la entrega en lugar de interpretar la aceptación como entrega. La referencia de fax del portal documenta su flujo actual de carga y envío; sus rutas y su autenticación son independientes del endpoint anterior.

Buscar documentación