Documentation de l’API REST
API REST SMS & MMS
Envoyez des messages d'application approuvés et gérez l'acceptation, les événements de livraison, la segmentation et les frais.
Choisir l’API et l’identifiant ensemble
Les comptes approuvés Développeurs et automatisation, Entreprise et Fournisseur de communications peuvent intégrer les services activés. Un développeur individuel n’a pas besoin de se présenter comme une entreprise. Les SMS/MMS applicatifs exigent l’approbation d’envoi et l’inscription applicables. Le service Particuliers et famille ne dispose d’aucune API d’émission de messages accessible au client.
| Famille d’API | URL de base | Authentification et résultat |
|---|---|---|
| Communications v3 | https://api.multitel.net/v3 | Identifiants Basic approuvés ; jetons provisionnés éligibles uniquement pour les opérations qui les prennent en charge. JSON status et response. |
| Enregistrement d’urgence | https://api.multi.tel/emergency | Identifiants Basic approuvés ou accès par jeton bearer spécialement configuré. JSON code, message et data. |
| Intégrations REST du portail | Hôte et opération indiqués dans la référence développeur de votre compte | Utilisez les identifiants d’authentification, les portées et le schéma documentés pour cette opération. Les requêtes de session du navigateur sont distinctes. |
Définissez MULTITEL_API_USERNAME et MULTITEL_API_PASSWORD dans la configuration des secrets de votre serveur avant d’utiliser les exemples. Ne les intégrez jamais au JavaScript public du navigateur, aux URL ou à un dépôt de code source. Les identifiants dédiés sont gérés dans les paramètres d’intégration API.
Préparer une demande SMS
Utilisez un numéro d’envoi approuvé, compatible SMS et détenu par le compte, un destinataire ayant consenti au message, ainsi que l’enregistrement de marque/campagne ou la vérification de numéro sans frais requis. L’exemple ci-dessous envoie un véritable message lorsqu’il contient des identifiants et des numéros valides ; il ne s’agit pas d’un environnement de test.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
--request POST \
--header "Content-Type: application/json" \
--data '{"from":"YOUR_APPROVED_NUMBER","to":"YOUR_CONSENTED_RECIPIENT","text":"Your requested update is ready."}' \
"https://api.multitel.net/v3/sendsms"Remplacez les espaces réservés d’expéditeur et de destinataire par des chiffres internationaux incluant l’indicatif de pays. Pour un MMS, fournissez l’URL de média publiquement récupérable et prise en charge dans media et vérifiez d’abord l’éligibilité MMS et la tarification.
L’acceptation n’est pas la livraison
Vérifiez à la fois le statut applicatif externe et le résultat de messagerie renvoyé. Enregistrez l’identifiant de message fourni par le service, et suivez le statut de livraison et les événements webhook. Une soumission réussie ne prouve pas que le téléphone du destinataire a reçu le message.
La facturation SMS s’effectue par segment. L’encodage et la longueur du message peuvent produire plusieurs segments ; les frais liés aux médias et aux opérateurs peuvent différer des SMS. Lisez le prix de vente actuel du compte avant l’envoi. Ne réessayez jamais aveuglément un envoi expiré : vérifiez d’abord son résultat enregistré.
Gérer les erreurs et les nouvelles tentatives
- Échec d’authentification ou d’autorisation
- Vérifiez l’état d’activation de l’identifiant API, le service autorisé et la restriction d’adresse IP source. Un cookie de session du portail n’est pas un identifiant d’intégration.
- Crédit insuffisant ou approbation manquante
- Régularisez le solde du compte, obtenez l’approbation d’envoi ou fournissez les documents requis avant de répéter l’opération.
- Aucun résultat
- Considérez un inventaire vide ou un nom d’appelant manquant comme un résultat ordinaire. Ne supposez pas qu’un numéro syntaxiquement valide dispose de tous les services.
- Délai d’attente réseau ou défaillance de service
- Utilisez des nouvelles tentatives limitées avec attente progressive pour les lectures. Pour un achat, un envoi ou une inscription, vérifiez d’abord l’état de l’opération ; réessayer une demande acceptée peut dupliquer une action facturable.
La prise en charge de l’idempotence dépend de chaque famille d’API. L’API Emergency prend en charge les clés de nouvelle tentative ; cela ne rend pas idempotentes les demandes v3 arbitraires. Conservez les horodatages, les identifiants renvoyés et les réponses expurgées pour l’assistance.
Poursuivez avec la référence de votre compte
La documentation accessible après connexion affiche les opérations correspondant à vos autorisations et aux services activés. Utilisez l’hôte exact, le type d’identifiant d’authentification, les champs de requête et le schéma de réponse indiqués. Les consoles peuvent exécuter des opérations réelles, notamment des achats et des envois de messages.