Lister les pays disposant de numéros en stock

Commencez ici la recherche de numéros locaux. La liste contient uniquement les pays où des numéros sont actuellement en stock. Elle ne réserve rien.

Transmettez isocode à getareas, à getstates (US et CA uniquement) ou à other.
next_function pointe toujours vers v3/getareas/{isocode}. Pour les États-Unis et le Canada, vous pouvez appeler getstates d’abord pour restreindre la recherche à un État ou à une province.
is_mobile et sms_coverage sont des indicateurs au niveau du pays, sans garantie pour chaque numéro. Pour les États-Unis, is_mobile vaut 0 sauf si votre compte est autorisé à utiliser les numéros mobiles des États-Unis.
Les pays dont la couverture est disponible uniquement sur commande ne figurent pas dans la liste. Vous pouvez tout de même appeler getareas ou other directement pour un pays absent de la liste.
Triez vous-même la liste si vous avez besoin d’un ordre particulier.

Si aucun pays ne remplit les conditions, response vaut null et status.code vaut 200.

Requête

Obligatoire : authentification HTTP Basic ou jeton Bearer (voir Authentification et réponses de l’API). En cas d’échec de l’authentification, une réponse HTTP 401 est renvoyée avant l’exécution de la recherche.

GET sans corps de requête. Le seul paramètre est pid, facultatif, transmis dans la chaîne de requête.

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/getcountries'

Paramètres de requête
Nom	Type	Obligatoire	Description
`pid`	string	Non	Paramètre avancé et facultatif. Restreint la liste aux pays associés à une source de stock donnée. Utilisez uniquement une valeur fournie par MultiTEL, sous forme numérique ou hexadécimale de 32 caractères, et omettez ce paramètre pour une utilisation normale. pid ne restreint pas la vérification du stock décrite dans la réponse. Les valeurs non reconnues, la valeur zéro et les valeurs que ce point de terminaison n’accepte pas sont ignorées sans erreur ; la liste couvre alors toutes les sources prises en charge.

Réponse

Enveloppe standard. En cas de succès, status.code vaut 200, status.msg vaut 'Results: N', status.results vaut N et response est une liste de pays sans ordre garanti. Champs : countrycode (indicatif téléphonique du pays sans '+') ; name (nom du pays) ; description (même valeur que name) ; isocode (code pays ISO 3166-1 alpha-2) ; is_mobile (0 ou 1, indicateur du catalogue au niveau du pays, toujours 0 pour US sauf si votre compte est autorisé à utiliser les numéros mobiles du pays US) ; sms_coverage (0 ou 1, indicateur du catalogue au niveau du pays) ; latitude et longitude (coordonnées du pays) ; next_function ('v3/getareas/{isocode}'). Un pays n’est répertorié que s’il est visible et qu’au moins un de ses préfixes dispose actuellement de stock dans une source de stock quelconque. Les pays dont la couverture est entièrement disponible sur commande uniquement (sans stock) ne sont pas répertoriés. Cette vérification du stock est plus large que les filtres appliqués par getareas ; un pays répertorié peut donc parfois y renvoyer 'No areas found'. Si aucun pays ne remplit les conditions, status.code vaut 200, status.msg vaut 'Results: 0', le champ status.results est absent et response vaut null.

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: 2",
    "results": 2
  },
  "response": [
    {
      "countrycode": "1",
      "name": "United States",
      "description": "United States",
      "isocode": "US",
      "is_mobile": 0,
      "sms_coverage": 1,
      "latitude": "38.0000",
      "longitude": "-97.0000",
      "next_function": "v3/getareas/US"
    },
    {
      "countrycode": "44",
      "name": "United Kingdom",
      "description": "United Kingdom",
      "isocode": "GB",
      "is_mobile": 1,
      "sms_coverage": 0,
      "latitude": "54.0000",
      "longitude": "-2.0000",
      "next_function": "v3/getareas/GB"
    }
  ]
}

Erreurs

401 : authentification absente ou échouée. Renvoyée avec le statut HTTP 401 (voir Authentification et réponses de l’API).

Disponibilité et effets de bord

Consultation uniquement. Cette opération ne réserve rien, ne passe aucune commande et ne modifie rien.
Les résultats reflètent le stock au moment de la requête et peuvent changer entre deux appels.