Documentation de l’API REST

API REST d'appel d'urgence

Enregistrez un numéro et une adresse de service, suivez son statut d'activation et maintenez l'enregistrement lorsque le lieu change.

Ouvrir la référence spécifique au compte Développeurs et automatisation

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 la couverture sans inscrire de numéro

curl --fail-with-body \
  --user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
  --header "Accept: application/json" \
  "https://api.multi.tel/emergency/coverage?environment=production"

https://api.multitel.net/emergency est également prise en charge. Aucune URL de base d’urgence ne contient /v3. La couverture répertorie les pays internationaux, les types de numéros pris en charge et les tarifs ; l’éligibilité E911 nord-américaine est vérifiée lors de l’inscription.

{
  "code": 200,
  "message": "",
  "environment": "production",
  "requestId": "EXAMPLE_REQUEST_ID",
  "data": {}
}

Ceci illustre uniquement l’enveloppe. Lisez le schéma data de chaque opération dans le guide publié de l’API Emergency.

Enregistrez le numéro, suivez son statut, puis configurez les appels

Pour les États-Unis/Canada et les autres régions E911 nord-américaines prises en charge, fournissez le numéro, l’adresse E911 et les attestations de consentement requises. L’E911 nord-américain est réservé à la production.
Pour un numéro international détenu et pris en charge, fournissez soit une référence de document enregistrée, soit l’identité et l’adresse de l’utilisateur final. Vérifiez d’abord les exigences par pays et par type de numéro.
Envoyez une seule demande POST /registrations. Une Idempotency-Key facultative identifie une modification logique ; conservez-la ainsi que la charge utile exacte lors des nouvelles tentatives.
Lisez GET /registrations/:number. Vérifiez le cycle de vie, pending et actionRequired ; apportez les corrections requises. L’acceptation ou l’état en attente ne constitue pas un service actif.
Après l’activation, configurez le bon numéro d’identification de l’appelant pour les urgences et la règle d’acheminement propre au pays. Utilisez la procédure de vérification du service qui ne passe pas par les services d’urgence.

Les inscriptions internationales en bac à sable sont isolées et n’activent pas de véritables appels d’urgence. Les identifiants du compte principal sont requis pour l’E911 nord-américain ; le guide explique la prise en charge limitée des sous-comptes internationaux.

Configuration et vérification dans le portail Couverture par pays et numéros d’urgence Guide public complet des demandes, champs, statuts et nouvelles tentatives

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.

Catalogue des points de terminaison de votre compte Console REST Communications Document OpenAPI public des communications Guide d'intégration OAuth