ข้ามไปยังเนื้อหา
TalismanLeadsDocs
หน้าแรกรับคีย์ API

เอกสารอ้างอิง API

URL หลักคือ 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 · จำเป็น
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 · จำเป็น
อักขระ ASCII ไม่เกิน 200 ตัวโดยไม่มีช่องว่าง ภายใน 7 วัน คีย์ idempotency เดียวกันหมายถึงคำสั่งซื้อเดียวกัน

เนื้อหาคำขอ

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

ข้อผิดพลาด

ก่อนหน้า

ตัวตรวจสอบ

ถัดไป

ในหน้านี้

ยอดคงเหลือของคุณแสดงรายการตัวตรวจสอบอัปโหลดรายชื่อขนาดใหญ่ดูค่าใช้จ่ายของคำสั่งซื้อสั่งซื้อแสดงรายการคำสั่งซื้อของคุณคำสั่งซื้อหนึ่งรายการไฟล์ผลลัพธ์