API SMS AfrikLink

Intégrez l'envoi de SMS transactionnels et marketing dans vos applications avec notre API RESTful haute performance. Connectée directement aux opérateurs d'Afrique de l'Ouest, elle garantit une délivrabilité maximale.

Toutes les requêtes doivent être effectuées en HTTPS. L'API est versionnée, la version actuelle est v1.

Authentification

L'authentification s'effectue via une clé API (API Key) qui doit être transmise dans chaque requête via l'en-tête HTTP X-API-Key.

Vous pouvez générer, révoquer et gérer vos clés API dans la section Développeurs de votre tableau de bord.

Exemple de Header

X-API-Key: sk_live_YourSecretApiKeyHere...

Envoyer un SMS

Utilisez cet endpoint pour envoyer un message SMS unitaire à un numéro mobile.

POST https://api.afriklink.com/v1/sms/send

Paramètres du Body

Paramètre	Requis	Description
to	Oui	Le numéro du destinataire au format international E.164 (ex: `+22177...`).
message	Oui	Le contenu du message. Un SMS standard contient 160 caractères. Les messages plus longs sont automatiquement segmentés.

Exemple de Requête (cURL)

Terminal

curl -X POST https://api.afriklink.com/v1/sms/send \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+221770000000",
    "message": "Bonjour, ceci est un test AfrikLink."
  }'

Réponse Succès (201 Created)

JSON

{
  "status": "success",
  "message": "SMS queued successfully",
  "data": {
    "message_id": "msg_123456789",
    "recipient": "+221770000000",
    "segments": 1,
    "cost": 15
  }
}

Webhooks & DLR

Nous envoyons des notifications HTTP POST (Webhooks) à votre URL de callback à chaque changement de statut d'un message (Delivered, Failed, etc.).

Important

Votre serveur doit répondre avec un code statut HTTP 200 OK pour confirmer la réception du webhook. Sinon, nous réessayerons ultérieurement.

Payload (POST)

{
  "event": "sms.status.updated",
  "data": {
    "message_id": "msg_123456789",
    "status": "DELIVERED",
    "timestamp": "2023-10-25T10:00:00Z",
    "parts": 1
  }
}