Journal
Le point de terminaison API pour interroger les journaux offre une interface directe pour obtenir des informations sur les messages envoyés et reçus. Ce point de terminaison est essentiel pour surveiller la communication des messages ou pour détecter les erreurs de transmission. Il fournit les données nécessaires pour analyser de manière transparente le traitement et l'échange de messages au sein de l'application.
Vous pouvez utiliser des paramètres pour restreindre la recherche afin d'obtenir exactement les données dont vous avez besoin. Par défaut, chacun des points de terminaison listés ci-dessous retourne jusqu'à 100 entrées. Vous pouvez parcourir vos journaux avec offset et limit (max. 100 par requête) ou avec show_page et items (max. 10000 par requête).
Toutes les valeurs horaires (timestamp, dlr_timestamp) sont renvoyées en heure locale allemande (fuseau horaire Europe/Berlin, CET/CEST) sans décalage UTC. Les paramètres date_from et date_to se réfèrent également à ce fuseau horaire.
Paramètres optionnels
- Name
id- Type
- integer
- Description
L'ID du message.
- Name
date_from- Type
- timestamp
- Description
Date de début à partir de laquelle rechercher au format YYYY-MM-DD 2020-01-01.
- Name
date_to- Type
- timestamp
- Description
Date de fin jusqu'à laquelle la recherche doit être effectuée au format YYYY-MM-DD 2020-05-30.
- Name
state- Type
- string
- Description
Statut du message. Cela pourrait être par exemple completed / failed pour Voice ou DELIVERED / NOTDELIVERED etc. pour SMS. Non disponible pour les messages reçus.
- Name
to- Type
- string
- Description
Numéro de téléphone du destinataire dans n'importe quel format.
- Name
limit- Type
- integer
- Description
Limite le nombre d'entrées à retourner. Doit être un entier entre 1-100.
- Name
offset- Type
- integer
- Description
Point de départ à partir duquel les entrées doivent être interrogées.
- Name
show_page- Type
- integer
- Description
Page à interroger, à partir de 1. Ignoré si
offsetest défini.
- Name
items- Type
- integer
- Description
Nombre d'entrées par page avec
show_page. Doit être un entier entre 1-10000. Ignoré sioffsetest défini.
Messages envoyés
Vous pouvez utiliser ce point de terminaison pour interroger les dernières entrées de vos journaux. Par défaut, vous recevez jusqu'à 100 entrées par requête.
Requête
curl -G "https://gateway.seven.io/api/journal/outbound" \
-H "X-Api-Key: VOTRE_CLÉ_API"
Réponse
[
{
"id": "77231715575",
"to": "49176123456789",
"from": "sender",
"text": "Hello World",
"timestamp": "2024-02-13 05:50:58.802",
"price": "0.0750",
"dlr": "DELIVERED",
"dlr_timestamp": "2024-02-13 05:51:13.185",
"mccmnc": "26207",
"latency": "14.3830",
"type": "direct",
"channel": "RCS",
"connection": "http",
"label": null,
"foreign_id": null
},
{
"id": "77231715551"
// ...
}
]
Messages reçus
Vous pouvez utiliser ce point de terminaison pour interroger les messages que vous avez reçus, p. ex. SMS et WhatsApp. Par défaut, vous recevez jusqu'à 100 entrées par requête.
Requête
curl -G "https://gateway.seven.io/api/journal/inbound" \
-H "X-Api-Key: VOTRE_CLÉ_API"
Réponse
[
{
"id": "4603396",
"from": "49176123456789",
"to": "49151123456789",
"text": "Génial ! Votre message a été reçu.",
"timestamp": "2025-01-16 12:53:17",
"reply_to_message_id": "77258554687",
"price": 0
},
{
"id": "1865514",
"from": "49176123456789",
"to": "49151123456789",
"text": "Votre code est : 1035. Ne le partagez avec personne.",
"timestamp": "2024-03-03 00:17:02",
"reply_to_message_id": null,
"price": 0.01
},
{
// ...
}
]
Messages vocaux
Vous pouvez utiliser ce point de terminaison pour interroger les dernières entrées de vos journaux. Par défaut, vous recevez jusqu'à 100 entrées par requête.
Requête
curl -G "https://gateway.seven.io/api/journal/voice" \
-H "X-Api-Key: VOTRE_CLÉ_API"
Réponse
[
{
"id": "1429729",
"from": "49157123456789",
"to": "49176123456789",
"xml": false,
"text": "Bonjour, votre code d'authentification est : 1 2 3 4 5 6.",
"duration": "17",
"status": "completed",
"error": null,
"timestamp": "2024-03-01 14:20:03",
"price": "0.045"
},
{
"id": "1429671"
// ...
}
]