Registrierungsanforderungen abrufen

Land und Rufnummerntyp auswählen

Wählen Sie ein Registrierungsland und verwenden Sie anschließend einen Namen aus der Antwort von get_document_number_types. Übermitteln Sie diesen Namen als number_type, keine Typ-ID und keine allgemeine Kategorie für die Rufnummernsuche.

Zurückgegebene Anweisungen lesen

Bewahren Sie die IDs der Anforderungen und Beziehungen für den jeweiligen Identitäts- oder Dokumentenprozess auf. Dieser Aufruf gibt Anforderungen zurück; er prüft Ihre Dateien nicht und reicht sie auch nicht ein. Befolgen Sie die zurückgegebenen Anweisungen sowie alle Anforderungen, die speziell für die ausgewählte Rufnummer gelten.

Fehler nicht als Befreiung von der Registrierungspflicht verstehen

Die Fehlermeldung zu einem ungültigen Land oder nicht erforderlichen Registrierungsdokumenten für das Land fasst zwei Bedingungen zusammen. Sie belegt nicht, dass eine Registrierung unnötig ist. Auch ein fehlgeschlagener Abruf oder ein leeres Ergebnis stellt keine Freigabe eines Kunden oder einer Rufnummer dar. Wenden Sie sich an den Support, wenn das Ergebnis unklar ist.

Anfrage

Verwenden Sie die Zugangsdaten Ihres freigeschalteten API-Kontos über HTTPS. Unterstützt werden die HTTP-Basisauthentifizierung und freigeschaltete Bearer-Token für API-Konten; Kontoeinschränkungen gelten weiterhin.

POST mit application/json oder application/x-www-form-urlencoded.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  --request POST \
  --header "Content-Type: application/json" \
  --data '{"country":"US","number_type":"Local"}' \
  "https://api.multitel.net/v3/get_requirements"

Parameter im Anfragekörper
Name	Typ	Erforderlich	Beschreibung
`country`	Zeichenfolge	Ja	ISO-Ländercode aus get_document_countries.
`number_type`	Zeichenfolge	Ja	Typname aus get_document_number_types, beispielsweise Local; beim Abgleich wird die Groß- und Kleinschreibung nicht berücksichtigt. Geben Sie den Namen an, nicht die zugehörige ID.

Antwort

Prüfen Sie sowohl status.code im JSON-Antwortkörper als auch den HTTP-Status. response ist eine einzelne Anforderungsressource mit id, type und attributes sowie relationships, sofern diese zurückgegeben werden. IDs in den Ressourcen- und Beziehungsdaten sind undurchsichtige Kennungen. Aus dem optionalen Text von restriction_message werden HTML-Tags entfernt; behandeln Sie den verbleibenden Inhalt als Text und nicht als vertrauenswürdiges HTML. Die Verarbeitungsroutine gibt die erste Anforderungsressource zurück. Gehen Sie daher nicht davon aus, dass diese Antwort eine vollständige Liste ist. Welche Attribute und Beziehungen verfügbar sind, hängt vom Land und vom Typ ab; das Beispiel stellt kein vollständiges, festes Schema dar.

Beispielhafte Antwortstruktur; keine aktuellen Kontodaten und kein aktuelles Preisangebot.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "id": "REQUIREMENT_ID_FROM_RESPONSE",
    "type": "RESOURCE_TYPE_FROM_RESPONSE",
    "attributes": {
      "restriction_message": "Example country-specific instructions."
    }
  }
}

Fehler

400: Die Validierung des Landes und von number_type ist fehlgeschlagen: Geben Sie beide erforderlichen Werte an. Der Validierungstext kann Formatierungen enthalten.
400: Invalid country ISO or No country registration documents required.: Diese mehrdeutige Meldung allein belegt keine Befreiung von der Registrierungspflicht.
400: Invalid number type: Verwenden Sie einen zurückgegebenen Typnamen. Die ältere Fehlermeldung führt Global, Local, Mobile, National, Shared Cost und Toll Free auf.
500: Unable to load registration requirements for the specified country and number type.: Die Anforderungen wurden nicht erfolgreich zurückgegeben. Versuchen Sie es später erneut oder wenden Sie sich an den Support.

Verfügbarkeit und Auswirkungen

Dieser Katalog- bzw. Anforderungsabruf 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.