Flujo de datos de eventos de SMS desde Amazon Pinpoint - Amazon Pinpoint
Ejemplo de evento de SMSAtributos de los eventos de SMS

Flujo de datos de eventos de SMS desde Amazon Pinpoint

Si el canal de SMS está habilitado para un proyecto, Amazon Pinpoint puede transmitir datos de eventos acerca de entregas de mensajes SMS para el proyecto. Tras configurar la transmisión de eventos, Amazon Pinpoint recupera los datos de los eventos desde el destino que haya especificado durante la configuración para que pueda verlos. Para obtener información sobre cómo configurar transmisiones de eventos, consulte Configurar Amazon Pinpoint para transmitir datos de eventos de aplicación a través de Amazon Kinesis o Amazon Data Firehose .

nota

Los eventos de SMS generados por los operadores pueden tardar hasta 72 horas en recibirse y no se deben utilizar para determinar si hay un retraso en la entrega de los mensajes salientes. Transcurridas 72 horas, si Amazon Pinpoint no ha recibido un evento final de un operador, el servicio devuelve automáticamente el record_status UNKNOWN, ya que Amazon Pinpoint no sabe qué ha ocurrido con ese mensaje.

Ejemplo de evento de SMS

El objeto JSON relacionado con un evento de SMS contiene los datos que se muestran en el siguiente ejemplo.

{
  "event_type": "_SMS.SUCCESS",
  "event_timestamp": 1553104954322,
  "arrival_timestamp": 1553104954064,
  "event_version": "3.1",
  "application": {
    "app_id": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
    "sdk": {}
  },
  "client": {
    "client_id": "123456789012"
  },
  "device": {
    "platform": {}
  },
  "session": {},
  "attributes": {
    "sender_request_id": "565d4425-4b3a-11e9-b0a5-example",
    "campaign_activity_id": "cbcfc3c5e3bd48a8ae2b9cb41example",
    "origination_phone_number": "+12065550142",
    "destination_phone_number": "+14255550199",
    "record_status": "DELIVERED",
    "iso_country_code": "US",
    "treatment_id": "0",
    "number_of_message_parts": "1",
    "message_id": "1111-2222-3333",
    "message_type": "Transactional",
    "campaign_id": "52dc44b35c4742c98c5935269example"
  },
  "metrics": {
    "price_in_millicents_usd": 645.0
  },
  "awsAccountId": "123456789012"
}

Atributos de los eventos de SMS

En esta sección se definen los atributos que se han incluido en el ejemplo anterior de los datos de la secuencia de eventos que Amazon Pinpoint genera cuando se envían mensajes de SMS.

Evento
Atributo Descripción
event_type

El tipo de evento. Los valores posibles son los siguientes:

  • _SMS.BUFFERED: el mensaje aún está en proceso de entrega al destinatario.

  • _SMS.SUCCESS: el operador aceptó correctamente el mensaje o lo entregó al destinatario.

  • _SMS.FAILURE: Amazon Pinpoint no pudo entregar el mensaje al destinatario. Para obtener más información sobre el error que impidió la entrega del mensaje, consulte attributes.record_status.

  • _SMS.OPTOUT: el cliente recibió el mensaje y respondió enviando la palabra clave de desactivación (normalmente “STOP”).

event_timestamp

La hora a la que se notificó el evento, que se muestra en formato de tiempo Unix en milisegundos.
arrival_timestamp

La hora a la que Amazon Pinpoint recibió el evento, que se muestra en formato de tiempo Unix en milisegundos.
event_version

La versión del esquema JSON del evento.

sugerencia

Compruebe esta versión en la aplicación de procesamiento de eventos para saber cuándo actualizar la aplicación en respuesta a una actualización del esquema.
application

Información sobre el proyecto de Amazon Pinpoint asociado al evento. Consulte la tabla de la sección Application (Aplicación) para obtener más información.
client

Información sobre el cliente de la aplicación instalado en el dispositivo que notificó el evento. Consulte la tabla de la sección Client (Cliente) para obtener más información.
device

Información sobre el dispositivo que notificó el evento. Para obtener más información, consulte la tabla Dispositivos.

Para los eventos de SMS, este objeto está vacío.
session Para los eventos de SMS, este objeto está vacío.
attributes

Atributos asociados al evento. Para los eventos notificados por una de sus aplicaciones, este objeto puede incluir atributos personalizados definidos por la aplicación. Para los eventos que se crean al enviar una campaña, este objeto contiene atributos asociados a la campaña. Para los eventos que se generan al enviar mensajes de transacciones, este objeto contiene información relacionada con el propio mensaje.

