Développeurs

GET/v3/get_document_number_types/{country}

Lister les types de numéros pour l’enregistrement

Rechercher les noms des types de numéros actuellement présents dans le catalogue d’enregistrement pour un pays.

Sur cette page
  1. Choisir un type à partir du nom renvoyé
  2. Le nombre de groupes ne correspond pas au stock de numéros
  3. Requête
  4. Réponse
  5. Erreurs
  6. Disponibilité et effets de bord

Choisir un type à partir du nom renvoyé

Utilisez un pays provenant de get_document_countries. Transmettez le nom du type renvoyé à get_requirements. Un identifiant de type dans le catalogue n’est ni un identifiant de préfixe, ni un identifiant de numéro, ni un identifiant de catégorie de justificatif.

Le nombre de groupes ne correspond pas au stock de numéros

available_groups compte les enregistrements de groupes renvoyés par cette consultation du catalogue. Il ne compte pas les numéros de téléphone disponibles à l’achat, ne réserve aucun stock et ne garantit pas que toutes les pages en amont ont été parcourues par le catalogue. Recherchez les numéros dans le stock concerné et examinez un devis séparément.

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.

GET avec tout paramètre documenté dans le chemin de l’URL.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_document_number_types/$COUNTRY_ISO"
Paramètres de chemin
NomTypeObligatoireDescription
countrystringOuiCode ISO du pays à deux lettres provenant du catalogue des pays d’enregistrement. Les espaces en début et en fin sont supprimés et le code est converti en majuscules.

Réponse

Vérifiez status.code dans le corps JSON ainsi que le statut HTTP. response est un tableau contenant id, name et available_groups. Utilisez name comme valeur de number_type lors de l’appel à get_requirements ; n’envoyez pas id à sa place. available_groups correspond au nombre d’enregistrements de groupes renvoyés pour ce type, et non au nombre de numéros de téléphone en stock ni à un total complet couvrant toutes les pages. Les types pour lesquels aucun groupe n’est renvoyé sont omis. L’ordre privilégié est Local, Mobile, National, Toll Free, Shared Cost, Global, puis les autres noms du catalogue.

Structure de réponse fournie à titre d’illustration ; 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": [
    {
      "id": "NUMBER_TYPE_ID_FROM_RESPONSE",
      "name": "Local",
      "available_groups": 3
    }
  ]
}

Erreurs

  • 400: country is required: fournissez le code ISO du pays d’enregistrement.
  • 400: Invalid country ISO or no available DID registration country found: sélectionnez un pays dans le catalogue d’enregistrement actuel ; cela ne permet pas de conclure qu’aucun document n’est requis.

Disponibilité et effets de bord

  • Cette consultation du catalogue ou des exigences ne crée aucune identité, ne téléverse aucun justificatif, n’enregistre aucun numéro et ne passe aucune commande.
  • Une réponse réussie du catalogue ne vaut ni approbation de vos documents ni confirmation qu’un numéro sélectionné peut être activé.