sms.inbound.received

Use sms.inbound.received para processar este evento no seu endpoint de Webhook.

Gatilhos

Ocorre quando uma mensagem SMS de entrada é recebida, o que significa que um usuário respondeu à sua mensagem. Inscreva-se em sms.inbound.received ao configurar seu endpoint de Webhook.

Sintaxe

A YCloud envia uma solicitação HTTP POST para a URL de Webhook configurada. A estrutura a seguir mostra uma variante de payload. Os valores entre colchetes angulares são marcadores de posição; seus tipos estão listados em Parâmetros. Campos opcionais e outras variantes são descritos abaixo.

{
  "id": "<ID>",
  "type": "sms.inbound.received",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "smsInbound": {
    "id": "<ID>",
    "from": "<FROM>",
    "to": "<TO>",
    "text": "<TEXT>",
    "sendTime": "<SEND_TIME>"
  }
}

Parâmetros

Valide o cabeçalho HTTP YCloud-Signature antes de processar o corpo JSON. Consulte a validação de assinatura.

Envelope do evento

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Sim	ID exclusivo do evento. Tamanho mínimo: `6`. Tamanho máximo: `128`.
`type`	string	Sim	Sempre `sms.inbound.received`.
`apiVersion`	string	Sim	A versão da API usada para renderizar este evento.
`createTime`	string (date-time)	Sim	O momento em que este evento foi criado, formatado em RFC 3339. Ex.: `2022-06-01T12:00:00.000Z`.

Payload do evento

Parâmetro	Tipo	Obrigatório	Descrição
`smsInbound`	object	Não	Payload específico do evento `smsInbound`.

Os quatro campos comuns do envelope são obrigatórios. Os campos de payload dependem da variante do evento. Em cada tabela de objetos, Obrigatório se aplica quando seu objeto pai está presente. Campos opcionais podem ser omitidos; um exemplo não torna um campo obrigatório.

smsInbound

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Não	ID exclusivo da mensagem.
`from`	string	Não	O número de telefone do usuário que enviou a mensagem para o seu Sender ID registrado, formatado no padrão E.164.
`to`	string	Não	O número de telefone do destinatário, que é um dos seus Sender IDs registrados.
`text`	string	Não	O texto desta mensagem.
`sendTime`	string (date-time)	Não	O momento em que esta mensagem foi enviada, formatado em RFC 3339. Ex.: `2022-06-01T12:00:00.000Z`.

Exemplo

O seguinte JSON é o corpo entregue ao seu receptor. IDs, números de telefone e outros valores de conta são ilustrativos.

{
  "id": "evt_example_sms_inbound_received",
  "type": "sms.inbound.received",
  "apiVersion": "v2",
  "createTime": "2026-05-26T12:00:00.000Z",
  "smsInbound": {
    "id": "sms_inbound_12345678",
    "from": "+12025550124",
    "to": "+12025550123",
    "text": "Please send the order details.",
    "sendTime": "2026-05-26T11:59:00.000Z"
  }
}

Depois de verificar a assinatura e aceitar o evento de forma durável, retorne uma resposta 2xx. Processe tarefas lentas de forma assíncrona.

HTTP/1.1 200 OK

Para orientações passo a passo de cenários, consulte os exemplos anotados.

Primeiros passos

Guias

Endpoints

Webhook reference

Gatilhos

Sintaxe

Parâmetros

Envelope do evento

Payload do evento

smsInbound

Exemplo

​Gatilhos

​Sintaxe

​Parâmetros

​Envelope do evento

​Payload do evento

​smsInbound

​Exemplo

Gatilhos

Sintaxe

Parâmetros

Envelope do evento

Payload do evento

smsInbound

Exemplo