SMS entrantes

POST

El evento ‘sms.incoming’ se envía en un SMS entrante/repuesta (originado en móvil - SMS-MO).

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: sms.incoming

data

Data for sms.incoming events

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

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

from

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

received_at

Fecha y hora en que el servicio recibió el SMS

integer

text

Texto SMS

string | null

msg_uuid

ID del SMS que se replica

string | null

Examples

Example reply

Evento de SMS Entrante

Evento enviado cuando se recibe un SMS entrante

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