SMS recebidas

Para receber SMS, crie um ponto de extremidade do webhook e configure sua conta para usá-la na guia “Configurações da API” do Painel do Desenvolvedor da Vonage.

Todas as mensagens enviadas para um dos seus números virtuais da Vonage são encaminhadas para o seu webhook por meio de uma solicitação GET ou POST. Ao receber uma mensagem no seu webhook, você deve enviar uma 200 OK ou 204 No Content resposta. Caso contrário, a Vonage presumirá que você não recebeu a mensagem e continuará reenviando-a pelas próximas 24 horas.

As mensagens concatenadas requerem atenção especial. Consulte mensagens recebidas concatenadas.

Anatomia de uma mensagem recebida

As mensagens são enviadas para o seu endpoint de webhook como um objeto JSON com as seguintes propriedades:

Chave Valor Obrigatório
type Os valores possíveis são:
  • text - texto padrão
  • unicode - uma mensagem de texto que contenha caracteres Unicode
  • binary - uma mensagem binária
 Sim
to O número de telefone para o qual a mensagem foi enviada para. Este é o seu número virtual. Sim
msisdn O número de telefone do qual essa mensagem recebida foi enviada de. Sim
messageId Identificador exclusivo da Vonage para esta mensagem. Sim
message-timestamp O UTC±00:00 no momento em que a Vonage começou a enviar essa mensagem recebida para o seu endpoint de webhook, no seguinte formato: YYYY-MM-DD HH:MM:SS. Sim
timestamp O timestamp do Unix representação de message-timestamp. Não
nonce Uma sequência aleatória que acrescenta um elemento extra de imprevisibilidade à assinatura da solicitação. Você usa o nonce e timestamp parâmetros com seu segredo compartilhado para calcular e validar a assinatura das mensagens recebidas. Se suas mensagens forem assinado

Para mensagens do tipo text ou unicode

Se o type é text ou unicode, as seguintes propriedades aparecem na solicitação enviada ao seu endpoint de webhook.

Chave Valor
text O corpo da mensagem para esta mensagem recebida.
keyword A primeira palavra no corpo da mensagem. Isso geralmente é usado com códigos curtos.

Para mensagens do tipo binary

Se o type é binary, as seguintes propriedades aparecem na solicitação enviada ao seu endpoint de webhook.

Chave Valor
data O conteúdo desta mensagem
udh A codificação hexadecimal cabeçalho de dados do usuário

Para mensagens recebidas concatenadas

Se uma mensagem enviada para o seu número virtual estiver dentro do comprimento máximo permitido para uma única mensagem, as seguintes propriedades não aparecerão na solicitação enviada ao seu endpoint de webhook.

Se a mensagem tiver mais caracteres do que o número máximo permitido em uma única mensagem, você receberá a mensagem em partes e as seguintes propriedades aparecerão na solicitação.

Use o concat-ref, concat-total e concat-part propriedades para construir a mensagem a partir das partes individuais.

Nem todas as operadoras oferecem suporte a mensagens concatenadas. Se a operadora não oferecer suporte à concatenação, a concat O campo não estará presente na carga útil.

Chave Valor
concat true
concat-ref A referência da transação. Todas as partes desta mensagem compartilham essa referência concat-ref.
concat-total O número de partes desta mensagem concatenada.
concat-part O número desta parte da mensagem. A primeira parte da mensagem é 1.