Status eines Portierungsprojekts prüfen

Zugriff auf Konto und Projekt

Verwenden Sie ein aktiviertes API-Konto über HTTPS von einer zugelassenen IP-Adresse aus. Das Projekt muss zu diesem Konto gehören und darf nicht gelöscht sein. Verwenden Sie die eindeutige Projekt-ID aus dem Ablauf für Portierungsaufträge, nicht die numerische Datenbank-ID oder eine Telefonnummer. Kodieren Sie die Projekt-ID beim Erstellen einer Anfrage für die Verwendung in einer URL.

Anfrage

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/lnp/project/$PROJECT_ID/status"

Dieser Endpunkt liest weder einen Anfrageinhalt noch Parameter zur Seiteneinteilung oder einen Datumsfilter aus.

Antwort

Fiktives Antwortbeispiel.

{
  "status": {
    "code": 200,
    "msg": "Project Status"
  },
  "response": {
    "uniqueid": "PROJECT_EXAMPLE",
    "status": 2,
    "status_str": "Completed",
    "counts": {
      "total": 2,
      "pending": 0,
      "in_progress": 0,
      "completed": 1,
      "rejected": 1
    }
  }
}

Das Feld auf der äußeren Ebene status.code gibt das API-Ergebnis an. Das separate Feld response.status enthält den abgeleiteten Gesamtstatus der Portierung für das Projekt. Verwechseln Sie diese beiden Angaben nicht.

Ein Gesamtstatus ist kein Ergebnis für alle Rufnummern

Für den Gesamtstatus wird In Progress gewählt, wenn eine Rufnummer diesen Status hat, andernfalls Pending, andernfalls Completed, andernfalls Rejected. Wenn kein bekannter Status zutrifft, wird standardmäßig Pending verwendet. Ein Projekt, das sowohl abgeschlossene als auch abgelehnte Rufnummern enthält, meldet daher Completed, obwohl es weiterhin abgelehnte Rufnummern enthält.

Prüfen Sie immer die Anzahlen und die Liste der einzelnen Rufnummern, bevor Sie das gesamte Projekt als abgeschlossen betrachten. counts.total zählt jeden Rufnummerndatensatz des Projekts; die anderen Zähler erfassen nur die vier bekannten Statuswerte und ergeben bei Vorhandensein anderer Werte möglicherweise nicht die Gesamtzahl. Ein Projekt ohne Rufnummern meldet für alle Zähler den Wert null und den Gesamtstatus Pending.

Portierungsstatus interpretieren

Behalten Sie den numerischen Status bei und berücksichtigen Sie auch unbekannte Werte. Bei unbekannten Bezeichnungen wird auf den gespeicherten Wert zurückgegriffen; eine neue Bezeichnung ist nicht garantiert. Ein gespeicherter Abschlussstatus oder ein geplanter Termin allein prüft weder das Routing eingehender Anrufe noch sämtliche Dienste der Rufnummer.

Fehler und Einschränkungen

Prüfen Sie sowohl die HTTP-Antwort als auch status.code/status.msg. Bei einem nicht vorhandenen, gelöschten oder nicht zum Konto gehörenden Projekt wird der API-Code 404 mit einer Meldung zurückgegeben, dass das Projekt nicht gefunden wurde. Außerdem gelten Anforderungen an die Authentifizierung und Einschränkungen für die Quell-IP-Adresse. Die Beispiele führen keine Live-Anfrage aus, und eine erfolgreiche Antwort belegt nicht, dass ein Netzbetreiber eine Portierung angenommen oder abgeschlossen hat.

Auswirkungen

Dieser Endpunkt liest gespeicherte Anzahlen für das Projekt aus. Im geprüften Handler reicht er keinen Portierungsauftrag ein, ändert keinen Status, leitet keinen Anruf ein und belastet das Konto nicht. Er bietet weder Echtzeitabfragen beim Netzbetreiber noch ein Webhook-Abonnement.