Consulte la tabla de la sección Attributes (Atributos) para obtener más información.
metrics

Métricas adicionales asociadas al evento. Para obtener más información, consulte la tabla Métricas.
awsAccountId

El ID de la cuenta de AWS de que se utilizó para enviar el mensaje.

Aplicación

Incluye información sobre el proyecto de Amazon Pinpoint al que está asociado el evento y, si procede, el SDK que se utilizó para informar del evento.

Atributo Descripción
app_id

El ID único del proyecto de Amazon Pinpoint que notificó el evento.
sdk

El SDK que se utilizó para notificar el evento. Si envía un mensaje SMS transaccional llamando directamente a la API de Amazon Pinpoint o con la consola de Amazon Pinpoint, este objeto estará vacío.

Atributos

Incluye información sobre los atributos asociados al evento.

Atributo Descripción
sender_request_id

Un ID único asociado a la solicitud para enviar el mensaje SMS.
campaign_activity_id El ID único de la actividad dentro de la campaña.
origination_phone_number

El número de teléfono desde el que se envió el mensaje.
destination_phone_number

El número de teléfono al que se ha intentado enviar el mensaje.
record_status

Información adicional sobre el estado del mensaje. Los valores posibles son:

  • SUCCESSFUL/DELIVERED: el mensaje se entregó de forma satisfactoria.

  • PENDING: el mensaje aún no se ha entregado al dispositivo del destinatario.

  • INVALID: el número de teléfono de destino no es válido.

  • UNREACHABLE: el dispositivo del destinatario no está disponible en este momento. Por ejemplo, el dispositivo podría estar apagado o desconectado de la red. Puede intentar enviar el mensaje de nuevo más tarde.

  • UNKNOWN: se ha producido un error que ha impedido la entrega del mensaje. Este error suele ser transitorio y es posible intentar enviar el mensaje de nuevo más tarde.

  • BLOCKED: el dispositivo del destinatario bloquea los mensajes SMS del número de origen.

  • CARRIER_UNREACHABLE: un problema con la red móvil del destinatario impidió que se entregara el mensaje. Este error suele ser transitorio y es posible intentar enviar el mensaje de nuevo más tarde.

  • SPAM: el operador de telefonía móvil del destinatario identificó el contenido del mensaje como spam y bloqueó la entrega del mensaje.

  • INVALID_MESSAGE: el cuerpo del mensaje SMS no es válido y no se puede entregar.

  • CARRIER_BLOCKED: el operador del destinatario ha bloqueado la entrega de este mensaje. Esto suele ocurrir cuando el operador identifica el contenido del mensaje como no solicitado o malintencionado.

  • TTL_EXPIRED: el mensaje SMS no se pudo entregar en un periodo de tiempo determinado. Este error suele ser transitorio y es posible intentar enviar el mensaje de nuevo más tarde.

  • MAX_PRICE_EXCEEED: el envío del mensaje habría supuesto un cargo superior a la cuota mensual de gastos de SMS de la cuenta. Puede solicitar un aumento de esta cuota completando el procedimiento descrito en Solicitud de aumentos de la cuota de gasto mensual de SMS en la Guía del usuario de Amazon Pinpoint.

  • OPTED_OUT: el mensaje SMS no se envió porque el destinatario desactivó la recepción de mensajes de usted.

  • NO_QUOTA_LEFT_ON_ACCOUNT: no queda suficiente cuota de gasto en la cuenta para enviar el mensaje. Puede solicitar un aumento de esta cuota completando el procedimiento descrito en Solicitud de aumento de la cuota de gasto mensual de SMS en la Guía del usuario de Mensajes SMS para usuarios finales de AWS.

  • NO_ORIGINATION_IDENTITY_AVAILABLE_TO_SEND: la cuenta no contiene un número de teléfono que se pueda usar para enviar el mensaje al destino.

  • DESTINATION_COUNTRY_NOT_SUPPORTED: el país de destino está bloqueado. Para obtener más información sobre los países admitidos, consulte Países y regiones admitidos (canal de SMS) en la Guía del usuario de Mensajes SMS para usuarios finales de AWS.

  • ACCOUNT_IN_SANDBOX: la cuenta está en un entorno aislado y solo puede enviar a números de destino verificados. Puede verificar el número de destino en la consola de Amazon Pinpoint o iniciar el proceso para sacar la cuenta del entorno de pruebas. Consulte Acerca del entorno pruebas de SMS/MMS y voz en la Guía del usuario de Mensajes SMS para usuarios finales de AWS.

  • RATE_EXCEEDED: ha intentado enviar un mensaje demasiado rápido y se ha producido un error. Necesita reducir la velocidad de las llamadas. Para obtener más información sobre nuestros límites, consulte Límites de partes por segundo (MPS) de mensajes en la Guía del usuario de Mensajes SMS para usuarios finales de AWS.

  • INVALID_ORIGINATION_IDENTITY: la identidad de origen proporcionada no es válida.

  • ORIGINATION_IDENTITY_DOES_NOT_EXIST: la identidad de origen proporcionada no existe.

  • INVALID_DLT_PARAMETERS: se proporcionaron parámetros de DLT no válidos (requerido para destinos en India).

  • INVALID_PARAMETERS: se proporcionaron parámetros no válidos.

  • ACCESS_DENIED: la cuenta no puede enviar mensajes. Contacte con el servicio de atención al cliente para averiguar la causa y resolver el problema.

  • INVALID_KEYWORD: la palabra clave proporcionada no es válida. Es posible que la palabra clave tenga un formato incorrecto o que no esté configurada en la cuenta.

  • INVALID_SENDER_ID: el ID de remitente proporcionado no es válido. El ID del remitente puede tener un formato o una longitud incorrectos.

  • INVALID_POOL_ID: el ID de grupo proporcionado no es válido. El ID de grupo puede estar en un formato incorrecto o no pertenecer a la cuenta.

  • SENDER_ID_NOT_SUPPORTED_FOR_DESTINATION: el país de destino no admite el ID de remitente. Tiene que usar un número de teléfono u otra identidad de origen para enviar.

  • INVALID_PHONE_NUMBER: el número de teléfono de origen proporcionado no es válido. El número de teléfono puede tener un formato o una longitud incorrectos.
