Bulk Email Parsing Success

POST

O evento bulk.email.parsing.success é enviado na análise bem-sucedida de um e-mail Email to SMS Bulk.

Notificações de webhook

Authorizations

• token

Request Body ^required

Media type application/json

object

id

Unique entity UUID

string

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

api_version

Versão da estrutura de dados do webhook de notificação

string

name

Nome do evento do Webhook

string

created_at

Timestamp when the entity was added to the system by the user

integer

attempt_total

Número total de tentativas de entrega de webhooks de notificação

integer

>= 1 <= 4

attempt_number

Número atual da tentativa de notificação do webhook

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

Unique entity UUID

string

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

status

Bulk’s status:

• 0 - new and not processed
• 5 - bulks in progress
• 10 - bulks was successfully processed
• 15 - bulk’s processing was canceled by the user
• 20 - system error
• 201 - error: no recipients found

integer

Allowed values: 0 5 10 15 20 201

created_at

Timestamp when the entity was added to the system by the user

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 Sucesso na Análise de Email em Massa

Evento enviado quando o email em massa é analisado com sucesso

{
  "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 recebido

400

Estrutura do corpo do pedido de webhook inválido

401

Pedido de webhook não autorizado

403

Acesso proibido ao webhook

404

Acesso proibido ao webhook

500

Erro do servidor