Zum Inhalt springen
TalismanLeadsDocs
StartAPI-Schlüssel erhalten

API-Referenz

Die Basisadresse ist https://api.talismanleads.io/v1. Anfragen und Antworten sind JSON, außer bei Upload- und Download-Links. Auch als OpenAPI-Datei verfügbar.

Ihr Guthaben

GET/account

Ihr Guthaben und die geltenden Limits.

API-Schlüssel benötigt: Nur Lesezugriff oder darf Aufträge erteilen

Beispielanfrage

curl "https://api.talismanleads.io/v1/account" \
  -H "Authorization: Bearer tl_live_your_key_here"

Beispielantwort (200)

{
  "balance": "100.00",
  "currency": "USD",
  "key": {
    "id": "11111111-1111-4111-8111-111111111111",
    "scopes": [
      "read",
      "orders"
    ]
  },
  "limits": {
    "reads_per_minute": 60,
    "result_downloads_per_minute": 30,
    "uploads_per_minute": 10,
    "estimates_per_minute": 10,
    "orders_per_minute": 10,
    "open_task_parts": 20
  }
}

Prüfungen auflisten

GET/checkers

Was dieses Konto derzeit beauftragen kann, zu seinen Preisen. Eine pausierte oder gesperrte Prüfung wird nicht aufgelistet.

API-Schlüssel benötigt: Nur Lesezugriff oder darf Aufträge erteilen

Beispielanfrage

curl "https://api.talismanleads.io/v1/checkers" \
  -H "Authorization: Bearer tl_live_your_key_here"

Beispielantwort (200)

{
  "checkers": [
    {
      "id": "whatsapp_status_detection",
      "name": "WhatsApp Status Detection",
      "input": "phone",
      "price": {
        "amount": "3.00",
        "per_entries": 10000,
        "currency": "USD"
      },
      "minimum_entries": 0,
      "minimum_billed_entries": 2000,
      "calling_code": null
    }
  ]
}

Große Liste hochladen

POST/uploads

Ein Link, an den Sie eine Datei senden, direkt in den Speicher. Senden Sie sie mit PUT und den angegebenen Headern. Der Link gilt 2 Stunden.

API-Schlüssel benötigt: Darf Aufträge erteilen

Body

size_bytesinteger · erforderlich
Die Größe der Datei in Byte.
file_namestring · optional
Ein Name für die Liste, der auf .txt endet.

Beispielanfrage

curl -X POST "https://api.talismanleads.io/v1/uploads" \
  -H "Authorization: Bearer tl_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"file_name":"list.txt","size_bytes":1048576}'

Beispielantwort (201)

{
  "upload_id": "upl_2b7d9f10-6c3e-4a1f-8d2b-9e8f7a6b5c4d",
  "upload_url": "https://storage.example.com/upload/sign/list.txt?token=...",
  "method": "PUT",
  "headers": {
    "Content-Type": "text/plain"
  },
  "expires_at": "2026-11-05T11:00:00.000Z"
}

Sehen, was ein Auftrag kosten würde

POST/estimates

Zählt die Einträge, ermittelt den Preis und meldet etwaige Probleme mit der Liste. Berechnet nichts. Planen Sie bis zu 5 Minuten für die Antwort ein.

API-Schlüssel benötigt: Darf Aufträge erteilen

Body

checkerstring · erforderlich
Die id einer Prüfung aus GET /checkers.
entriesstring[] · optional
Die Liste, ein String pro Eintrag, bis zu 100.000 Einträge und 4 MB. Senden Sie dies oder upload_id.
upload_idstring · optional
Eine upload_id aus POST /uploads. Senden Sie dies oder entries.
countrystring · optional
Ein zweistelliger Ländercode, wenn Sie angeben möchten, aus welchem Land die Nummern stammen.
file_namestring · optional
Ein Name für die Liste, der auf .txt endet.

Beispielanfrage

curl -X POST "https://api.talismanleads.io/v1/estimates" \
  -H "Authorization: Bearer tl_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"checker":"whatsapp_status_detection","entries":["+14155550142","+12125550187"]}'

Beispielantwort (200)

{
  "checker": "whatsapp_status_detection",
  "entries": 2,
  "billed_entries": 2000,
  "charge": "0.60",
  "currency": "USD",
  "parts": 1,
  "country": {
    "code": "US",
    "share": 1
  }
}

Auftrag erteilen

POST/orders

Belastet Ihr Guthaben und stellt die Arbeit in die Warteschlange. Antwortet mit 201 bei einem neuen Auftrag und mit 200 und Idempotent-Replay: true bei einer Wiederholung; eine Wiederholung im selben Moment kann auch mit 201 antworten, unterscheiden Sie Aufträge also anhand von id. Planen Sie bis zu 5 Minuten für die Antwort ein.

API-Schlüssel benötigt: Darf Aufträge erteilen

Header

Idempotency-Keystring · erforderlich
Bis zu 200 ASCII-Zeichen ohne Leerzeichen. 7 Tage lang bedeutet derselbe Idempotency-Key denselben Auftrag.

Body

