Sideline Number API: Massenprüfung

Sideline Number: Verarbeiten Sie Eingabewerte über die Batch-API und erhalten Sie die unten aufgeführten Ergebnisfelder.

Eingabeformat

Laden Sie eine Textdatei mit einer Telefonnummer pro Zeile hoch. Normalisieren Sie die Werte vor dem Upload; für Telefonnummern wird das E.164-Format empfohlen.

+14155552671
+442071838750

Aufgabe erstellen

POST https://api.checknumber.ai/v1/tasks

curl --location 'https://api.checknumber.ai/v1/tasks' \
--header 'X-API-Key: YOUR_API_KEY' \
--form 'file=@"./input.txt"' \
--form 'task_type="sideline"'

Die API gibt eine Aufgaben-ID zurück. Bewahren Sie diese ID auf und verwenden Sie sie zur Abfrage des Aufgabenstatus.

Antwort beim Upload

{
  "task_id": "d4g8o46p2jvh04o9uolg",
  "status": "pending",
  "total": 5000,
  "estimated_amount": {
    "amount": "0.500000",
    "currency": "USD"
  },
  "message": "Task created successfully"
}

Aufgabenstatus prüfen

POST https://api.checknumber.ai/v1/gettasks

curl --location 'https://api.checknumber.ai/v1/gettasks' \
--header 'X-API-Key: YOUR_API_KEY' \
--form 'task_id="d4g8o46p2jvh04o9uolg"'

Fragen Sie den Status ab, bis status zu exported wechselt. pending und processing sind keine abgeschlossenen Ergebnisse.

Antwort während der Verarbeitung

{
  "task_id": "d4g8o46p2jvh04o9uolg",
  "status": "processing",
  "total": 5000,
  "success": 2500,
  "failure": 0
}

Exportierte Antwort

{
  "task_id": "d4g8o46p2jvh04o9uolg",
  "status": "exported",
  "total": 5000,
  "success": 5000,
  "failure": 0,
  "result_url": "https://example-link-to-results.zip",
  "actual_amount": {
    "amount": "2.000000",
    "currency": "USD"
  }
}

Ergebnisfelder

Feld	Beschreibung	Beispiel
Number	Telefonnummer aus der übermittelten Datei.	+14155552671
activated	Gibt an, ob der Wert als aktiv oder registriert erkannt wurde.	yes

Note: Confirmed from the current product sample; fields are Number and activated.

Verarbeitung der Ergebnisdatei

Laden Sie die Datei erst nach dem Export der Aufgabe über result_url herunter. Bewahren Sie die zurückgegebenen Spaltennamen bei der weiteren Verarbeitung bei.

Antwortfelder

Feld	Beschreibung
created_at	Zeitstempel der Aufgabenerstellung.
updated_at	Zeitstempel der letzten Statusaktualisierung.
task_id	Eindeutige Aufgabenkennung.
status	pending, processing, exported oder failed.
total	Gesamtzahl der verarbeiteten Eingabewerte.
success	Erfolgreich verarbeitete Werte.
failure	Werte, deren Verarbeitung fehlgeschlagen ist.
result_url	Download-URL nach dem Export der Aufgabe.
actual_amount	Endgültig abgerechneter Betrag, sofern verfügbar.
estimated_amount	Beim Erstellen der Aufgabe zurückgegebener Schätzbetrag.

Statuscodes

Status	Beschreibung
200	Anfrage erfolgreich.
202	Aufgabe erfolgreich erstellt; der geschätzte Betrag wurde angewendet.
400	Ungültige Datei, nicht unterstützter Aufgabentyp oder zu wenige gültige Einträge.
401	API-Key fehlt oder ist ungültig.
402	Unzureichendes Kontoguthaben.
404	Aufgabe nicht gefunden.
413	Die hochgeladene Datei ist zu groß.
500	Interner Serverfehler; versuchen Sie es später erneut.

Hinweise zum Betrieb

• Die Aufgabe ist asynchron. Verwenden Sie die Aufgaben-ID zur Statusabfrage.
• Prüfen Sie vor dem Upload die produktspezifischen Eingabelimits.
• Fehlerhafte Zeilen werden im exportierten Ergebnis ausgegeben und in den Aufgabenzählern berücksichtigt.
• Die obigen Felder basieren auf dem aktuellen Live-Sample und können sich ändern, wenn sich das vorgelagerte Exportschema ändert.