Den Vorlagenkatalog durchsuchen
Lassen Sie das optionale ISO-Pfadsegment weg, um die vom Dienst zurückgegebenen Vorlagen aufzulisten. Geben Sie den ISO-Code eines Landes an, um die Liste zu filtern. Der Filter gleicht den Länderhinweis der Vorlage ab, der aus einem Namen abgeleitet sein kann und auch leer sein kann.
Eine Vorlage anhand der Anforderungen auswählen
Dass eine Vorlage vorhanden ist, bedeutet nicht, dass sie für jede Rufnummer in diesem Land erforderlich ist oder akzeptiert wird. Gleichen Sie die Vorlagen-ID mit den geltenden Anforderungen an Nachweisdokumente ab. Diese Liste erstellt, unterzeichnet, lädt oder genehmigt kein ausgefülltes Dokument.
Wenn keine Vorlagen zurückgegeben werden
Eine leere gefilterte Liste kann bedeuten, dass kein passender Länderhinweis gefunden wurde. Eine leere ungefilterte Liste kann auch auf nicht verfügbare Daten eines vorgelagerten Systems zurückzuführen sein. Betrachten Sie keines dieser Ergebnisse als Beleg dafür, dass kein Nachweisdokument erforderlich ist.
Eine heruntergeladene Kopie vor der Verwendung prüfen
Ein Download-Link im Katalog kann eine Kopie mit Änderungen an der Formatierung oder am Markenauftritt zurückgeben. Gehen Sie nicht davon aus, dass es sich um eine unveränderte Originalvereinbarung handelt oder dass der Download eine Registrierungsanforderung erfüllt. Prüfen Sie den Inhalt, bevor Sie ein Dokument ausfüllen oder unterzeichnen.
Wenn der Dokumentenassistent im Portal die Vorbereitung einer Vereinbarung anbietet, nutzen Sie seine Vorschau und den vorgesehenen Ablauf zur ausdrücklichen Einreichung. Lassen Sie sich bei anderen erforderlichen Formularen vor dem Ausfüllen von MultiTEL bestätigen, welches Formular aktuell ist. Eine heruntergeladene Vorlage ist weder ein unterzeichneter Anhang noch ein hochgeladener Nachweis oder eine Genehmigung einer Rufnummer.
Anfrage
Verwenden Sie die Zugangsdaten Ihres freigeschalteten API-Kontos über HTTPS. Die Basic-Authentifizierung und freigeschaltete bearer-Token für API-Konten werden unterstützt; die Kontobeschränkungen gelten.
GET mit einem beliebigen dokumentierten Parameter im URL-Pfad.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/v3/get_supporting_document_templates/$COUNTRY_ISO"| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
iso | string | Nein | Optionaler Filter nach dem ISO-Ländercode. Lassen Sie dieses gesamte Pfadsegment weg, um die ungefilterte Liste zu erhalten. Beim Vergleich wird die Groß- und Kleinschreibung nicht berücksichtigt. Unbekannte Werte oder Werte ohne Übereinstimmung geben eine leere Liste zurück, statt einen ausdrücklichen Fehler wegen eines ungültigen Landes auszulösen. |
Antwort
Prüfen Sie sowohl status.code im JSON-Antworttext als auch den HTTP-Status. response ist ein Array von Objekten mit id, name, permanent, iso und url. permanent ist vom Typ boolean; iso kann leer sein und aus dem Vorlagennamen abgeleitet worden sein. Betrachten Sie Länderangaben als Hinweis, nicht als Entscheidung über die Eignung. Ein leerer Katalog ist eine erfolgreiche Antwort mit dem Status 200 und kann auch entstehen, wenn die Abfrage im vorgelagerten System keine Daten liefert. Die URL wird vom Dienst generiert; ihr Hostname kann vom veranschaulichenden Beispiel abweichen.
Beispielhafte Antwortstruktur; keine aktuellen Kontodaten und kein aktuelles Preisangebot.
{
"status": {
"code": 200,
"msg": "",
"results": 1
},
"response": [
{
"id": "TEMPLATE_ID_FROM_RESPONSE",
"name": "Example supporting-document template",
"permanent": false,
"iso": "US",
"url": "https://api.multitel.net/v3/supporting_document/TEMPLATE_ID_FROM_RESPONSE"
}
]
}Fehler
- Prüfen Sie status.code und status.msg auf Authentifizierungs- oder Dienstfehler. Ein erfolgreich zurückgegebener leerer Katalog ist weder eine Genehmigung eines Dokuments noch eine Befreiung von der Registrierungspflicht.
Verfügbarkeit und Nebenwirkungen
- Diese Abfrage des Katalogs bzw. der Anforderungen erstellt keine Identität, lädt keinen Nachweis hoch, registriert keine Rufnummer und gibt keine Bestellung auf.
- Eine erfolgreiche Katalogantwort ist weder eine Genehmigung Ihrer Dokumente noch eine Bestätigung, dass eine ausgewählte Rufnummer aktiviert werden kann.