Éxito en el análisis de correo SMS

POST

Se activa cuando el correo electrónico a SMS se analiza correctamente

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: sms.email.parsing.success

data

Data for sms.email.parsing.success events

object

sms

Array of SMS data from parsed email

Array<object>

object

uuid

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}$/

to

Número de destinatario (internacional):

• +491701234567 (E.164)
• 00491701234567
• 491701234567
• 01701234567 (si la cuenta está registrada en Alemania) se convertirá en +491701234567

Si el número no está en formato E.164, el servicio lo convertirá basándose en la dirección del usuario. Para evitar problemas con la conversión, utilice preferentemente E.164.

string

>= 4 characters <= 16 characters /^\+[1-9]\d{1,14}$/

text

El texto del mensaje puede tener una longitud de hasta 1530 caracteres. Con un SMS Unicode, la longitud máxima de caracteres se reduce a 670 caracteres. La codificación interna es UTF-8.

string

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

SMS Email Parsing Success Event

Event sent when email to SMS parsing is successful

{
  "id": "d6ff9b42-1da5-711f-df20-f0173a4e7df1",
  "api_version": "2022-05-25",
  "name": "sms.email.parsing.success",
  "created_at": 1653378803,
  "attempt_total": 1,
  "attempt_number": 1,
  "data": {
    "sms": [
      {
        "uuid": "f8a34ce6-ee9f-33ae-d8fc-747622ddd9fe",
        "to": "+4915123456789",
        "text": "Hello, this is your SMS message content parsed from email."
      }
    ],
    "email": {
      "id": "email-456",
      "from": "sender@example.com",
      "to": "sms@your-domain.com",
      "subject": "SMS Request",
      "body": "Send SMS to +4915123456789: Hello, this is your SMS message content parsed from email."
    }
  },
  "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