SMS entrantes

POST

O evento ‘sms.incoming’ é enviado em um SMS de entrada/resposta (originado pelo celular - SMS-MO).

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: 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

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

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

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

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

Example reply

Evento de SMS Recebido

Evento enviado quando um SMS recebido é recebido

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