SMSflux de données d'événements provenant d'Amazon Pinpoint - Amazon Pinpoint
SMSexemple d'événementSMSattributs de l'événement

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

SMSflux de données d'événements provenant d'Amazon Pinpoint

Si le SMS canal est activé pour un projet, Amazon Pinpoint peut diffuser des données d'événements concernant les envois de SMS messages relatifs au projet. Une fois que vous avez configuré le streaming d'événements, Amazon Pinpoint extrait les données de vos événements depuis la destination que vous avez spécifiée lors de la configuration pour que vous puissiez les consulter. Pour plus d'informations sur la configuration de la diffusion d'événements, consultez Configurer Amazon Pinpoint pour diffuser les données d'événements des applications via Amazon Kinesis ou Amazon Data Firehose .

Note

SMSles événements générés par les transporteurs peuvent prendre jusqu'à 72 heures pour être reçus et ne doivent pas être utilisés pour déterminer s'il y a un retard dans la livraison des messages sortants. Au bout de 72 heures, si Amazon Pinpoint n'a pas reçu d'événement final de la part d'un transporteur, le service renvoie automatiquement un UNKNOWN record_status, car Amazon Pinpoint ne sait pas ce qu'il est advenu de ce message.

SMSexemple d'événement

L'JSONobjet d'un SMS événement contient les données présentées dans l'exemple suivant.

{
  "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"
}

SMSattributs de l'événement

Cette section définit les attributs inclus dans l'exemple précédent des données de flux d'événements générées par Amazon Pinpoint lorsque vous envoyez SMS des messages.

Événement
Attribut Description
event_type

Type d'événement. Les valeurs possibles sont :

  • _SMS. BUFFERED— Le message est toujours en cours d'envoi au destinataire.

  • _SMS. SUCCESS— Le message a été accepté avec succès par le transporteur/livré au destinataire.

  • _SMS. FAILURE— Amazon Pinpoint n'a pas été en mesure de transmettre le message au destinataire. Pour en savoir plus sur l'erreur qui a empêché la remise du message, consultez attributes.record_status.

  • _SMS. OPTOUT— Le client a reçu le message et a répondu en envoyant le mot clé de désinscription (généralement STOP « »).

event_timestamp

Heure à laquelle l'événement a été signalé, affichée sous la forme Heure Unix en millisecondes.
arrival_timestamp

Heure à laquelle l'événement a été reçu par Amazon Pinpoint, affichée sous la forme Heure Unix en millisecondes.
event_version

Version du JSON schéma d'événement.

Astuce

Vérifiez la version dans votre application de traitement des événements afin de savoir à quel moment mettre à jour l'application suite à une mise à jour du schéma.
application

Informations sur le projet Amazon Pinpoint associé à l'événement. Pour plus d'informations, consultez le tableau Application.
client

Informations sur le client d'application installé sur le périphérique qui a signalé l'événement. Pour plus d'informations, consultez le tableau Client.
device

Informations sur l'appareil qui a signalé l'événement. Pour plus d'informations, consultez le tableau Appareil.

Pour les SMS événements, cet objet est vide.
session Pour les SMS événements, cet objet est vide.
attributes

Attributs associés à l'événement. Pour les événements rapportés par l'une de vos applications, cet objet peut inclure des attributs personnalisés qui sont définis par l'application. Pour les événements qui sont créés lorsque vous envoyez une campagne, cet objet contient les attributs associés à la campagne. Pour les événements qui sont générés lorsque vous envoyez des messages transactionnels, cet objet contient des informations liées au message lui-même.

Pour plus d'informations, consultez le tableau Attributs.
metrics

Métriques supplémentaires associées à l'événement. Pour plus d'informations, consultez le tableau Métriques.
awsAccountId

L'ID du AWS compte utilisé pour envoyer le message.

Application

Inclut des informations sur le projet Amazon Pinpoint auquel l'événement est associé et, le cas échéant, celles SDK qui ont été utilisées pour signaler l'événement.

Attribut Description
app_id

ID unique du projet Amazon Pinpoint qui a signalé l'événement.
sdk

Le SDK qui a été utilisé pour signaler l'événement. Si vous envoyez un SMS message transactionnel en appelant directement Amazon API Pinpoint ou en utilisant la console Amazon Pinpoint, cet objet est vide.

Attributs

Comporte des informations sur les attributs associés à l'événement.

Attribut Description
sender_request_id

