انتقل إلى المحتوى
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 والترويسات المحددة. يبقى الرابط صالحًا ساعتين.

صلاحية مفتاح 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 · مطلوب
id أداة الفحص من GET /checkers.
entriesstring[] · اختياري
القائمة، سلسلة نصية واحدة لكل إدخال، حتى 100,000 إدخال و4 MB. أرسل هذا أو upload_id.
upload_idstring · اختياري
upload_id من POST /uploads. أرسل هذا أو 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 للطلبية الجديدة، وبـ200 مع Idempotent-Replay: true عند الإعادة؛ وقد تجيب الإعادة في اللحظة نفسها بـ201 أيضًا، لذا ميّز الطلبيات بـid. اترك ما يصل إلى 5 دقائق لوصول الاستجابة.

صلاحية مفتاح API: قادر على تقديم الطلبيات

الترويسات

Idempotency-Keystring · مطلوب
ما يصل إلى 200 حرف ASCII بلا مسافات. طوال 7 أيام، يعني مفتاح Idempotency-Key نفسه الطلبية نفسها.

النص

checkerstring · مطلوب
id أداة الفحص من GET /checkers.
entriesstring[] · اختياري
القائمة، سلسلة نصية واحدة لكل إدخال، حتى 100,000 إدخال و4 MB. أرسل هذا أو upload_id.
upload_idstring · اختياري
upload_id من POST /uploads. أرسل هذا أو 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"
    }
  ]
}

الأخطاء

السابق

أدوات الفحص

التالي

في هذه الصفحة

رصيدكعرض أدوات الفحصرفع قائمة كبيرةمعرفة تكلفة الطلبيةتقديم طلبيةعرض طلبياتكطلبية واحدةملفات النتائج