iso_country_code

El país que está asociado al número de teléfono del destinatario, mostrado en formato ISO 3166-1 alpha-2.
treatment_id

El ID del tratamiento del mensaje, si el mensaje se envió en una campaña A/B.
treatment_id

Si el mensaje se envió mediante una campaña de prueba A/B, este valor representa el número de tratamiento del mensaje. Para los mensajes SMS de transacciones, este valor es 0.
number_of_message_parts

El número de partes del mensaje que Amazon Pinpoint ha creado para enviar el mensaje.

Por lo general, los mensajes SMS solo pueden contener 160 caracteres GSM-7 o 67 caracteres no GSM, aunque estos límites pueden variar según el país . Si envía un mensaje que supere estos límites, Amazon Pinpoint lo divide automáticamente en partes más pequeñas. La facturación se realiza en función del número de partes de mensajes que envíe.
message_id

El ID único que Amazon Pinpoint genera cuando acepta el mensaje.
message_type

Tipo de mensaje. Los valores posibles son Promotional (Promocionales) y Transactional (Transaccionales). Este valor se especifica al crear una campaña o al enviar mensajes de transacciones mediante la operación SendMessages de la API de Amazon Pinpoint.
campaign_id

El ID único de la campaña DE Amazon Pinpoint que envió el mensaje.
customer_context

Una cadena JSON del contenido de la asignación Context enviada en una operación SendMessages de Amazon Pinpoint.

Cliente

Incluye información sobre el cliente de la aplicación instalada en el dispositivo que notificó el evento.

Atributo Descripción
client_id

Para los eventos generados por aplicaciones, este valor es el ID único del cliente de la aplicación instalada en el dispositivo. AWS Mobile SDK for iOS y AWS Mobile SDK for Android generan automáticamente este ID.

Para los eventos que se generan al enviar campañas y mensajes de transacciones, este valor es igual al ID del punto de enlace al que envía el mensaje.
cognito_id El ID exclusivo asignado al cliente de la aplicación en el grupo de identidades de Amazon Cognito utilizado por la aplicación.

Dispositivo

Incluye información sobre el dispositivo que notificó el evento.

Atributo Descripción
locale La configuración regional del dispositivo.
make La marca del dispositivo, como, por ejemplo, Apple o Samsung.
model El modelo del dispositivo, como, por ejemplo, iPhone.
platform La plataforma del dispositivo, como, por ejemplo, ios o android.

Métricas

Incluye información sobre las métricas asociadas al evento.

Atributo Descripción
price_in_millicents_usd

La cantidad que se cobra por enviar el mensaje. Este precio se muestra en milésimas de centavo de dólar estadounidense. Por ejemplo, si el valor de este atributo es 645, se le cobran 0,645 ¢ por enviar el mensaje (645 / 1000 = 0,645 ¢ = 0,00645 USD).

nota

Esta propiedad no aparece en los mensajes con el event_type _SMS.BUFFERED.