L'objet MessageItem
Un objet MessageItem représente un message dans la plateforme Reach.
En utilisant l'API Reach Messaging, il est possible de :
- Envoyer de nouveaux messages
- Obtenir des informations d'un message particulier à partir de son identifiant
- Lister des messages qui vérifient certaines conditions
- Mettre à jour le contenu des messages existants
- Déprogrammer les messages précédemment programmés
- Supprimer les messages existants de la plateforme
Attributs de MessageItem
appletIdstring
L'identifiant de l'applet qui envoie ou reçoit le message.
apiVersionstring
La version de l'API utilisée pour traiter le message.
bodystring
Le contenu du message.
deststring
Le numéro de téléphone en format E.164 récipiendaire du message.
srcstring
Le numéro de téléphone (en format E.164) ou l'identifiant alphanumérique de l'expéditeur à l'origine du message.
bulkIdstring
L'identifiant 'bulk' (c-à-d d'envoi de masse) permettant de regrouper les messages et d'avoir des statistiques correspondantes.
numSegmentsinteger
Le nombre de segments associés au message. Le contenu d'un message trop volumineux pour être envoyé en un seul SMS est segmenté en plusieurs messages et facturé comme tel. Les segments sont réassemblés une fois reçus par le téléphone de destination. Un message peut comporter un maximum de 10 segments. Reportez-vous à cette section pour plus de détails.
numMediainteger
Nombre de fichiers multimédias inclus dans le message.
pricenumber
Le coût facturé pour le message, dans la devise spécifiée par
priceUnit.priceUnitstring
La devise, au format ISO 4127, dans laquelle le prix est facturé. Par exemple,
usd,xaf,eur,cad.messageIdstring
L'identifiant du message.
statusstring
Le statut du message. Les differentes valeurs sont:
sent,scheduled,failed,delivered,undelivered,canceled,accepted,queued,sending,received,receiving. Pour plus d'informations, voir la description détaillée.messageTypestring
Le type de message. Peut être :
inboundpour les messages entrants,outboundpour les messages initiés par l'API.errorCodeinteger
Le code d'erreur retourné si le statut du message est
failedouundelivered. Le message d'erreur fournit plus d'informations sur les caused de l'échec. La valeur estnullsi le message a été envoyé avec succès.errorMessagestring
Le message d'erreur retourné si le statut du message est
failedouundelivered. La valeur estnullsi le message a été envoyé avec succès.dateCreateddate-time
La date et l'heure (UTC) auxquelles le message a été créé.
dateSentdate-time
La date et l'heure (UTC) auxquelles le message a été envoyé.
dateUpdateddate-time
Date et heure (UTC) de la dernière mise à jour du message.
Nombre de segments d'un message
Le nombre de segments est une propriété importante des messages SMS.
Lors de l'envoi d'un SMS, si le contenu du SMS est supérieur à 160 caractères GSM-7 ou 70 caractères UCS-2, le SMS est segmenté en plusieurs parties et chaque partie est annotée de manière à faciliter le réassemblage du SMS sur l'appareil de destination.
Inversement, lors de la réception d'un SMS, si celui-ci est composé de plusieurs segments, l'API Reach Messaging réassemble les différents segments pour former un seul et unique message.
Vous serez facturé pour chaque segment envoyé ou reçu.
Les differents statuts d'un MessageItem
L'attribut status est destiné à décrire l'étape dans laquelle se trouve un message donné. Le tableau suivant décrit les différentes valeurs de statut d'un objet MessageItem outbound dans la plateforme Reach.
| Valeur du statut | Description |
|---|---|
accepted | La plateforme Reach a accepté votre demande d'envoi de message. |
scheduled | Le message est programmé pour être envoyé plus tard dans le futur. Ce statut n'est obtenu que lors de la programmation d'un message. |
queued | Le message est en file d'attente et sera envoyé dès que possible. |
sending | La plateforme Reach est en train d'envoyer les segments composant le message à l'opérateur de réseau le plus proche. |
sent | L'opérateur de réseau le plus proche a accepté le message. |
delivered | La plateforme Reach a reçu une confirmation de la livraison du message au numéro de destination. |
undelivered | La plateforme Reach a reçu un accusé de réception indiquant que le message n'a pas été délivré. Il y a plusieurs causes à cette situation, y compris la politique d'utilisation acceptable et de filtrage de l'opérateur du réseau ou la disponibilité de l'appareil de destination. |
failed | Le message n'a pas pu être envoyé. Il y a plusieurs causes à cette situation, y compris des débordements de file d'attente, ou des crédits insuffisants. Vous n'êtes pas facturé dans ce cas. |
canceled | Le message a été annulé. |
Le tableau suivant décrit les différents statuts d'un objet MessageItem inbound dans la plateforme Reach.
| Valeur du statut | Description |
|---|---|
receiving | Le message a été reçu par la plateforme Reach et est en cours de traitement. |
received | Le message a été reçu par la plateforme Reach et son traitement est terminé. |