APIs de Be Aware Outbound

En construcción

En construcción

Este recurso permite consultar los mensajes asociados a una notificación enviada <notificationid> a la cola de envío de Be Aware 360 Outbound, obteniendo información sobre el proveedor de envío, la fecha del mensaje, su identificador y el estado del envío.

GET

https://api-outbound.beaware360.com/api/outbound/v2/send/queue/messagesBySenderId/<notificationid>

Parámetros:

notificationid -> Identificador único del envío para el cual se desea consultar estado.

Campos:

No requiere enviar campos.

Autenticación:

Este recurso requiere que se envíe en los Headers los parámetros relacionados en Configuración Headers para todos los recursos de la API de Be Aware 360.

Ejemplo:

https://api-outbound.beaware360.com/api/outbound/v2/send/queue/messagesBySenderId/7ugdffd8-6g43-675e-bber-5a18a3fd7895

Retorna la información de una notificación específica, según su notificationid.

Ejemplo:

{
    "pagina": 0,
    "total": 1,
    "Estado": [
        {
            "sender": "AMAZON SES",
            "fechaHora": "2024-07-05T18:40:37-05:00",
            "messageId": "84563sa1-23b8-4343-9605-02a452sdc869",
            "proximoEnvio": "2024-07-05T15:10:25",
            "status": "SENT"
        }
    ]
}

Este recurso permite consultar los mensajes que han sido rechazados durante el proceso de envío a través de Be Aware 360 Outbound, utilizando el identificador de la notificación (NotificationID).

GET

https://api-outbound.beaware360.com/api/outbound/v2/send/queue/errorMessagesBySenderId/<notificationid>

Parámetros:

notificationid -> Identificador único del envío para el cual se desea consultar estado.

Campos:

No requiere enviar campos.

Autenticación:

Este recurso requiere que se envíe en los Headers los parámetros relacionados en Configuración Headers para todos los recursos de la API de Be Aware 360.

Ejemplo:

https://api-outbound.beaware360.com/api/outbound/v2/send/queue/errorMessagesBySenderId/7ugdffd8-6g43-675e-bber-5a18a3fd7895

El sistema retorna la información de los mensajes rechazados asociados al notificationid enviado en la solicitud.

Ejemplo:

{
    "pagina": 0,
    "total": 1,
    "Messages": [
        {
            "fechaHora": "2025-04-17T06:04:41-05:00",
            "messageId": "2c7dff77-w789-4973-914e-a28e34d0789a",
            "messageError": "Quota for channel SMS not found",
            "status": "REJECTED"
        }
    ]
}