Obtenir des message
Récupérez les détails des messages entrants et sortants et vérifiez les codes d'authentification envoyés à vos clients. Accédez à une liste de tous les messages ou recherchez des informations sur un message spécifique à l'aide de l'ID de message unique fourni lors de sa création ou de sa réception.
Exemples de cas d'utilisation
La vérification de l'utilisateur a réussi si l'en-tête X-Total-Count a la valeur 1 ou si la liste d'objets de données en réponse n'est pas vide.
Voici quelques exemples de cas d'utilisation de l'API TopMessage :
Accédez à des informations détaillées sur tous vos messages envoyés pour surveiller la livraison, suivre les performances et optimiser votre stratégie de messagerie.
Paramètres complets de la requête
Aucun paramètre de requête n'est requis.Paramètres complets de la réponse
La réponse inclut tous les paramètres de la requête, ainsi que les paramètres supplémentaires énumérés ci-dessous.| Nom | Taper | Description |
|---|---|---|
| data | object | Contient des informations sur le message. |
Data Object
| Nom | Taper | Description |
|---|---|---|
| id | string | Identifiant unique de votre message. |
| account_id | string | Identifiant unique de votre compte. |
| status | string | Statut initial de votre message. Valeurs possibles: PENDING, FAILED, DELIVERED, SEEN |
| from | string | Nom d’affichage utilisé pour l’envoi de vos messages. Vous pouvez consulter les noms disponibles ou en créer un nouveau sur la page des expéditeurs. |
| to | string[] | Le(s) numéro(s) de téléphone mobile du destinataire en format. |
| text | string[] | Le texte de votre message à envoyer au(x) destinataire(s). |
| channel | string | Le canal de communication par lequel votre message est envoyé. Valeurs possibles: SMS et WHATSAPPPar défaut: SMS |
| segment_count | integer | Le nombre de segments dans lesquels votre message a été divisé. |
| encoding | string | Encodage de votre message. Valeurs possibles: STANDARD et UNICODE |
| direction | string | Indique le flux du message — s’il a été envoyé par votre système ou reçu d’un utilisateur. Valeurs possibles: OUTBOUND, INBOUND |
| country | string | Spécifie le pays du destinataire pour les messages sortants et celui de l’expéditeur pour les messages entrants. La valeur est fournie au format ISO 3166-1 alpha-2. |
| type | string | Indique le type de contenu du message envoyé ou reçu. Cela permet d’identifier s’il s’agit d’un texte brut, d’un modèle ou d’un message multimédia (images, vidéos), y compris de contenu interactif pour WhatsApp. |
| schedule | string | Spécifie l'heure à laquelle le message doit être envoyé. L'heure doit être en UTC et suivre le format ISO-8601 ("2024-12-01T18:00:00Z"). L'heure prévue ne peut pas être définie plus d'un an à l'avance. Par défaut: Maintenant |
| create_date | string | Heure à laquelle le message a été initié. |
| update_date | string | Date de la dernière mise à jour du statut de votre message. |
GET
https://api.topmessage.be/v1/messagesX-TopMessage-Key: {API_KEY}
Content-Type: application/jsonExemple de réponse
'X-Total-Count': 1{
"data": [
{
"id": "0f15fa5d-97ef-46d5-844a-f507f1c4c461",
"account_id": "0d1f7f1c-27df-41bf-8bdc-5666608a4285",
"status": "PENDING",
"from": "TopMessage",
"to": "32471123456",
"text": "Salut ! Je teste cette super fonctionnalité SMS. https://topmessage.fr",
"channel": "SMS",
"segment_count": "1",
"encoding": "STANDARD",
"direction": "OUTBOUND",
"country": "BE",
"type": "text",
"schedule": "2024-11-10T08:11:46Z",
"create_date": "2024-11-10T08:11:46Z",
"update_date": "2024-11-10T08:11:46Z"
},
{
"id": "6fc214dc-4e51-4fce-bc0a-324a1d8a542b",
"account_id": "0d1f7f1c-27df-41bf-8bdc-5666608a4285",
"status": "PENDING",
"from": "TopMessage",
"to": "32471123457",
"text": "Je fais juste un petit test de cette fonctionnalité SMS.",
"channel": "SMS",
"segment_count": "1",
"encoding": "STANDARD",
"direction": "OUTBOUND",
"country": "BE",
"type": "text",
"schedule": "2024-11-10T08:11:46Z",
"create_date": "2024-11-10T08:11:46Z",
"update_date": "2024-11-10T08:11:46Z"
}
]
}