Documentation de l’API REST
API REST des numéros de téléphone
Découvrez les pays et numéros disponibles, inspectez l'offre complète et gérez les numéros que vous possédez.
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.
Consulter le catalogue des pays disponibles
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getcountries"La réponse v3 contient status et un tableau response. Les entrées de pays comprennent isocode, name, countrycode, des informations de capacité et next_function. La disponibilité dépend du compte et de l’inventaire ; un pays ne garantit pas que chaque préfixe ou type de numéro soit en stock.
{
"status": {
"code": 200,
"msg": "Results: 1"
},
"response": [
{
"countrycode": "1",
"name": "United States",
"description": "United States",
"isocode": "US",
"is_mobile": 0,
"sms_coverage": 1,
"latitude": "37.0902",
"longitude": "-95.7129",
"next_function": "v3/getareas/US"
}
]
}De la découverte à l’activation
- Choisissez le pays, la subdivision le cas échéant, la zone et le type de numéro à l’aide des opérations géographiques correspondantes.
- Consultez les frais de mise en service, les tarifs mensuels et à l’usage, les canaux, les minutes incluses et les exigences d’enregistrement du numéro sélectionné.
- Soumettez les documents requis de l’utilisateur final et vérifiez leur statut. Un numéro peut rester en attente jusqu’à son approbation.
- Commandez une seule fois avec la sélection exacte d’inventaire et de tarif. Si la réponse est incertaine, vérifiez votre inventaire avant de soumettre une autre commande.
- Configurez séparément l’acheminement des appels et la réception des messages, puis testez l’ensemble du parcours prévu.
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.