Lister les préfixes d’une zone

Avant de commencer

Choisissez une zone avec getareas. Copiez l’identifiant de zone depuis sa réponse ou le lien next_function renvoyé. Pour une zone des États-Unis ou du Canada, utilisez getstates si vous souhaitez restreindre les résultats à un État ou à une province.

Lire le résultat

Vérifiez status.code dans le corps JSON ainsi que le statut HTTP. Les résultats obtenus avec succès figurent dans le tableau response. Par défaut, la réponse est triée par nom. available est une estimation, et les indicateurs du catalogue ne dispensent pas de vérifier les capacités réelles du numéro choisi et ses exigences d’enregistrement.

Choisir l’étape suivante

Utilisez un résultat non regroupé. Lorsque returns_numbers vaut 1, le lien next_function renvoyé mène à une recherche de numéros. Lorsque cet indicateur vaut 0, les numéros sont attribués lors de la commande et le chemin mène à une opération de commande. Examinez l’opération et ses exigences avant d’envoyer la requête : une commande peut entraîner une facturation sur votre compte. N’appelez pas automatiquement tous les chemins renvoyés.

Aucun prix n’est inclus ici. Consultez le devis applicable, les documents requis et les instructions de commande avant d’acheter. Conservez les identifiants individuels de préfixe et de devis renvoyés au lieu de les construire à partir d’un préfixe téléphonique affiché.

Options d’affichage avancées

compact=1 renvoie un échantillon mélangé d’au plus 100 lignes, et non une page d’un ensemble de résultats plus vaste. Le regroupement crée des lignes récapitulatives et des identifiants synthétiques ; utilisez une réponse ordinaire non regroupée pour choisir un préfixe individuel. Ne présentez pas des résultats échantillonnés ou regroupés comme un inventaire exhaustif ou une preuve de capacités exactes.

Requête

Utilisez les identifiants de votre compte API activé via HTTPS. L’authentification Basic et les jetons bearer des comptes API activés sont pris en charge ; les restrictions du compte s’appliquent.

Utilisez GET et transmettez les paramètres facultatifs dans la chaîne de requête. Ne vous appuyez pas sur un repli vers le corps d’un formulaire.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/getprefixes/$AREA_ID?state=NY"

Réponse

L’enveloppe JSON standard status/response. status.results compte les lignes renvoyées, y compris lors d’un échantillonnage ou d’un regroupement. response contient des objets de préfixe. Aucun champ de prix n’est renvoyé. Dans une réponse ordinaire non regroupée, uuid est l’identifiant du préfixe ; area_uuid et country_uuid sont des identifiants renvoyés ; prefix et name sont des informations d’affichage ; available est une estimation de disponibilité et non une réservation ; needs_registration et restrictions décrivent les informations d’enregistrement ; sms_coverage, is_mobile et number_type sont des indications du catalogue, sans garantie des capacités d’un numéro donné. number_type peut être vide ou contenir une autre chaîne du catalogue ; n’exigez donc pas une énumération fixe. state est une chaîne qui peut être vide ou contenir une mise en forme du catalogue. latitude et longitude peuvent être vides. metered et overflow sont des indicateurs du catalogue, pas des montants monétaires. returns_numbers sélectionne une route de liste de numéros (1) ou une route d’attribution lors de la commande (0). next_function identifie cette route suivante. Les réponses regroupées contiennent aussi des caractéristiques fusionnées, notamment des valeurs de repli ; ne les interprétez pas comme des capacités vérifiées pour chaque numéro.

Exemple de structure de réponse ; il ne s’agit ni de données de compte en temps réel ni d’un devis actuel.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "uuid": "PREFIX_ID_FROM_RESPONSE",
      "area_uuid": "AREA_ID_FROM_RESPONSE",
      "country_uuid": "COUNTRY_ID_FROM_RESPONSE",
      "prefix": "+1212",
      "name": "Example area",
      "metered": 0,
      "overflow": 0,
      "needs_registration": 0,
      "restrictions": "",
      "state": "NY",
      "country_iso": "US",
      "is_mobile": 0,
      "number_type": "local",
      "latitude": "",
      "longitude": "",
      "available": 12,
      "sms_coverage": 1,
      "returns_numbers": 1,
      "next_function": "v3/getnumbers/PREFIX_ID_FROM_RESPONSE"
    }
  ]
}

Erreurs

• 404 : Invalid area ID : obtenez un identifiant de zone actuel via les appels de découverte.
• 404 : State filter is only available for US and CA : omettez state pour les autres pays.
• 404 : Invalid state : utilisez un État ou une province renvoyé par getstates pour ce pays.
• 404 : No prefixes found : aucune ligne correspondante du catalogue n’a été renvoyée. Cela ne prouve pas qu’un numéro donné ne pourra jamais être commandé.
• 500 : erreur : 'Failed loading prefixes' : la recherche dans le catalogue a échoué. Réessayez plus tard et contactez l’assistance si le problème persiste.

Disponibilité et effets de bord

• Il s’agit d’une étape de découverte, pas d’une confirmation de commande. La disponibilité peut être actualisée par des consultations supplémentaires du catalogue ; le délai de réponse peut donc varier.
• Les prix ne sont pas renvoyés. Récupérez le devis applicable au numéro ou à la commande et examinez les exigences d’enregistrement avant de passer commande.
• Ne traitez pas available comme un décompte précis du stock, zéro comme une interdiction universelle de commander, ni une recherche réussie comme une réservation. La disponibilité peut changer avant la commande.