Entwickler

GET/v3/getcountries

Länder mit vorrätigen Rufnummern auflisten

Gibt sichtbare Länder zurück, für die aktuell mindestens ein Rufnummernpräfix mit vorrätigen Rufnummern vorhanden ist. Jeder Eintrag enthält die Landesvorwahl, den ISO-Code, Kennzeichen für Mobilfunk und SMS auf Landesebene, Koordinaten und einen next_function-Link zu den Abdeckungsbereichen des Landes.

Auf dieser Seite
  1. Anfrage
  2. Antwort
  3. Fehler
  4. Verfügbarkeit und Nebenwirkungen

Beginnen Sie hier mit der Suche nach lokalen Rufnummern. Die Liste enthält nur Länder, in denen aktuell Rufnummern vorrätig sind. Dabei wird nichts reserviert.

  • Übergeben Sie isocode an getareas, an getstates (nur US und CA) oder an other.
  • next_function verweist immer auf v3/getareas/{isocode}. Für die Vereinigten Staaten und Kanada können Sie getstates zuerst aufrufen, um die Auswahl nach Bundesstaat oder Provinz einzugrenzen.
  • is_mobile und sms_coverage sind Kennzeichen auf Landesebene und keine Garantien für jede einzelne Rufnummer. Für die Vereinigten Staaten gilt: is_mobile ist 0, sofern Ihr Konto nicht für US-Mobilfunknummern freigeschaltet ist.
  • Länder, in denen Rufnummern ausschließlich auf Bestellung erhältlich sind, werden nicht aufgeführt. Sie können dennoch getareas oder other direkt für ein nicht aufgeführtes Land aufrufen.
  • Sortieren Sie die Liste selbst, wenn Sie eine bestimmte Reihenfolge benötigen.

Erfüllt kein Land die Voraussetzungen, hat response den Wert null und status.code den Wert 200.

Anfrage

Erforderlich: HTTP-Basic-Authentifizierung oder ein Bearer-Token (siehe Authentifizierung und API-Antworten). Bei fehlgeschlagener Authentifizierung wird vor der Ausführung der Abfrage mit HTTP 401 geantwortet.

GET ohne Anfragerumpf. Der einzige Parameter ist der optionale Parameter pid, der in der Abfragezeichenfolge übergeben wird.

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/getcountries'
Abfrageparameter
NameTypErforderlichBeschreibung
pidstringNeinOptionaler Parameter für erweiterte Anwendungen. Beschränkt die Liste auf Länder, die für eine bestimmte Bestandsquelle gekennzeichnet sind. Verwenden Sie ausschließlich einen von MultiTEL bereitgestellten Wert in numerischer Form oder als 32-stelligen Hexadezimalwert und lassen Sie den Parameter bei normaler Nutzung weg. pid schränkt die im Abschnitt zur Antwort beschriebene Bestandsprüfung nicht ein. Unbekannte Werte, der Wert null und Werte, die dieser Endpunkt nicht akzeptiert, werden ohne Fehlermeldung ignoriert; die Liste umfasst dann alle unterstützten Quellen.

Antwort

Standardmäßige Antwortstruktur. Bei Erfolg hat status.code den Wert 200, status.msg den Wert 'Results: N', status.results den Wert N, und response enthält eine Liste von Ländern ohne garantierte Reihenfolge. Felder: countrycode (Landesvorwahl ohne '+'); name (Name des Landes); description (derselbe Wert wie name); isocode (Code nach ISO 3166-1 alpha-2); is_mobile (0 oder 1, ein Katalogkennzeichen auf Landesebene, für US immer 0, sofern Ihr Konto nicht für Mobilfunknummern aus US freigeschaltet ist); sms_coverage (0 oder 1, ein Katalogkennzeichen auf Landesebene); latitude und longitude (Koordinaten des Landes); next_function ('v3/getareas/{isocode}'). Ein Land wird nur aufgeführt, wenn es sichtbar ist und für mindestens eines seiner Rufnummernpräfixe aktuell Rufnummern in mindestens einer Bestandsquelle vorrätig sind. Länder, in denen Rufnummern ausschließlich auf Bestellung erhältlich sind (kein Bestand), werden nicht aufgeführt. Diese Bestandsprüfung ist weiter gefasst als die von getareas angewendeten Filter. Daher kann ein aufgeführtes Land dort gelegentlich die Antwort 'No areas found' liefern. Erfüllt kein Land die Voraussetzungen, hat status.code den Wert 200 und status.msg den Wert 'Results: 0'; das Feld status.results ist nicht vorhanden, und response hat den Wert null.

Beispielhafte Antwortstruktur; keine aktuellen Kontodaten und kein aktuelles Preisangebot.

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

Fehler

  • 401: Authentifizierung fehlt oder ist fehlgeschlagen. Wird mit HTTP-Status 401 gesendet (siehe Authentifizierung und API-Antworten).

Verfügbarkeit und Nebenwirkungen

  • Reine Abfrage. Dabei wird nichts reserviert, bestellt oder geändert.
  • Die Ergebnisse geben den Bestand zum Zeitpunkt der Anfrage wieder und können sich zwischen Aufrufen ändern.