İçeriğe geç
TalismanLeadsDocs
Ana sayfaAPI anahtarı alın

API başvurusu

Temel adres https://api.talismanleads.io/v1 şeklindedir. Yükleme ve indirme bağlantıları dışında istekler ve yanıtlar JSON biçimindedir. Ayrıca bir OpenAPI dosyası olarak da mevcuttur.

Bakiyeniz

GET/account

Bakiyeniz ve geçerli sınırlar.

Gereken API anahtarı: Salt okunur veya sipariş verebilen

Örnek istek

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

Örnek yanıt (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
  }
}

Denetleyicileri listeleyin

GET/checkers

Bu hesabın şu anda kendi fiyatlarıyla sipariş verebilecekleri. Duraklatılmış veya engellenmiş bir denetleyici listelenmez.

Gereken API anahtarı: Salt okunur veya sipariş verebilen

Örnek istek

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

Örnek yanıt (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
    }
  ]
}

Büyük bir liste yükleyin

POST/uploads

Bir dosyayı doğrudan depolamaya göndermek için bağlantı. Dosyayı PUT ve belirtilen başlıklarla gönderin. Bağlantı 2 saat geçerlidir.

Gereken API anahtarı: Sipariş verebilen

Gövde

size_bytesinteger · zorunlu
Dosyanın bayt cinsinden boyutu.
file_namestring · isteğe bağlı
Liste için .txt ile biten bir ad.

Örnek istek

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

Örnek yanıt (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"
}

Bir siparişin ne kadar tutacağını görün

POST/estimates

Kayıtları sayar, fiyatı hesaplar ve listeyle ilgili olası sorunları bildirir. Hiçbir ücret almaz. Yanıt için 5 dakikaya kadar süre tanıyın.

Gereken API anahtarı: Sipariş verebilen

Gövde

checkerstring · zorunlu
GET /checkers yanıtından bir denetleyicinin id değeri.
entriesstring[] · isteğe bağlı
Liste, kayıt başına bir dize, en fazla 100.000 kayıt ve 4 MB. Bunu veya upload_id gönderin.
upload_idstring · isteğe bağlı
POST /uploads yanıtından bir upload_id. Bunu veya entries gönderin.
countrystring · isteğe bağlı
Numaraların hangi ülkeden olduğunu belirtmek isterseniz iki harfli ülke kodu.
file_namestring · isteğe bağlı
Liste için .txt ile biten bir ad.

Örnek istek

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

Örnek yanıt (200)

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

Sipariş verin

POST/orders

Bakiyenizden ücret alır ve işi kuyruğa koyar. Yeni bir sipariş için 201, bir tekrar için Idempotent-Replay: true ile 200 yanıtı verir; aynı anda yapılan bir tekrar da 201 yanıtı alabilir, bu yüzden siparişleri id ile ayırt edin. Yanıt için 5 dakikaya kadar süre tanıyın.

Gereken API anahtarı: Sipariş verebilen

Başlıklar

Idempotency-Keystring · zorunlu
Boşluk içermeyen en fazla 200 ASCII karakter. 7 gün boyunca aynı Idempotency-Key aynı sipariş anlamına gelir.

Gövde

checkerstring · zorunlu
GET /checkers yanıtından bir denetleyicinin id değeri.
entriesstring[] · isteğe bağlı
Liste, kayıt başına bir dize, en fazla 100.000 kayıt ve 4 MB. Bunu veya upload_id gönderin.
upload_idstring · isteğe bağlı
POST /uploads yanıtından bir upload_id. Bunu veya entries gönderin.
countrystring · isteğe bağlı
Numaraların hangi ülkeden olduğunu belirtmek isterseniz iki harfli ülke kodu.
file_namestring · isteğe bağlı
Liste için .txt ile biten bir ad.
expected_chargestring · isteğe bağlı
Dolar cinsinden bir fiyat, örneğin "18.00". Sipariş başka bir tutara mal oluyorsa price_changed ile reddedilir.

Örnek istek

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

Örnek yanıt (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
}

Siparişlerinizi listeleyin

GET/orders

En yeniler önce. Sonraki sayfa için next_cursor değerini cursor olarak geri gönderin.

Gereken API anahtarı: Salt okunur veya sipariş verebilen

Sorgu parametreleri

limitinteger · isteğe bağlı
Kaç tane döndürüleceği, 1 ile 100 arasında. Varsayılan 20'dir.
cursorstring · isteğe bağlı
Son sayfadan gelen next_cursor.

Örnek istek

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

Örnek yanıt (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
}

Tek sipariş

GET/orders/{id}

Durumu, kayıtları, ücreti, iadesi, parçaları ve sayıları. Bir parça bitene kadar results değeri null olur; denetleyicinin bildirmediği bir sayı da null olur.

Gereken API anahtarı: Salt okunur veya sipariş verebilen

Yol parametreleri

idstring · zorunlu
Siparişin id değeri.

Örnek istek

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

Örnek yanıt (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"
}

Sonuç dosyaları

GET/orders/{id}/results

Her parça için 15 dakika geçerli bir indirme bağlantısı. Hâlâ çalışan bir parçanın bağlantısı olmaz. Tamamlanmış bir parçanın bağlantısı yoksa desteğe başvurun.

Gereken API anahtarı: Salt okunur veya sipariş verebilen

Yol parametreleri

idstring · zorunlu
Siparişin id değeri.

Örnek istek

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

Örnek yanıt (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"
    }
  ]
}

Hatalar

Önceki

Denetleyiciler

Sonraki

Bu sayfada

BakiyenizDenetleyicileri listeleyinBüyük bir liste yükleyinBir siparişin ne kadar tutacağını görünSipariş verinSiparişlerinizi listeleyinTek siparişSonuç dosyaları