Documentation de l’API REST
API REST de recherche de routage LRN
Recherchez le numéro d’acheminement et les informations disponibles sur l’opérateur d’un numéro de téléphone nord-américain, à un tarif fixe.
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.
Rechercher un numéro
GET /v3/lrn/{number} accepte le numéro de destination dans le chemin. Un numéro d’origine facultatif peut être fourni sous la forme /v3/lrn/{number}/{ani} pour les informations dépendantes de l’origine. Utilisez les chiffres nord-américains avec l’indicatif de pays le cas échéant ; les exemples utilisent des numéros fictifs réservés.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/lrn/12025550123"curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/lrn/12025550123/12025550124"L’exécution d’une recherche avec des identifiants valides est facturable. Le tarif est de 0,00025 $US par recherche : 0,25 $US pour 1 000 ou 250 $US par million. Il n’y a aucune remise sur volume. Il s’agit d’une recherche d’informations d’acheminement ; elle ne passe aucun appel téléphonique.
Lire le résultat
{
"status": {
"code": 200,
"msg": "Success"
},
"response": {
"lrn": "12025550123",
"ported": 0,
"ocn": "",
"lata": "",
"rc": "",
"cost": "$0.00025"
}
}Cet exemple inventé illustre uniquement la forme de la réponse ; ce n’est pas un résultat d’acheminement mesuré. Vérifiez status.code avant d’utiliser response. Le champ cost est une chaîne préfixée par une devise, et non un nombre JSON.
| Champ | Signification |
|---|---|
lrn | Numéro d’acheminement (Location Routing Number) utilisé pour identifier la destination d’acheminement. |
ported | Indicateur de portabilité fourni par cette recherche : généralement 0 ou 1. Ne l’utilisez pas comme preuve de propriété ou d’éligibilité au service. |
ocn | Numéro d’entreprise d’exploitation (Operating Company Number), lorsqu’il est fourni. |
lata | Zone d’accès et de transport locale (Local Access and Transport Area), lorsqu’elle est fournie. |
rc | Centre tarifaire (rate center), lorsqu’il est fourni. |
city, state, lec, lectype, jurisdiction, local | Détails supplémentaires de localisation, d’opérateur ou liés à l’origine, lorsqu’ils sont disponibles. Ils peuvent être absents ou vides. |
N’exigez pas que chaque champ d’acheminement soit présent. En particulier, les résultats concernant des numéros sans frais peuvent omettre les détails du centre tarifaire local et du code d’opérateur. Un LRN renvoyé n’est ni une garantie en temps réel de joignabilité ni un test de qualité d’appel.
Utiliser les recherches dans votre flux d’acheminement
- Validez et normalisez le numéro demandé avant de l’envoyer.
- Vérifiez les statuts HTTP et applicatif. Conservez un enregistrement expurgé du numéro, de l’heure et du résultat pour le dépannage.
- Utilisez uniquement les champs pertinents pour votre règle d’acheminement et traitez explicitement les valeurs absentes.
- Limitez les nouvelles tentatives après une réponse incertaine. Répéter une recherche peut entraîner de nouveaux frais ; ce point de terminaison ne dispose d’aucune clé d’idempotence documentée.
Voir le service LRN et le tarif fixe par recherche. Le chemin OpenAPI public comprend un segment ANI ; l’implémentation LRN déployée accepte aussi la requête plus courte sans ANI. lrninfo est une opération distincte et ne doit pas remplacer ce point de terminaison.
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.