Un identifiant unique associé à la demande d'envoi du SMS message.
campaign_activity_id ID unique de l'activité au sein de la campagne.
origination_phone_number

Numéro de téléphone à partir duquel le message a été envoyé.
destination_phone_number

Numéro de téléphone auquel vous avez tenté d'envoyer le message.
record_status

Informations supplémentaires sur l'état du message. Les valeurs possibles incluent :

  • SUCCESSFUL/DELIVERED— Le message a été envoyé avec succès.

  • PENDING— Le message n'a pas encore été envoyé sur l'appareil du destinataire.

  • INVALID— Le numéro de téléphone de destination n'est pas valide.

  • UNREACHABLE— L'appareil du destinataire est actuellement injoignable ou indisponible. Par exemple, l'appareil peut être éteint ou déconnecté du réseau. Vous pouvez réessayer d'envoyer le message ultérieurement.

  • UNKNOWN— Une erreur s'est produite qui a empêché la livraison du message. Cette erreur est généralement transitoire et vous pouvez essayer d'envoyer le message à nouveau ultérieurement.

  • BLOCKED— L'appareil du destinataire bloque SMS les messages provenant du numéro d'origine.

  • CARRIER_ UNREACHABLE — Un problème avec le réseau mobile du destinataire a empêché la livraison du message. Cette erreur est généralement transitoire et vous pouvez essayer d'envoyer le message à nouveau ultérieurement.

  • SPAM— L'opérateur mobile du destinataire a identifié le contenu du message comme étant du spam et a bloqué la livraison du message.

  • INVALID_ MESSAGE — Le corps du SMS message n'est pas valide et ne peut pas être délivré.

  • CARRIER_ BLOCKED — Le transporteur du destinataire a bloqué la livraison de ce message. Cela se produit souvent lorsque le transporteur identifie le contenu du message comme indésirable ou malveillant.

  • TTL_ EXPIRED — Le SMS message n'a pas pu être livré dans un certain délai. Cette erreur est généralement transitoire et vous pouvez essayer d'envoyer le message à nouveau ultérieurement.

  • MAX_ PRICE _ EXCEEDED — L'envoi du message aurait entraîné des frais supérieurs au quota de SMS dépenses mensuel de votre compte. Vous pouvez demander une augmentation de ce quota en suivant la procédure décrite dans la section Demande d'augmentation de votre quota de SMS dépenses mensuel dans le guide de l'utilisateur Amazon Pinpoint.

  • OPTED_ OUT — Le SMS message n'a pas été envoyé car le destinataire a choisi de ne pas recevoir de messages de votre part.

  • NO_ QUOTA _ LEFT _ON_ ACCOUNT — Le quota de dépenses restant sur votre compte est insuffisant pour envoyer le message. Vous pouvez demander une augmentation de ce quota en suivant la procédure décrite dans la section Demande d'augmentation de votre quota de SMS dépenses mensuel dans le Guide de l'utilisateur de la messagerie destinée à SMS l'utilisateur AWS final.

  • NO_ ORIGINATION _ IDENTITY _ AVAILABLE _TO_ SEND — Votre compte ne contient aucun numéro de téléphone pouvant être utilisé pour envoyer le message à destination.

  • DESTINATION_ COUNTRY _ NOT _ SUPPORTED — Le pays de destination est bloqué. Pour tous les pays pris en charge, consultez la section Pays et régions pris en charge (SMScanal) dans le Guide de l'utilisateur de la messagerie SMS destinée aux utilisateurs AWS finaux.

  • ACCOUNT_IN_ SANDBOX — Votre compte est dans le bac à sable et il ne peut envoyer que vers des numéros de destination vérifiés. Vous pouvez vérifier le numéro de destination dans la console Amazon Pinpoint ou lancer le processus pour déplacer le compte hors du sandbox. Consultez la section À propos du sandboxSMS/MMSand Voice dans le guide de l'utilisateur de la messagerie destinée à l'utilisateur AWS final. SMS

  • RATE_ EXCEEDED — Vous avez essayé d'envoyer un message trop rapidement et vous avez été limité. Vous devez ralentir votre débit d'appels. Pour plus de détails sur nos limites, consultez la section Limites de parties de messages par seconde (MPS) dans le Guide de l'utilisateur de la messagerie destinée à SMS l'utilisateur AWS final.

  • INVALID_ ORIGINATION _ IDENTITY — L'identité d'origine fournie n'est pas valide.

  • ORIGINATION_ IDENTITY _ DOES _ NOT _ EXIST — L'identité d'origine fournie n'existe pas.

  • INVALID_ DLT _ PARAMETERS — Des DLT paramètres non valides (obligatoires pour les destinations en Inde) ont été fournis.

  • INVALID_ PARAMETERS — Des paramètres non valides ont été fournis.

  • ACCESS_ DENIED — L'envoi de messages sur votre compte est bloqué. Contactez le service client pour en déterminer la cause et résoudre le problème.

  • INVALID_ KEYWORD — Le mot clé fourni n'est pas valide. Il se peut que le format du mot clé soit incorrect ou qu'il ne soit pas défini dans votre compte.

  • INVALID_ SENDER _ID — L'identifiant d'expéditeur fourni n'est pas valide. Le format ou la longueur de l'ID de l'expéditeur sont peut-être incorrects.

  • INVALID_ POOL _ID — L'ID de pool fourni n'est pas valide. Il se peut que le format de l'ID du pool soit incorrect ou qu'il n'appartienne pas à votre compte.

  • SENDER_ID_ _ _ NOT SUPPORTED FOR _ DESTINATION — Le pays de destination ne prend pas en charge l'identifiant de l'expéditeur. Vous devez utiliser un numéro de téléphone ou une autre identité d'origine pour l'envoi.

  • INVALID_ PHONE _ NUMBER — Le numéro de téléphone d'origine fourni n'est pas valide. Le format ou la longueur du numéro de téléphone peuvent être incorrects.
