Exemplos de eventos de dados do AWS End User Messaging SMS - AWS SMS de mensagens para o usuário final

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Exemplos de eventos de dados do AWS End User Messaging SMS

O AWS End User Messaging SMS pode transmitir dados de eventos para entregas de SMS, MMS e mensagens de voz. Como pode levar até 72 horas para receber os eventos gerados pelas operadoras, você não deve usá-los para determinar se há um atraso na entrega de mensagens enviadas. Após 72 horas, se o AWS End User Messaging SMS não tiver recebido um evento final de uma operadora, o serviço retornará automaticamente um UNKNOWN messageStatus pois não sabemos o que aconteceu com essa mensagem.

exemplo de log de SMS

O objeto JSON de um evento de SMS contém os dados mostrados no exemplo a seguir.

{ "eventType": "TEXT_SUCCESSFUL", "eventVersion": "1.0", "eventTimestamp": 1686975103470, "isFinal": true, "originationPhoneNumber": "+12065550152", "destinationPhoneNumber": "+14255550156", "isInternationalSend": false, "mcc": "310", "mnc": "800", "messageId": "862a8790-60c0-4430-9b2b-658bdexample", "messageRequestTimestamp": 1686975103170, "messageEncoding": "GSM", "messageType": "PROMOTIONAL", "messageStatus": "SUCCESSFUL", "messageStatusDescription": "Message has been accepted by phone carrier", "context": { "account": "bar" }, "totalMessageParts": 1, "totalMessagePrice": 0.09582, "totalCarrierFee": 0.0 }
Atributo Descrição
eventType

O tipo de evento. Os valores estão listados em Tipos de evento para SMS, MMS e voz

eventVersion

A versão do esquema do evento JSON.

eventTimestamp A hora em que o evento foi relatado, mostrada como horário do Unix em milissegundos.
isFinal True se esse for o status final da mensagem. Há status intermediários de mensagens e o recebimento do estado da mensagem final pode levar até 72 horas.
originationPhoneNumber O número de telefone do qual a mensagem foi enviada.
destinationPhoneNumber O número de telefone para o qual você tentou enviar a mensagem.
isInternationalSend True se as mensagens internacionais estiverem habilitadas para esse número de telefone.
isoCountryCode O país associada ao número de telefone do destinatário, mostrado no formato ISO 3166-1 alpha-2.
mcc Os códigos de país do celular identificam o país ao qual um número de telefone pertence. Esse campo é opcional e pode não estar presente.
mnc Os códigos de rede móvel identificam uma operadora de rede móvel. Esse campo é opcional e pode não estar presente.
messageId O ID exclusivo que o AWS End User Messaging SMS gera quando aceita a mensagem.
messageRequestTimestamp A hora em que a solicitação da mensagem SMS foi recebida, exibida em horário Unix em milissegundos.
messageEncoding A codificação da mensagem. Os valores possíveis são GSM e Unicode. Para obter mais informações sobre codificação de mensagens, consulte Limites de caracteres de SMS.
messageType O tipo de mensagem. Os valores possíveis são Promocional e Transacional.
messageStatus

