सीधे कंटेंट पर जाएं
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"
    }
  ]
}

एरर

पिछला

चेकर

अगला

इस पेज पर

आपका बैलेंसचेकर की सूचीबड़ी लिस्ट अपलोड करेंदेखें कि ऑर्डर का कितना खर्च आएगाऑर्डर देंअपने ऑर्डर की सूचीएक ऑर्डरनतीजों की फ़ाइलें