API

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

Récupérer Liste des messages
Récupérer un message spécifique
Vérifier le code

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.

Paramètres complets de la requête

Aucun paramètre de requête n'est requis.

Paramètres complets de la réponse

Paramètres de 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
données	`objet`	Contient les détails ci-dessous du message envoyé.

Objet de données

Nom	Taper	Description
account_id	`string`	Identifiant unique de votre compte.
id	`string`	Identifiant unique de votre message.
from	`string`	Nom d'affichage à partir duquel votre message sera envoyé.
to	`string[]`	Le(s) numéro(s) de téléphone mobile du destinataire en format.
status	`string`	Statut initial de votre message. Valeurs possibles: `PENDING`, `FAILED`, `DELIVERED`, `SEEN`
channel	`string`	Le canal de communication par lequel votre message est envoyé. Valeurs possibles: `SMS` et `WHATSAPP` Par défaut: `SMS`
text	`string`	Le texte de votre message à envoyer au(x) destinataire(s).
template_id	`string`	Identifiant unique de votre modèle envoyé.
parameters	`string[]`	Ces valeurs sont utilisées pour remplacer les espaces réservés dans votre modèle de message, permettant de personnaliser le message pour chaque destinataire. Par défaut: Vide
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`
country	`string`	Pays de destination du destinataire de votre message.
direction	`string`	Indique si le message est reçu par votre système ou envoyé depuis votre système au destinataire. Valeurs possibles: `OUTBOUND`, `INBOUND`
type	`string`	Détermine la structure du contenu du message. Valeurs possibles: `TEXT`, `TEMPLATE`
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.
code	`string`	Code fourni par l'utilisateur, 4 à 6 chiffres
expired	`boolean`	Indique si le code est expiré. Valeurs possibles: `TRUE`, `FALSE` Par défaut: `FALSE`

Récupérer Liste des messages

GET

https://api.topmessage.com/v1/messages

Récupérer un message spécifique

GET

https://api.topmessage.com/v1/messages/{Id}

Vérifier le code

GET

https://api.topmessage.com/v1/messages?to={receipnet_number}&code={code}&expired=false

X-TopMessage-Key: {API_KEY}
Content-Type: application/json

Exemple de réponse

'X-Total-Count': 1

{
    "data": [
        {
            "id": "b63ddae0-48c4-4e81-879c-2170a05051ca",
            "account_id": "0d1f7f1c-27df-41bf-8bdc-5666608a4285",
            "from": "19134216816",
            "to": "48727516980",
            "channel": "SMS",
            "status": "DELIVERED",
            "text": "Hi there! Just testing out this cool SMS feature. https://topmessage.com",
            "segment_count": 1,
            "direction": "OUTBOUND",
            "country": "US",
            "type": "TEXT",
            "template": {
                "id": "67d0c347-d946-49ed-958f-3de966278525"
            },
            "schedule": "2024-11-20T08:11:46Z",
            "create_date": "2024-11-25T08:35:13Z",
            "update_date": "2024-11-25T08:35:14Z"
        }
    ]
}