O status da mensagem. Os valores possíveis são:

  • SUCCESSFUL — a mensagem foi aceita pela operadora.

  • ENTREGUE — A mensagem foi aceita pelo dispositivo do destinatário.

  • PENDING: a mensagem ainda não foi entregue ao dispositivo do destinatário.

  • INVALID: o número de telefone de destino é inválido.

  • UNREACHABLE: o dispositivo do destinatário está inacessível ou indisponível no momento. Por exemplo, o dispositivo pode estar desligado ou desconectado da rede. É possível tentar enviar a mensagem novamente mais tarde.

  • UNKNOWN: ocorreu um erro que impediu a entrega da mensagem. Esse erro geralmente é temporário, e é possível tentar enviar a mensagem novamente mais tarde.

  • BLOCKED: o dispositivo do destinatário está bloqueando mensagens SMS do número de origem.

  • CARRIER_UNREACHABLE: um problema com a rede móvel do destinatário impediu que a mensagem fosse entregue. Esse erro geralmente é temporário, e é possível tentar enviar a mensagem novamente mais tarde.

  • SPAM: a operadora móvel do destinatário identificou o conteúdo da mensagem como spam e bloqueou a entrega da mensagem.

  • INVALID_MESSAGE: o corpo da mensagem SMS é inválido e não pode ser entregue.

  • CARRIER_BLOCKED: a operadora do destinatário bloqueou a entrega dessa mensagem. Isso geralmente ocorre quando a operadora identifica o conteúdo da mensagem como não solicitado ou mal-intencionado.

  • TTL_EXPIRED: não foi possível entregar a mensagem SMS dentro de um determinado prazo. Esse erro geralmente é temporário, e é possível tentar enviar a mensagem novamente mais tarde.

  • ACEITO — A mensagem SMS foi aceita.

  • FALHA — a mensagem ainda não foi entregue ao dispositivo do destinatário.

  • ENVIADO: a mensagem ainda não foi entregue ao dispositivo do destinatário.

  • NÃO ROUTÁVEL — Não é possível rotear devido a uma configuração de conta incorreta.

  • EM FILA — A mensagem está na fila para entrega.

  • PROTECT_BLOCKED — A mensagem SMS foi bloqueada pelas regras do SMS Protect.

messageStatusDescription Uma descrição do estado da mensagem.
context Atributos personalizados que você pode especificar e serão registrados quando você enviar uma mensagem.
totalMessageParts

O número de partes da mensagem que o AWS End User Messaging SMS criou para enviar a mensagem.

Geralmente, as mensagens SMS podem conter apenas 160 caracteres GSM-7 ou 67 caracteres não GSM, embora esses limites possam variar de acordo com o país . Se você enviar uma mensagem que exceda esses limites, o AWS End User Messaging SMS dividirá automaticamente a mensagem em partes menores. Você será cobrado com base no número de partes de mensagens enviadas. Para obter mais informações sobre partes da mensagem, consulte Quais são os limites de partes por segundo (MPS) de mensagens.

totalMessagePrice O valor cobrado pelo envio da mensagem. Esse preço é mostrado em milésimos de um centavo dos Estados Unidos. Por exemplo, se o valor desse atributo for 645, cobraremos USD 0,645 para enviar a mensagem (645/1000 = 0,645 = 0,00645).
totalCarrierFee O custo total das taxas da operadora para uma mensagem.

Exemplo de log do SMS Protect

O objeto JSON para um evento SMS ao usar o SMS Protect contém os dados mostrados no exemplo a seguir.

{ "eventType": "TEXT_PROTECT_BLOCKED", "eventVersion": "1.0", "eventTimestamp": 1686975103470, "isFinal": true, "originationPhoneNumber": "+12065550152", "destinationPhoneNumber": "+14255550156", "isoCountryCode": "US", "mcc": "310", "mnc": "800", "messageId": "862a8790-60c0-4430-9b2b-658bdexample", "messageRequestTimestamp": 1686975103170, "messageEncoding": "GSM", "messageType": "PROMOTIONAL", "messageStatus": "PROTECT_BLOCKED", "messageStatusDescription": "Message blocked by protect configuration", "context": { "account": "bar" }, "totalMessageParts": 1, "totalMessagePrice": 0, "totalCarrierFee": 0, "protectConfiguration": { "protectConfigurationId": "protect-d777777777777771bbd5d59f4d903479", "protectStatus": "FILTER" }, "protectConfigurationAssessment": { "protectRecommendation": "BLOCK" "protectInsights": { "blockReason": "AIT_SUSPECTED" } } }
Atributo Descrição
eventType

O tipo de evento. Os valores estão listados em Tipos de evento para SMS, MMS e voz

eventVersion

A versão do esquema do evento JSON.

