Entwickler

GET/v3/get_document_number_types/{country}

Rufnummerntypen für die Registrierung auflisten

Ermitteln Sie die Namen der Rufnummerntypen, die derzeit im Registrierungskatalog für ein Land enthalten sind.

Auf dieser Seite
  1. Wählen Sie einen Typ anhand seines zurückgegebenen Namens
  2. Gruppenanzahlen geben nicht den Rufnummernbestand an
  3. Anfrage
  4. Antwort
  5. Fehler
  6. Verfügbarkeit und Nebenwirkungen

Wählen Sie einen Typ anhand seines zurückgegebenen Namens

Verwenden Sie ein Land aus get_document_countries. Übergeben Sie den zurückgegebenen Typnamen an get_requirements. Eine ID aus dem Typkatalog ist keine Vorwahl-ID, Rufnummern-ID oder Nachweiskategorie-ID.

Gruppenanzahlen geben nicht den Rufnummernbestand an

available_groups zählt die Gruppendatensätze, die diese Katalogabfrage zurückgibt. Der Wert zählt keine kaufbaren Rufnummern, reserviert keinen Bestand und garantiert nicht, dass der Katalog alle Seiten der vorgelagerten Datenquelle abgerufen hat. Durchsuchen Sie den entsprechenden Rufnummernbestand und prüfen Sie ein Angebot gesondert.

Anfrage

Verwenden Sie die Zugangsdaten Ihres freigeschalteten API-Kontos über HTTPS. Die Basic-Authentifizierung und freigeschaltete bearer-Tokens für API-Konten werden unterstützt; es gelten die Kontobeschränkungen.

GET mit allen dokumentierten Parametern im URL-Pfad.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_document_number_types/$COUNTRY_ISO"
Pfadparameter
NameTypErforderlichBeschreibung
countrystringJaAus zwei Buchstaben bestehender ISO-Ländercode aus dem Katalog der Registrierungsländer. Führende und nachfolgende Leerzeichen werden entfernt und der Code wird in Großbuchstaben umgewandelt.

Antwort

Prüfen Sie status.code im JSON-Antworttext sowie den HTTP-Status. response ist ein Array mit id, name und available_groups. Verwenden Sie name als number_type beim Aufruf von get_requirements; senden Sie stattdessen nicht id. available_groups ist die Anzahl der für diesen Typ zurückgegebenen Gruppendatensätze, nicht die Anzahl verfügbarer Rufnummern oder eine vollständige Gesamtanzahl über alle Ergebnisseiten hinweg. Typen, für die keine Gruppen zurückgegeben werden, werden ausgelassen. Die bevorzugte Reihenfolge lautet Local, Mobile, National, Toll Free, Shared Cost, Global, gefolgt von weiteren Katalognamen.

Beispielhafte Antwortstruktur; keine aktuellen Kontodaten und kein aktuelles Angebot.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "id": "NUMBER_TYPE_ID_FROM_RESPONSE",
      "name": "Local",
      "available_groups": 3
    }
  ]
}

Fehler

  • 400: country is required: Geben Sie den ISO-Code des Registrierungslandes an.
  • 400: Invalid country ISO or no available DID registration country found: Wählen Sie ein Land aus dem aktuellen Registrierungskatalog aus; dieser Fehler bedeutet nicht, dass keine Dokumente erforderlich sind.

Verfügbarkeit und Nebenwirkungen

  • Diese Abfrage des Katalogs bzw. der Anforderungen legt keine Identität an, lädt keinen Nachweis hoch, registriert keine Rufnummer und gibt keine Bestellung auf.
  • Eine erfolgreiche Katalogantwort stellt weder eine Genehmigung Ihrer Dokumente noch eine Bestätigung dar, dass eine ausgewählte Rufnummer aktiviert werden kann.