Naar de inhoud
TalismanLeadsDocs
HomeAPI-sleutel aanmaken

API-referentie

Het basisadres is https://api.talismanleads.io/v1. Verzoeken en antwoorden zijn JSON, behalve upload- en downloadlinks. Ook beschikbaar als OpenAPI-bestand.

Je saldo

GET/account

Je saldo en de limieten die gelden.

API-sleutel moet: Alleen-lezen zijn, of bestellingen kunnen plaatsen

Voorbeeldverzoek

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

Voorbeeldantwoord (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
  }
}

De checkers opvragen

GET/checkers

Wat dit account nu kan bestellen, tegen de eigen prijzen. Een gepauzeerde of geblokkeerde checker staat er niet bij.

API-sleutel moet: Alleen-lezen zijn, of bestellingen kunnen plaatsen

Voorbeeldverzoek

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

Voorbeeldantwoord (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
    }
  ]
}

Een grote lijst uploaden

POST/uploads

Een link om een bestand naartoe te sturen, rechtstreeks naar de opslag. Stuur het met PUT en de opgegeven headers. De link blijft 2 uur geldig.

API-sleutel moet: Bestellingen kunnen plaatsen

Body

size_bytesinteger · verplicht
De grootte van het bestand, in bytes.
file_namestring · optioneel
Een naam voor de lijst, eindigend op .txt.

Voorbeeldverzoek

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}'

Voorbeeldantwoord (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"
}

Bekijken wat een bestelling zou kosten

POST/estimates

Telt de items, berekent de prijs en meldt eventuele problemen met de lijst. Schrijft niets af. Reken op maximaal 5 minuten voor het antwoord.

API-sleutel moet: Bestellingen kunnen plaatsen

Body

checkerstring · verplicht
De id van een checker uit GET /checkers.
entriesstring[] · optioneel
De lijst, één string per item, maximaal 100.000 items en 4 MB. Stuur dit of upload_id.
upload_idstring · optioneel
Een upload_id uit POST /uploads. Stuur dit of entries.
countrystring · optioneel
Een landcode van twee letters, als je wilt aangeven uit welk land de nummers komen.
file_namestring · optioneel
Een naam voor de lijst, eindigend op .txt.

Voorbeeldverzoek

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"]}'

Voorbeeldantwoord (200)

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

Een bestelling plaatsen

POST/orders

Schrijft het bedrag af van je saldo en zet het werk in de wachtrij. Antwoordt 201 bij een nieuwe bestelling en 200 met Idempotent-Replay: true bij een herhaling; een herhaling op hetzelfde moment kan ook 201 antwoorden, dus onderscheid bestellingen op id. Reken op maximaal 5 minuten voor het antwoord.

API-sleutel moet: Bestellingen kunnen plaatsen

Headers

Idempotency-Keystring · verplicht
Maximaal 200 ASCII-tekens zonder spaties. 7 dagen lang betekent dezelfde idempotentiesleutel dezelfde bestelling.

Body

checkerstring · verplicht
De id van een checker uit GET /checkers.
entriesstring[] · optioneel
De lijst, één string per item, maximaal 100.000 items en 4 MB. Stuur dit of upload_id.
upload_idstring · optioneel
Een upload_id uit POST /uploads. Stuur dit of entries.
countrystring · optioneel
Een landcode van twee letters, als je wilt aangeven uit welk land de nummers komen.
file_namestring · optioneel
Een naam voor de lijst, eindigend op .txt.
expected_chargestring · optioneel
Een prijs in dollars, zoals "18.00". De bestelling wordt geweigerd met price_changed als die iets anders kost.

Voorbeeldverzoek

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"]}'

Voorbeeldantwoord (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
}

Je bestellingen opvragen

GET/orders

Nieuwste eerst. Geef next_cursor terug als cursor voor de volgende pagina.

API-sleutel moet: Alleen-lezen zijn, of bestellingen kunnen plaatsen

Queryparameters

limitinteger · optioneel
Hoeveel er moeten worden teruggegeven, van 1 tot 100. De standaardwaarde is 20.
cursorstring · optioneel
next_cursor van de laatste pagina.

Voorbeeldverzoek

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

Voorbeeldantwoord (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
}

Eén bestelling

GET/orders/{id}

De status, items, afschrijving, terugbetaling, delen en tellingen. results is null tot er een deel klaar is, en een telling is null als de checker die niet meldt.

API-sleutel moet: Alleen-lezen zijn, of bestellingen kunnen plaatsen

Padparameters

idstring · verplicht
De id van de bestelling.

Voorbeeldverzoek

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

Voorbeeldantwoord (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"
}

Resultaatbestanden

GET/orders/{id}/results

Een downloadlink per deel, 15 minuten geldig. Een deel dat nog loopt, heeft geen link. Neem contact op met support als een voltooid deel er geen heeft.

API-sleutel moet: Alleen-lezen zijn, of bestellingen kunnen plaatsen

Padparameters

idstring · verplicht
De id van de bestelling.

Voorbeeldverzoek

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

Voorbeeldantwoord (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"
    }
  ]
}

Fouten

Vorige

Checkers

Volgende

Op deze pagina

Je saldoDe checkers opvragenEen grote lijst uploadenBekijken wat een bestelling zou kostenEen bestelling plaatsenJe bestellingen opvragenEén bestellingResultaatbestanden