Canal de código de verificación fallido

POST

El evento verify_code.channel.failed se activa cuando un canal específico no ha podido procesar el código de verificación.

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: verify_code.channel.failed

data

Data for verify_code.channel.sent, verify_code.channel.success and verify_code.channel.failed events

object

id

Verify code ID (UUID)

string

user_id

User ID

integer

phone

Phone number

string

routing_strategy

Routing strategy configuration

Array<object>

object

channel

string

Allowed values: telegram sms

timeout_sec

Timeout in seconds. Only applicable for the telegram channel.

integer

sender_id

string

status

Verify code status

integer

delivered_channel

Channel that delivered the code

string | null

cost

Cost in cents

integer | null

currency

Currency code

string | null

code

Verification code

string | null

code_length

Code length

integer | null

payload

Custom payload

string | null

created_at

Creation timestamp

integer

updated_at

Last update timestamp

integer

history

Processing history

Array<object>

object

id

string

channel

string

status

integer

processed_at

integer

external_id

string

is_code_deleted

Whether the verification code has been deleted from storage after being sent.

boolean

channel

Channel-specific processing details

object

id

History entry ID

string

channel

Channel type

string

Allowed values: telegram sms

status

Channel processing status

integer

processed_at

Processing timestamp

integer

external_id

External provider ID

string | null

error

Error message if failed

string | null

cost

Cost for this channel in cents

integer | null

Examples

Example failed

Verify Code Channel Failed Event

Event sent when a specific channel has failed to deliver the verification code

{
  "id": "e5f6a7b8-9c0d-4e1f-2a3b-4c5d6e7f8a9b",
  "api_version": "2022-05-25",
  "name": "verify_code.channel.failed",
  "created_at": 1735689630,
  "attempt_total": 3,
  "attempt_number": 1,
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "user_id": 12345,
    "phone": "+4915112345678",
    "routing_strategy": [
      {
        "channel": "telegram",
        "timeout_sec": 30,
        "sender_id": "LOX24"
      },
      {
        "channel": "sms",
        "timeout_sec": 60,
        "sender_id": "LOX24"
      }
    ],
    "status": 5,
    "delivered_channel": null,
    "cost": 5,
    "currency": "EUR",
    "code": "1234",
    "code_length": 4,
    "payload": "session_abc123",
    "created_at": 1735689540,
    "updated_at": 1735689630,
    "history": [
      {
        "id": "a1b2c3d4-d5e6-7890-abcd-ef1234567890",
        "channel": "telegram",
        "status": 20,
        "processed_at": 1735689575,
        "external_id": "tg_msg_001"
      }
    ],
    "is_code_deleted": false,
    "channel": {
      "id": "a1b2c3d4-d5e6-7890-abcd-ef1234567890",
      "channel": "telegram",
      "status": 20,
      "processed_at": 1735689575,
      "external_id": "tg_msg_001",
      "error": "Delivery timeout: no confirmation received within 30 seconds",
      "cost": 5
    }
  },
  "notification_task_id": "77dcf296-fc00-4fc0-9b6d-6f54e85ff975"
}

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