Bulk Mail Éxito

POST

El evento bulk.email.parsing.success se envía al analizar correctamente Email to SMS Bulk correo electrónico.

Notificaciones de webhook

Authorizations

• token

Request Body ^required

Media type application/json

object

id

UUID único de entidad

string

/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/

api_version

Versión de la estructura de datos de notificación

string

name

Nombre del evento de Webhook

string

created_at

Fecha en la que se añadió la entidad al sistema por el usuario

integer

attempt_total

Número total de intentos de entrega de webhooks de notificación

integer

>= 1 <= 4

attempt_number

Número de intento de notificación webhook actual

integer

>= 1

notification_task_id

Notification task identifier (request identifier)

string format: uuid

name

Allowed values: bulk.email.parsing.success

data

Data for bulk.email.parsing.success events

object

bulk

SMS Bulk response object

object

id

UUID único de entidad

string

/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/

status

Estados del Bulk:

• 0 - nuevo y no procesado
• 5 - bulks en progreso
• 10 - bulks fueron pocesados exitosamente
• 15 - bulk el tratamiento fue cancelado por el usuario
• 20 - Error de sistema
• 201 - error: no se han encontrado destinatarios

integer

Allowed values: 0 5 10 15 20 201

created_at

Fecha en la que se añadió la entidad al sistema por el usuario

integer

email

Email object for bulk email events

object

id

Email identifier

string

from

Sender email address

string format: email

to

Destination email address

string format: email

subject

Email subject line

string

body

Email body content

string

Examples

Example success

Evento de Éxito en Análisis de Email Masivo

Evento enviado cuando el email masivo se analiza exitosamente

{
  "id": "d6ff9b42-1da5-711f-df20-f0173a4e7df1",
  "api_version": "2022-05-25",
  "name": "bulk.email.parsing.success",
  "created_at": 1653378803,
  "attempt_total": 1,
  "attempt_number": 1,
  "data": {
    "bulk": {
      "id": "f8a34ce6-ee9f-33ae-d8fc-747622ddd9fe",
      "status": 10,
      "created_at": 1653378803
    },
    "email": {
      "id": "email-123",
      "from": "sender@example.com",
      "to": "bulk@your-domain.com",
      "subject": "SMS Bulk Request",
      "body": "Message content here"
    }
  },
  "notification_task_id": "5590fa05-fb88-6fc0-bf3b-4d32f63dd863"
}

Responses

200

Webhook recibido

400

Estructura del cuerpo de la solicitud de webhook no válida

401

Solicitud de webhook no autorizada

403

Acceso Webhook prohibido

404

No se ha encontrado el punto final del webhook

500

Error del servidor