C'est quoi BipBip API ?

L'API de BipBip vous permet d'envoyer des SMS à n'importe quel numéro de téléphone en un seul appel REST. Notre plateforme est conçue pour la rapidité, la simplicité et la fiabilité.

99.9% Uptime Support Multi-Pays

Authentification

Incluez votre clé d'API secrète dans le header HTTP x-api-key pour authentifier chaque requête.

HTTP Headers

x-api-key: "BB_485acd055ea113..."
Content-Type: "application/json"

Sender IDs

Utilisez le texte approuvé (ex: BIPBIP) au lieu de l'ID UUID complexe pour identifier votre expéditeur.

Paramètre Format

// Exemple d'identifiant valide
"senderIdId": "BIPBIP"

POST

Envoyer un SMS

https://api.bip-bip.tn/api/v1/sms/send

Paramètres JSON

Nom

Type

Requis

Description

string

Yes

Numéro destinataire (ex: 216...)

body

string

Optional

Contenu (requis si templateId absent)

senderIdId

string

Yes

ID du Sender ID approuvé

templateId

string

ID du template à utiliser

variables

object

Variables du template (ex: {"name": "..."})

type

string

"TRANSACTIONAL" ou "MARKETING"

idempotencyKey

string

Clé d'idempotence unique

curl -X POST https://api.bip-bip.tn/api/v1/sms/send \
  -H "x-api-key: VOTRE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "21650123456",
    "body": "Votre code : 1234",
    "senderIdId": "BIPBIP"
  }'

const axios = require('axios');

axios.post('https://api.bip-bip.tn/api/v1/sms/send', {
    to: '21650123456',
    body: 'Votre code : 1234',
    senderIdId: 'BIPBIP'
}, {
    headers: { 'x-api-key': 'VOTRE_TOKEN' }
});

import requests

r = requests.post(
    "https://api.bip-bip.tn/api/v1/sms/send",
    json={"to": "21650...", "body": "Hello"},
    headers={"x-api-key": "VOTRE_TOKEN"}
)

POST

Envoie Batch

https://api.bip-bip.tn/api/v1/sms/batch

Envoyez jusqu'à 1000 messages en un seul appel d'API. Le body accepte un tableau messages où chaque objet possède les mêmes paramètres qu'un envoi simple.

Exemple de requête JSON

{
  "messages": [
    {
      "to": "21650123456",
      "body": "Notification de service",
      "senderIdId": "BIPBIP"
    },
    {
      "to": "21650123457",
      "templateId": "tmpl_123",
      "variables": { "name": "Ahmed" },
      "senderIdId": "BIPBIP"
    }
  ]
}

GET

Statut de livraison

https://api.bip-bip.tn/api/v1/sms/status/:id

Récupérez le statut d'un message existant en utilisant son id, qui a été renvoyé lors de l'appel POST initial.

GET

Solde de crédits

https://api.bip-bip.tn/api/v1/balance

Récupérez le solde de crédits de votre compte opérationnel.

Exemple de réponse JSON

{
  "credits": 1450
}

Webhooks DLR

Les webhooks vous permettent de recevoir des rapports de livraison en temps réel. Configurez une URL sécurisée (https) dans votre dashboard.

Format du Callback JSON

{
  "messageId": "msg_845acd...",
  "status": "DELIVERED",
  "phone": "21650123456",
  "timestamp": "2024-03-24T12:00:00Z"
}