eventTimestamp A hora em que o evento foi relatado, mostrada como horário do Unix em milissegundos.
isFinal True se esse for o status final da mensagem. Há status intermediários de mensagens e o recebimento do estado da mensagem final pode levar até 72 horas.
originationPhoneNumber O número de telefone do qual a mensagem foi enviada.
destinationPhoneNumber O número de telefone para o qual você tentou enviar a mensagem.
isoCountryCode O país associada ao número de telefone do destinatário, mostrado no formato ISO 3166-1 alpha-2.
mcc Os códigos de país do celular identificam o país ao qual um número de telefone pertence. Esse campo é opcional e pode não estar presente.
mnc Os códigos de rede móvel identificam uma operadora de rede móvel. Esse campo é opcional e pode não estar presente.
messageId O ID exclusivo que o AWS End User Messaging SMS gera quando aceita a mensagem.
messageRequestTimestamp A hora em que a solicitação da mensagem SMS foi recebida, exibida em horário Unix em milissegundos.
messageEncoding A codificação da mensagem. Os valores possíveis são GSM e Unicode. Para obter mais informações sobre codificação de mensagens, consulte Limites de caracteres de SMS.
messageType O tipo de mensagem. Os valores possíveis são Promocional e Transacional.
messageStatus

O status da mensagem. Os valores possíveis são:

  • SUCCESSFUL — a mensagem foi aceita pela operadora.

  • ENTREGUE — A mensagem foi aceita pelo dispositivo do destinatário.

  • PENDING: a mensagem ainda não foi entregue ao dispositivo do destinatário.

  • INVALID: o número de telefone de destino é inválido.

  • UNREACHABLE: o dispositivo do destinatário está inacessível ou indisponível no momento. Por exemplo, o dispositivo pode estar desligado ou desconectado da rede. É possível tentar enviar a mensagem novamente mais tarde.

  • UNKNOWN: ocorreu um erro que impediu a entrega da mensagem. Esse erro geralmente é temporário, e é possível tentar enviar a mensagem novamente mais tarde.

  • BLOCKED: o dispositivo do destinatário está bloqueando mensagens SMS do número de origem.

  • CARRIER_UNREACHABLE: um problema com a rede móvel do destinatário impediu que a mensagem fosse entregue. Esse erro geralmente é temporário, e é possível tentar enviar a mensagem novamente mais tarde.

  • SPAM: a operadora móvel do destinatário identificou o conteúdo da mensagem como spam e bloqueou a entrega da mensagem.

  • INVALID_MESSAGE: o corpo da mensagem SMS é inválido e não pode ser entregue.

  • CARRIER_BLOCKED: a operadora do destinatário bloqueou a entrega dessa mensagem. Isso geralmente ocorre quando a operadora identifica o conteúdo da mensagem como não solicitado ou mal-intencionado.

  • TTL_EXPIRED: não foi possível entregar a mensagem SMS dentro de um determinado prazo. Esse erro geralmente é temporário, e é possível tentar enviar a mensagem novamente mais tarde.

  • ACEITO — A mensagem SMS foi aceita.

  • FALHA — a mensagem ainda não foi entregue ao dispositivo do destinatário.

  • ENVIADO: a mensagem ainda não foi entregue ao dispositivo do destinatário.

  • NÃO ROUTÁVEL — Não é possível rotear devido a uma configuração de conta incorreta.

  • EM FILA — A mensagem está na fila para entrega.

  • PROTECT_BLOCKED — A mensagem SMS foi bloqueada pelas regras do SMS Protect.

messageStatusDescription Uma descrição do estado da mensagem.
context Atributos personalizados que você pode especificar e serão registrados quando você enviar uma mensagem.
totalMessageParts

O número de partes da mensagem que o AWS End User Messaging SMS criou para enviar a mensagem.

Geralmente, as mensagens SMS podem conter apenas 160 caracteres GSM-7 ou 67 caracteres não GSM, embora esses limites possam variar de acordo com o país . Se você enviar uma mensagem que exceda esses limites, o AWS End User Messaging SMS dividirá automaticamente a mensagem em partes menores. Você será cobrado com base no número de partes de mensagens enviadas. Para obter mais informações sobre partes da mensagem, consulte Quais são os limites de partes por segundo (MPS) de mensagens.

totalMessagePrice O valor cobrado pelo envio da mensagem. Esse preço é mostrado em milésimos de um centavo dos Estados Unidos. Por exemplo, se o valor desse atributo for 645, cobraremos USD 0,645 para enviar a mensagem (645/1000 = 0,645 = 0,00645).
totalCarrierFee O custo total das taxas da operadora para uma mensagem.
protectConfiguration O ID da configuração de proteção usada ao enviar a mensagem e o status do país de destino no momento. Para obter mais informações sobre SMS Protect, consulte SMS Protect.
protectConfigurationAssessment Uma avaliação sobre se o SMS Protect acha que o envio de sua mensagem deve ser permitido ou bloqueado e os motivos do bloqueio, quando disponíveis.