checkerstring · erforderlich
Die id einer Prüfung aus GET /checkers.
entriesstring[] · optional
Die Liste, ein String pro Eintrag, bis zu 100.000 Einträge und 4 MB. Senden Sie dies oder upload_id.
upload_idstring · optional
Eine upload_id aus POST /uploads. Senden Sie dies oder entries.
countrystring · optional
Ein zweistelliger Ländercode, wenn Sie angeben möchten, aus welchem Land die Nummern stammen.
file_namestring · optional
Ein Name für die Liste, der auf .txt endet.
expected_chargestring · optional
Ein Preis in Dollar, zum Beispiel "18.00". Der Auftrag wird mit price_changed abgelehnt, falls er etwas anderes kostet.

Beispielanfrage

curl -X POST "https://api.talismanleads.io/v1/orders" \
  -H "Authorization: Bearer tl_live_your_key_here" \
  -H "Idempotency-Key: crm-export-2026-11-05" \
  -H "Content-Type: application/json" \
  -d '{"checker":"whatsapp_status_detection","entries":["+14155550142","+12125550187"]}'

Beispielantwort (201)

{
  "id": "ord_8f2c1e7a-3b4d-4c5e-9f60-1a2b3c4d5e6f",
  "checker": "whatsapp_status_detection",
  "status": "queued",
  "entries": 2,
  "charge": "0.60",
  "refunded": "0.00",
  "currency": "USD",
  "parts": {
    "total": 1,
    "completed": 0,
    "failed": 0
  },
  "results": null,
  "error": null,
  "source": "api",
  "created_at": "2026-11-05T09:00:00.000Z",
  "completed_at": null
}

Ihre Aufträge auflisten

GET/orders

Neueste zuerst. Übergeben Sie next_cursor als cursor, um die nächste Seite zu erhalten.

API-Schlüssel benötigt: Nur Lesezugriff oder darf Aufträge erteilen

Query-Parameter

limitinteger · optional
Wie viele zurückgegeben werden, von 1 bis 100. Der Standardwert ist 20.
cursorstring · optional
next_cursor von der letzten Seite.

Beispielanfrage

curl "https://api.talismanleads.io/v1/orders?limit=20" \
  -H "Authorization: Bearer tl_live_your_key_here"

Beispielantwort (200)

{
  "orders": [
    {
      "id": "ord_8f2c1e7a-3b4d-4c5e-9f60-1a2b3c4d5e6f",
      "checker": "whatsapp_status_detection",
      "status": "completed",
      "entries": 2,
      "charge": "0.60",
      "refunded": "0.00",
      "currency": "USD",
      "parts": {
        "total": 1,
        "completed": 1,
        "failed": 0
      },
      "results": {
        "registered": 1,
        "not_registered": 1
      },
      "error": null,
      "source": "api",
      "created_at": "2026-11-05T09:00:00.000Z",
      "completed_at": "2026-11-05T09:02:10.000Z"
    }
  ],
  "next_cursor": null
}

Ein Auftrag

GET/orders/{id}

Sein Status, seine Einträge, der berechnete Betrag, die Erstattung, Teile und Zahlen. results ist null, bis ein Teil abgeschlossen ist, und eine Zahl ist null, wenn die Prüfung sie nicht meldet.

API-Schlüssel benötigt: Nur Lesezugriff oder darf Aufträge erteilen

Pfadparameter

idstring · erforderlich
Die id des Auftrags.

Beispielanfrage

curl "https://api.talismanleads.io/v1/orders/ord_8f2c1e7a-3b4d-4c5e-9f60-1a2b3c4d5e6f" \
  -H "Authorization: Bearer tl_live_your_key_here"

Beispielantwort (200)

{
  "id": "ord_8f2c1e7a-3b4d-4c5e-9f60-1a2b3c4d5e6f",
  "checker": "whatsapp_status_detection",
  "status": "completed",
  "entries": 2,
  "charge": "0.60",
  "refunded": "0.00",
  "currency": "USD",
  "parts": {
    "total": 1,
    "completed": 1,
    "failed": 0
  },
  "results": {
    "registered": 1,
    "not_registered": 1
  },
  "error": null,
  "source": "api",
  "created_at": "2026-11-05T09:00:00.000Z",
  "completed_at": "2026-11-05T09:02:10.000Z"
}

Ergebnisdateien

GET/orders/{id}/results

Ein Download-Link für jeden Teil, der 15 Minuten gilt. Ein noch laufender Teil hat keinen Link. Wenden Sie sich an den Support, wenn ein abgeschlossener Teil keinen hat.

API-Schlüssel benötigt: Nur Lesezugriff oder darf Aufträge erteilen

Pfadparameter

idstring · erforderlich
Die id des Auftrags.

Beispielanfrage

curl "https://api.talismanleads.io/v1/orders/ord_8f2c1e7a-3b4d-4c5e-9f60-1a2b3c4d5e6f/results" \
  -H "Authorization: Bearer tl_live_your_key_here"

Beispielantwort (200)

{
  "order_id": "ord_8f2c1e7a-3b4d-4c5e-9f60-1a2b3c4d5e6f",
  "status": "completed",
  "parts": [
    {
      "part": 1,
      "status": "completed",
      "file_name": "result.csv",
      "url": "https://storage.example.com/sign/result.csv?token=...",
      "expires_at": "2026-11-05T09:17:10.000Z"
    }
  ]
}

Fehler

Zurück

Prüfungen

Weiter

Auf dieser Seite

Ihr GuthabenPrüfungen auflistenGroße Liste hochladenSehen, was ein Auftrag kosten würdeAuftrag erteilenIhre Aufträge auflistenEin AuftragErgebnisdateien