iso_country_code

Le pays associé au numéro de téléphone du destinataire, affiché au format ISO 3166-1 alpha-2.
treatment_id

ID du traitement du message, si le message a été envoyé dans une campagne A/B.
treatment_id

Si le message a été envoyé à l'aide d'une campagne de test A/B, cette valeur représente le numéro de traitement du message. Pour les SMS messages transactionnels, cette valeur est 0.
number_of_message_parts

Nombre de parties de message créées par Amazon Pinpoint pour envoyer le message.

En général, SMS les messages ne peuvent contenir que 160 à GSM 7 caractères ou 67 GSM caractères non-, bien que ces limites puissent varier en fonction du pays . Si vous envoyez un message qui dépasse ces limites, Amazon Pinpoint fractionne automatiquement les messages en plusieurs parties. Nous vous facturons en fonction du nombre de parties du message que vous envoyez.
message_id

ID unique généré par Amazon Pinpoint lorsqu'il accepte le message.
message_type

Type du message. Les valeurs possibles sont Promotional et Transactional. Vous spécifiez cette valeur lorsque vous créez une campagne ou lorsque vous envoyez des messages transactionnels à l'aide de l'SendMessagesopération Amazon API Pinpoint.
campaign_id

ID unique de la campagne Amazon Pinpoint qui a envoyé le message.
customer_context

JSONChaîne contenant le contenu de la Context carte envoyée dans le cadre d'une opération Amazon Pinpoint SendMessages.

Client

Présente des informations sur le client d'application installé sur l'appareil qui a signalé l'événement.

Attribut Description
client_id

Pour les événements générés par les applications, cette valeur est l'ID unique du client d'application installé sur l'appareil. Cet identifiant est automatiquement généré par le AWS Mobile SDK for iOS et le AWS Mobile SDK for Android.

Pour les événements qui sont générés lorsque vous envoyez des campagnes et des messages transactionnels, cette valeur est égale à l'ID du point de terminaison auquel vous avez envoyé le message.
cognito_id ID unique attribué au client d'application dans la réserve d'identités Amazon Cognito utilisée par votre application.

Appareil

Présente des informations sur l'appareil qui a signalé l'événement.

Attribut Description
locale Paramètres régionaux du périphérique.
make Fabricant du périphérique, tel qu'Apple ou Samsung.
model Modèle du périphérique, tel qu'iPhone.
platform Plateforme du périphérique, telle qu'ios ou android.

Métriques

Comprend des informations sur les métriques associées à l'événement.

Attribut Description
price_in_millicents_usd

Montant facturé pour l'envoi du message. Ce prix est indiqué en millièmes d'un cent des États-Unis. Par exemple, si la valeur de cet attribut est 645, nous vous avons facturé 0,645 ¢ pour envoyer le message (645 / 1000 = 0,645 ¢ = 0,00645 $).

Note

Cette propriété n'apparaît pas pour les messages comportant event_type un _SMS. BUFFERED.