Exemplo de registro de eventos de voz

O objeto JSON para um evento de voz contém os dados mostrados no exemplo a seguir.

{ "eventType": "VOICE_COMPLETED", "eventVersion": "1.0", "eventTimestamp": 1697835373500, "isFinal": true, "originationPhoneNumber": "+12065550153", "destinationPhoneNumber": "+14255550159", "isoCountryCode": "US", "messageId": "567f6c11-6e8b-4352-9749-a42a0example", "messageRequestTimestamp": 1697835372720, "messageStatus": "COMPLETED", "callDurationInSeconds": 60, "totalDurationInMinutes": 1, "totalMessagePrice": 0.013, "context": { "account": "bar" } }
Atributo Descrição
eventType

O tipo de evento. Os valores estão listados em Tipos de evento para SMS, MMS e voz

eventVersion

A versão do esquema do evento JSON.

eventTimestamp A hora em que o evento foi relatado, mostrada como horário do Unix em milissegundos.
isFinal True se esse for o status final da mensagem. Há status de mensagens intermediárias.
originationPhoneNumber O número de telefone do qual a mensagem foi enviada.
destinationPhoneNumber O número de telefone para o qual você tentou enviar a mensagem.
isoCountryCode O país associada ao número de telefone do destinatário, mostrado no formato ISO 3166-1 alpha-2.
messageId O ID exclusivo que o AWS End User Messaging SMS gera quando aceita a mensagem.
messageRequestTimestamp A hora em que a solicitação da mensagem SMS foi recebida, exibida em horário Unix em milissegundos.
messageStatus

O status da mensagem. Os valores possíveis são:

  • INICIADO — A mensagem de voz está pronta para começar a discar.

  • RINGING – Os eventos de toque ocorrem após a chamada ser feita, mas antes que o destinatário atenda.

  • COMPLETED: envia todos os eventos concluídos das mensagens de voz para o destino especificado. Os eventos concluídos ocorrem quando a mensagem de áudio é reproduzida para o destinatário. Esse status não significa necessariamente que a mensagem foi entregue a um destinatário humano. Por exemplo, isso pode indicar que a mensagem foi entregue em um sistema de correio de voz.

  • ANSWERED – Os eventos respondidos ocorrem quando o destinatário atende o telefone.

  • CONCLUÍDA — A chamada foi atendida e encerrada.

  • BUSY – Eventos ocupados ocorrem quando a linha telefônica do destinatário está ocupada.

  • NO_ANSWER – Nenhum evento de resposta ocorre após a realização da chamada, mas o destinatário (ou seu sistema de correio de voz) nunca atende.

  • FAILED – Eventos de falha ocorrem quando a mensagem não é entregue.

  • TTL_EXPIRED – Os eventos TTL Expired ocorrem quando o tempo necessário para entregar a mensagem excede o valor TTL que você especificou ao enviar a mensagem.

  • SPAM — A chamada foi marcada como spam e bloqueada.

  • PROTECT_BLOCKED — A mensagem SMS foi bloqueada pelas regras do SMS Protect.

callDurationInSeconds A duração da chamada em segundos.
totalDurationInMinutes A duração da chamada em minutos.
totalMessagePrice O valor que cobramos para enviar a mensagem de voz. Esse preço é mostrado em milésimos de um centavo dos Estados Unidos.
context Atributos personalizados que você pode especificar e serão registrados quando você enviar uma mensagem.

Exemplo de log de MMS

O objeto JSON para um evento MMS contém os dados mostrados no exemplo a seguir.

{ "contentType":"MMS", "eventType": "MEDIA_DELIVERED", "eventVersion": "1.0", "eventTimestamp": 1635197695208, "isFinal": true, "originationPhoneNumber": "+12065550153", "destinationPhoneNumber": "+14255550159", "isoCountryCode": "US", "messageId": "b4a3196d-5b61-4884-a0d9-745acf1f6235example", "messageRequestTimestamp": 1635197693241, "messageType": "TRANSACTIONAL", "messageStatus": "DELIVERED", "messageStatusDescription": "Message has been accepted by phone", "context": {"foo":"bar"}, "totalMessageParts": 1, "totalMessagePrice": 0.0195, "totalCarrierFee": 0.00266 }
Atributo Descrição
eventType

