Incoming SMS

POST

The event ‘sms.incoming’ sends on an incoming/reply SMS (mobile originated - SMS-MO).

Webhook notifications

Authorizations

• token

Request Body ^required

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

Example

2022-05-25

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

Example

4

attempt_number

Current webhook notification attempt number

integer

>= 1

Example

1

data

Event-specific data payload

object

notification_task_id

Notification task identifier (request identifier)

string format: uuid

Example

3378de83-de66-4de8-9d29-2b10d41bb641

name

Allowed values: sms.incoming

data

Data for sms.incoming events

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

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

Example

+14155552671

from

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

Example

+14155552671

received_at

Timestamp when SMS was received by the service

integer

text

SMS text

string | null

msg_uuid

ID of SMS that get reply

string | null

Examples

SMS Incoming Event

Event sent when an incoming SMS is received

{
  "id": "d6ff9b42-1da5-711f-df20-f0173a4e7df1",
  "api_version": "2022-05-25",
  "name": "sms.incoming",
  "created_at": 1653378703,
  "attempt_total": 1,
  "attempt_number": 1,
  "data": {
    "id": "e7d23bd5-dd8e-22fd-c7eb-636511ccc8ed",
    "to": "+1234567890",
    "from": "+490987654321",
    "text": "Hello, this is a reply message",
    "received_at": 1653378703,
    "msg_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  "notification_task_id": "4489ef94-ef77-5ef9-ae2a-3c21e52cc752"
}

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