Landen met nummers op voorraad opvragen

Begin hier met het zoeken naar lokale nummers. De lijst bevat alleen landen waar momenteel nummers op voorraad zijn. Er wordt niets gereserveerd.

• Geef isocode door aan getareas, aan getstates (alleen US en CA) of aan other.
• next_function verwijst altijd naar v3/getareas/{isocode}. Voor de Verenigde Staten en Canada kunt u getstates eerst aanroepen om de selectie te beperken tot een staat of provincie.
• is_mobile en sms_coverage zijn aanduidingen op landniveau en bieden geen garanties voor elk afzonderlijk nummer. Voor de Verenigde Staten is is_mobile gelijk aan 0, tenzij uw account is ingeschakeld voor mobiele nummers uit de Verenigde Staten.
• Landen met uitsluitend dekking op bestelling worden niet vermeld. U kunt getareas of other wel rechtstreeks aanroepen voor een land dat niet wordt vermeld.
• Sorteer de lijst zelf als u een bepaalde volgorde nodig hebt.

Als geen enkel land aan de voorwaarden voldoet, is response gelijk aan null en is status.code gelijk aan 200.

Verzoek

Vereist: HTTP Basic of een Bearer-token (zie Authenticatie en API-antwoorden). Bij mislukte authenticatie wordt HTTP 401 geretourneerd voordat de zoekopdracht wordt uitgevoerd.

GET zonder verzoekinhoud. De enige parameter is de optionele pid, die in de querystring wordt meegestuurd.

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

Antwoord

Standaard antwoordstructuur. Bij succes is status.code gelijk aan 200, is status.msg gelijk aan 'Results: N', is status.results gelijk aan N en bevat response een lijst met landen waarvan de volgorde niet gegarandeerd is. Velden: countrycode (landnummer zonder '+'); name (landnaam); description (dezelfde waarde als name); isocode (ISO 3166-1 alpha-2-code); is_mobile (0 of 1, een aanduiding in de catalogus op landniveau, altijd 0 voor US tenzij uw account is ingeschakeld voor mobiele nummers uit US); sms_coverage (0 of 1, een aanduiding in de catalogus op landniveau); latitude en longitude (coördinaten van het land); next_function ('v3/getareas/{isocode}'). Een land wordt alleen vermeld als het zichtbaar is en er momenteel voor minstens één van zijn prefixen voorraad is bij ten minste één voorraadbron. Landen waarvan de dekking uitsluitend op bestelling beschikbaar is (geen voorraad), worden niet vermeld. Deze voorraadcontrole is ruimer dan de filters die getareas toepast, waardoor een vermeld land daar soms 'No areas found' kan opleveren. Als geen enkel land aan de voorwaarden voldoet, is status.code gelijk aan 200, is status.msg gelijk aan 'Results: 0', ontbreekt het veld status.results en is response gelijk aan null.

Voorbeeld van de antwoordstructuur; geen actuele accountgegevens of actuele prijsopgave.

{
  "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"
    }
  ]
}

Fouten

• 401: Authenticatie ontbreekt of is mislukt. Wordt verzonden met HTTP-status 401 (zie Authenticatie en API-antwoorden).

Beschikbaarheid en neveneffecten

• Vraagt alleen gegevens op. Er wordt niets gereserveerd, besteld of gewijzigd.
• De resultaten geven de voorraad op het moment van het verzoek weer en kunnen tussen aanroepen veranderen.