O tipo de evento. Os valores estão listados em Tipos de evento para SMS, MMS e voz

eventVersion

A versão do esquema do evento JSON.

eventTimestamp A hora em que o evento foi relatado, mostrada como horário do Unix em milissegundos.
isFinal True se esse for o status final da mensagem. Há status intermediários de mensagens e o recebimento do estado da mensagem final pode levar até 72 horas.
originationPhoneNumber O número de telefone do qual a mensagem foi enviada.
destinationPhoneNumber O número de telefone para o qual você tentou enviar a mensagem.
isoCountryCode O país associada ao número de telefone do destinatário, mostrado no formato ISO 3166-1 alpha-2.
messageId O ID exclusivo que o AWS End User Messaging SMS gera quando aceita a mensagem.
messageRequestTimestamp A hora em que a solicitação da mensagem SMS foi recebida, exibida em horário Unix em milissegundos.
messageType O tipo de mensagem. Os valores possíveis são Promocional e Transacional.
messageStatus

O status da mensagem. Os valores possíveis são:

  • SUCCESSFUL — a mensagem foi aceita pela operadora.

  • ENTREGUE — A mensagem foi aceita pelo dispositivo do destinatário.

  • PENDING: a mensagem ainda não foi entregue ao dispositivo do destinatário.

  • INVALID: o número de telefone de destino é inválido.

  • UNREACHABLE: o dispositivo do destinatário está inacessível ou indisponível no momento. Por exemplo, o dispositivo pode estar desligado ou desconectado da rede. É possível tentar enviar a mensagem novamente mais tarde.

  • UNKNOWN: ocorreu um erro que impediu a entrega da mensagem. Esse erro geralmente é temporário, e é possível tentar enviar a mensagem novamente mais tarde.

  • BLOCKED: o dispositivo do destinatário está bloqueando mensagens SMS/MMS do número de origem.

  • CARRIER_UNREACHABLE: um problema com a rede móvel do destinatário impediu que a mensagem fosse entregue. Esse erro geralmente é temporário, e é possível tentar enviar a mensagem novamente mais tarde.

  • SPAM: a operadora móvel do destinatário identificou o conteúdo da mensagem como spam e bloqueou a entrega da mensagem.

  • INVALID_MESSAGE: o corpo da mensagem SMS/MMS é inválido e não pode ser entregue.

  • CARRIER_BLOCKED: a operadora do destinatário bloqueou a entrega dessa mensagem. Isso geralmente ocorre quando a operadora identifica o conteúdo da mensagem como não solicitado ou mal-intencionado.

  • TTL_EXPIRED: não foi possível entregar a mensagem SMS dentro de um determinado prazo. Esse erro geralmente é temporário, e é possível tentar enviar a mensagem novamente mais tarde.

  • ACEITO — A mensagem SMS foi aceita.

  • FALHA — a mensagem ainda não foi entregue ao dispositivo do destinatário.

  • ENVIADO: a mensagem ainda não foi entregue ao dispositivo do destinatário.

  • NÃO ROUTÁVEL — Não é possível rotear devido a uma configuração de conta incorreta.

  • EM FILA — A mensagem está na fila para entrega.

messageStatusDescription Uma descrição do estado da mensagem.
context Atributos personalizados que você pode especificar e serão registrados quando você enviar uma mensagem.
totalMessageParts

O número de partes da mensagem que o AWS End User Messaging SMS criou para enviar a mensagem. Para obter mais informações sobre partes da mensagem, consulte Quais são os limites de partes por segundo (MPS) de mensagens.

totalMessagePrice O valor cobrado pelo envio da mensagem. Esse preço é mostrado em milésimos de um centavo dos Estados Unidos. Por exemplo, se o valor desse atributo for 645, cobraremos USD 0,645 para enviar a mensagem (645/1000 = 0,645 = 0,00645).
totalCarrierFee O custo total das taxas da operadora para uma mensagem.