Langsung ke konten
TalismanLeadsDocs
BerandaDapatkan kunci API

Referensi API

Alamat dasarnya adalah https://api.talismanleads.io/v1. Permintaan dan respons berformat JSON, kecuali tautan unggah dan unduh. Tersedia juga sebagai file OpenAPI.

Saldo Anda

GET/account

Saldo Anda dan batas yang berlaku.

Kunci API yang diperlukan: Hanya-baca, atau dapat membuat pesanan

Contoh permintaan

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

Contoh respons (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
  }
}

Daftar pemeriksa

GET/checkers

Apa yang dapat dipesan akun ini saat ini, dengan harganya. Pemeriksa yang dijeda atau diblokir tidak tercantum.

Kunci API yang diperlukan: Hanya-baca, atau dapat membuat pesanan

Contoh permintaan

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

Contoh respons (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
    }
  ]
}

Unggah daftar besar

POST/uploads

Tautan untuk mengirim file langsung ke penyimpanan. Kirim dengan PUT dan header yang diberikan. Tautan berlaku 2 jam.

Kunci API yang diperlukan: Dapat membuat pesanan

Body

size_bytesinteger · wajib
Ukuran file, dalam byte.
file_namestring · opsional
Nama untuk daftar, diakhiri dengan .txt.

Contoh permintaan

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

Contoh respons (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"
}

Lihat biaya pesanan

POST/estimates

Menghitung entri dan harganya, serta melaporkan masalah apa pun pada daftar. Tidak menagih apa pun. Sediakan waktu hingga 5 menit untuk respons.

Kunci API yang diperlukan: Dapat membuat pesanan

Body

checkerstring · wajib
id pemeriksa dari GET /checkers.
entriesstring[] · opsional
Daftarnya, satu string per entri, hingga 100.000 entri dan 4 MB. Kirim ini atau upload_id.
upload_idstring · opsional
upload_id dari POST /uploads. Kirim ini atau entries.
countrystring · opsional
Kode negara dua huruf, jika Anda ingin menyebutkan asal negara nomor-nomor itu.
file_namestring · opsional
Nama untuk daftar, diakhiri dengan .txt.

Contoh permintaan

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

Contoh respons (200)

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

Buat pesanan

POST/orders

Menagih saldo Anda dan memasukkan pekerjaan ke antrean. Merespons 201 untuk pesanan baru, dan 200 dengan Idempotent-Replay: true untuk pengulangan; pengulangan pada saat yang sama juga bisa merespons 201, jadi bedakan pesanan berdasarkan id. Sediakan waktu hingga 5 menit untuk respons.

Kunci API yang diperlukan: Dapat membuat pesanan

Header

Idempotency-Keystring · wajib
Hingga 200 karakter ASCII tanpa spasi. Selama 7 hari, Idempotency-Key yang sama berarti pesanan yang sama.

Body

checkerstring · wajib
id pemeriksa dari GET /checkers.
entriesstring[] · opsional
Daftarnya, satu string per entri, hingga 100.000 entri dan 4 MB. Kirim ini atau upload_id.
upload_idstring · opsional
upload_id dari POST /uploads. Kirim ini atau entries.
countrystring · opsional
Kode negara dua huruf, jika Anda ingin menyebutkan asal negara nomor-nomor itu.
file_namestring · opsional
Nama untuk daftar, diakhiri dengan .txt.
expected_chargestring · opsional
Harga dalam dolar, misalnya "18.00". Pesanan ditolak dengan price_changed jika biayanya berbeda.

Contoh permintaan

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

Contoh respons (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
}

Daftar pesanan Anda

GET/orders

Terbaru lebih dulu. Kirim kembali next_cursor sebagai cursor untuk halaman berikutnya.

Kunci API yang diperlukan: Hanya-baca, atau dapat membuat pesanan

Parameter query

limitinteger · opsional
Berapa banyak yang dikembalikan, dari 1 sampai 100. Bawaannya 20.
cursorstring · opsional
next_cursor dari halaman terakhir.

Contoh permintaan

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

Contoh respons (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
}

Satu pesanan

GET/orders/{id}

Status, entri, tagihan, pengembalian dana, bagian, dan jumlahnya. results bernilai null sampai ada bagian yang selesai, dan suatu jumlah bernilai null jika pemeriksa tidak melaporkannya.

Kunci API yang diperlukan: Hanya-baca, atau dapat membuat pesanan

Parameter path

idstring · wajib
id pesanan.

Contoh permintaan

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

Contoh respons (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"
}

File hasil

GET/orders/{id}/results

Tautan unduhan untuk setiap bagian, berlaku 15 menit. Bagian yang masih berjalan tidak punya tautan. Hubungi dukungan jika bagian yang sudah selesai tidak punya tautan.

Kunci API yang diperlukan: Hanya-baca, atau dapat membuat pesanan

Parameter path

idstring · wajib
id pesanan.

Contoh permintaan

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

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

Error

Sebelumnya

Pemeriksa

Berikutnya

Di halaman ini

Saldo AndaDaftar pemeriksaUnggah daftar besarLihat biaya pesananBuat pesananDaftar pesanan AndaSatu pesananFile hasil