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. Chacun des points de terminaison listés ci-dessous retourne un maximum de 100 entrées. Vous pouvez utiliser les paramètres offset et limit pour interroger des pages plus profondes de vos journaux.

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.
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.

GET

Messages envoyés

Vous pouvez utiliser ce point de terminaison pour interroger les dernières entrées de vos journaux. Vous recevrez un maximum de 100 entrées pour chaque requête.

Requête

GET

/api/journal/outbound

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:50:63.102",
    "mccmnc": "26207",
    "latency": "14.3830",
    "type": "direct",
    "channel": "RCS",
    "connection": "http",
    "label": null,
    "foreign_id": null
  },
  {
    "id": "77231715551"
    // ...
  }
]

GET

SMS reçus

Vous pouvez utiliser ce point de terminaison pour interroger les messages SMS que vous avez reçus. Vous recevrez un maximum de 100 entrées pour chaque requête.

Requête

GET

/api/journal/inbound

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": null
  },
  {
    "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
  },
  {
    // ...
  }
]

GET

Messages vocaux

Vous pouvez utiliser ce point de terminaison pour interroger les dernières entrées de vos journaux. Vous recevrez un maximum de 100 entrées pour chaque requête.

Requête

GET

/api/journal/voice

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"
    // ...
  }
]