SMS Email Parsing Success

POST

Triggered when Email to SMS email is successfully parsed

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

Version of the notification webhook data structure

string

name

Webhook’s event name

string

created_at

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

integer

attempt_total

Total number of notification webhook delivery attempts

integer

>= 1 <= 4

attempt_number

Current webhook notification attempt number

integer

>= 1

data

Event-specific data payload

object

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

Unique entity UUID

string

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

to

Recipient (international) number:

• +491701234567 (E.164)
• 00491701234567
• 491701234567
• 01701234567 (if the account is registered in Germany) will be convert to +491701234567

If the number is not in an E.164 format then the service will convert it based on user’s address. To avoid problems with the converting please use E.164 preferentially.

string

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

text

The message text can have a length of up to 1530 characters. With a Unicode SMS, the maximum character length is reduced to 670 characters. Internal encoding is 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 received

400

Invalid webhook request’s body structure

401

Webhook request unauthorized

403

Webhook access forbidden

404

Webhook access forbidden

500

Server error