TopMessage API Documentation | Envoyer des messages

Authentification

Lorsque vous effectuez des requêtes API, vous devez inclure votre clé API dans l'en-tête HTTP. Le format de l'en-tête doit ressembler à ceci :

X-TopMessage-Key: {API_KEY}

Gérez vos clés API

ici

Envoyer des message

Envoyez facilement un ou plusieurs messages à vos clients via leurs canaux préférés, tels que SMS et WhatsApp, à l'aide d'une API unique et unifiée. Commencez par un simple message texte en définissant la destination et le contenu, ou exploitez des fonctionnalités avancées pour améliorer votre stratégie de communication.

Exemples de cas d'utilisation

Voici quelques exemples de cas d'utilisation de l'API TopMessage :

Envoyez un SMS unique – parfait pour une communication directe en tête-à-tête, comme des alertes ou des confirmations.

Paramètres complets de la requête

Nom	Taper	Description
data	`object`	Contient des informations sur le message.

Data Object

Nom	Taper	Description
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. Aller à la page des expéditeurs TopMessage
to	`string[]`	Le(s) numéro(s) de téléphone mobile du destinataire en format. 33611123456
text	`string`	Le texte de votre message à envoyer au(x) destinataire(s). Salut ! Je teste cette super fonctionnalité SMS. https://topmessage.fr

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. Aller à 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 `WHATSAPP` Par 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.

POST

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

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

Exemple de demande

Payload

cURL

Java

Python

PHP

Node.js

{
    "data": {
        "from": "TopMessage",
        "to": [
            "33611123456"
        ],
        "text": "Salut ! Je teste cette super fonctionnalité SMS. https://topmessage.fr"
    }
}

Exemple de réponse

{
    "data": [
        {
            "id": "0f15fa5d-97ef-46d5-844a-f507f1c4c461",
            "account_id": "0d1f7f1c-27df-41bf-8bdc-5666608a4285",
            "status": "PENDING",
            "from": "TopMessage",
            "to": "33611123456",
            "text": "Salut ! Je teste cette super fonctionnalité SMS. https://topmessage.fr",
            "channel": "SMS",
            "segment_count": "1",
            "encoding": "STANDARD",
            "direction": "OUTBOUND",
            "country": "FR",
            "type": "text",
            "schedule": "2024-11-10T08:11:46Z",
            "create_date": "2024-11-10T08:11:46Z",
            "update_date": "2024-11-10T08:11:46Z"
        }
    ]
}