سیدھے مواد پر جائیں
TalismanLeadsDocs
ہومAPI کلید حاصل کریں

API حوالہ

بنیادی پتا https://api.talismanleads.io/v1 ہے۔ اپ لوڈ اور ڈاؤن لوڈ لنکس کے علاوہ، ریکویسٹس اور جوابات JSON میں ہوتے ہیں۔ یہ OpenAPI فائل کے طور پر بھی دستیاب ہے۔

آپ کا بیلنس

GET/account

آپ کا بیلنس اور نافذ حدیں۔

API کلید میں درکار: صرف پڑھنے والی، یا آرڈر دینے کے قابل

مثالی ریکویسٹ

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

مثالی جواب (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
  }
}

چیکرز کی فہرست

GET/checkers

یہ اکاؤنٹ ابھی کیا آرڈر کر سکتا ہے، اس کی قیمتوں پر۔ روکا گیا یا بلاک شدہ چیکر فہرست میں نہیں آتا۔

API کلید میں درکار: صرف پڑھنے والی، یا آرڈر دینے کے قابل

مثالی ریکویسٹ

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

مثالی جواب (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
    }
  ]
}

بڑی فہرست اپ لوڈ کریں

POST/uploads

فائل سیدھی اسٹوریج میں بھیجنے کا لنک۔ اسے PUT اور دیے گئے ہیڈرز کے ساتھ بھیجیں۔ لنک 2 گھنٹے تک چلتا ہے۔

API کلید میں درکار: آرڈر دینے کے قابل

باڈی

size_bytesinteger · لازمی
فائل کا سائز، بائٹس میں۔
file_namestring · اختیاری
فہرست کا نام، جس کے آخر میں .txt ہو۔

مثالی ریکویسٹ

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

مثالی جواب (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"
}

دیکھیں کہ آرڈر پر کتنا خرچ آئے گا

POST/estimates

اندراجات گنتا ہے، قیمت نکالتا ہے اور فہرست میں کوئی بھی مسئلہ بتاتا ہے۔ کچھ چارج نہیں کرتا۔ جواب کے لیے 5 منٹ تک کا وقت رکھیں۔

API کلید میں درکار: آرڈر دینے کے قابل

باڈی

checkerstring · لازمی
GET /checkers سے ملا چیکر کا id۔
entriesstring[] · اختیاری
فہرست، ہر اندراج کے لیے ایک string، 100,000 اندراجات اور 4 MB تک۔ یہ یا upload_id بھیجیں۔
upload_idstring · اختیاری
POST /uploads سے ملا upload_id۔ یہ یا entries بھیجیں۔
countrystring · اختیاری
دو حروف کا ملکی کوڈ، اگر آپ بتانا چاہیں کہ نمبرز کس ملک کے ہیں۔
file_namestring · اختیاری
فہرست کا نام، جس کے آخر میں .txt ہو۔

مثالی ریکویسٹ

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

مثالی جواب (200)

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

آرڈر دیں

POST/orders

آپ کے بیلنس سے چارج کرتا ہے اور کام کو قطار میں ڈالتا ہے۔ نئے آرڈر پر 201 واپس کرتا ہے، اور دہرانے پر Idempotent-Replay: true کے ساتھ 200؛ اسی لمحے دہرانے پر 201 بھی مل سکتا ہے، اس لیے آرڈرز میں فرق id سے کریں۔ جواب کے لیے 5 منٹ تک کا وقت رکھیں۔

API کلید میں درکار: آرڈر دینے کے قابل

ہیڈرز

Idempotency-Keystring · لازمی
بغیر اسپیس کے 200 تک ASCII حروف۔ 7 دن تک وہی Idempotency-Key یعنی وہی آرڈر۔

باڈی

checkerstring · لازمی
GET /checkers سے ملا چیکر کا id۔
entriesstring[] · اختیاری
فہرست، ہر اندراج کے لیے ایک string، 100,000 اندراجات اور 4 MB تک۔ یہ یا upload_id بھیجیں۔
upload_idstring · اختیاری
POST /uploads سے ملا upload_id۔ یہ یا entries بھیجیں۔
countrystring · اختیاری
دو حروف کا ملکی کوڈ، اگر آپ بتانا چاہیں کہ نمبرز کس ملک کے ہیں۔
file_namestring · اختیاری
فہرست کا نام، جس کے آخر میں .txt ہو۔
expected_chargestring · اختیاری
ڈالر میں قیمت، جیسے "18.00"۔ اگر خرچ اس کے علاوہ کچھ ہو تو آرڈر price_changed کے ساتھ مسترد ہو جاتا ہے۔

مثالی ریکویسٹ

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

مثالی جواب (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
}

اپنے آرڈرز کی فہرست

GET/orders

سب سے نئے پہلے۔ اگلے صفحے کے لیے next_cursor کو cursor کے طور پر واپس بھیجیں۔

API کلید میں درکار: صرف پڑھنے والی، یا آرڈر دینے کے قابل

کوئری پیرامیٹرز

limitinteger · اختیاری
کتنے واپس کرنے ہیں، 1 سے 100 تک۔ طے شدہ قدر 20 ہے۔
cursorstring · اختیاری
پچھلے صفحے کا next_cursor۔

مثالی ریکویسٹ

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

مثالی جواب (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
}

ایک آرڈر

GET/orders/{id}

اس کا اسٹیٹس، اندراجات، چارج، ریفنڈ، حصے اور گنتیاں۔ کوئی حصہ مکمل ہونے تک results کی قدر null رہتی ہے، اور جہاں چیکر گنتی نہیں بتاتا وہاں وہ گنتی null ہوتی ہے۔

API کلید میں درکار: صرف پڑھنے والی، یا آرڈر دینے کے قابل

پاتھ پیرامیٹرز

idstring · لازمی
آرڈر کا id۔

مثالی ریکویسٹ

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

مثالی جواب (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"
}

نتائج کی فائلیں

GET/orders/{id}/results

ہر حصے کے لیے ڈاؤن لوڈ لنک، 15 منٹ تک کارآمد۔ ابھی چلتے ہوئے حصے کا کوئی لنک نہیں ہوتا۔ اگر مکمل حصے کا لنک نہ ہو تو سپورٹ سے رابطہ کریں۔

API کلید میں درکار: صرف پڑھنے والی، یا آرڈر دینے کے قابل

پاتھ پیرامیٹرز

idstring · لازمی
آرڈر کا id۔

مثالی ریکویسٹ

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

مثالی جواب (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"
    }
  ]
}

خرابیاں

پچھلا

چیکرز

اگلا

اس صفحے پر

آپ کا بیلنسچیکرز کی فہرستبڑی فہرست اپ لوڈ کریںدیکھیں کہ آرڈر پر کتنا خرچ آئے گاآرڈر دیںاپنے آرڈرز کی فہرستایک آرڈرنتائج کی فائلیں