Webhook de Cancelamento de Inscrição de Telefone

POST

Acionado quando um número de telefone cancela a inscrição através do envio de formulário

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: phone.unsubscribe

data

Phone unsubscribe webhook data payload

object

phone

required

Número de telefone que cancelou a inscrição

string

user_id

required

ID do usuário associado ao número de telefone

integer

created_at

required

Unix timestamp when the unsubscribe occurred

integer

campaign_code

required

Código da campanha associado ao cancelamento

string

additional_data

required

object

reason

required

object

id

required

ID do motivo para o cancelamento. Valores possíveis:

• 1: Nunca me inscrevi
• 2: Muitas mensagens
• 3: Não me interessa
• 4: O conteúdo é incompreensível
• 5: Não gosto da sua empresa
• 6: Outro

integer

Allowed values: 1 2 3 4 5 6

label

required

Motivo legível para o cancelamento

string

additional_text

required

Texto adicional fornecido pelo usuário

string

short_link_code

required

Código do link curto associado ao cancelamento

string

unsubscribe_request_id

required

ID da solicitação de cancelamento

integer

group_id

ID do grupo associado ao cancelamento do telefone

integer

timestamp

Timestamp Unix quando o cancelamento ocorreu

Examples

Example unsubscribe

Evento de cancelamento de inscrição de telefone

{
  "id": "ef58b437-1319-4b0c-961b-17214cf1cf32",
  "data": {
    "phone": "+4911113333444",
    "user_id": 2,
    "created_at": 1757849748,
    "campaign_code": "3KCKb5nMD",
    "additional_data": {
      "reason": {
        "id": 4,
        "label": "Es ist unverständlich"
      },
      "additional_text": "zusätzlicher Benutzertext mit Erklärung"
    },
    "short_link_code": "baaIou",
    "unsubscribe_request_id": 59
  },
  "name": "phone.unsubscribe",
  "created_at": 1757849748,
  "api_version": "2022-05-25",
  "attempt_number": 1,
  "attempts_total": 4
}

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