เอกสารอ้างอิง API
เริ่มต้นใช้งาน

เริ่มอย่างรวดเร็ว: ข้อความแรกบน WhatsApp

จากพื้นที่ทำงานว่างเปล่าไปสู่ข้อความ WhatsApp ที่ส่งสำเร็จและอีเวนต์ webhook ขาเข้าครั้งแรกของคุณ ภายในหกขั้นตอน แต่ละขั้นมีลิงก์ไปยังเอกสารอ้างอิงฉบับเต็มของจุดเชื่อมต่อนั้น ๆ

เริ่มต้นใช้งาน

  1. 1

    เตรียม API key ให้พร้อม

    ขณะนี้ UnifyPort เปิดให้บริการเฉพาะลูกค้าที่ได้รับคัดเลือก — ติดต่อทีมงานเพื่อขอสิทธิ์เข้าถึงพื้นที่ทำงาน ทุกคำขอด้านล่างยืนยันตัวตนด้วยส่วนหัว X-Api-Key

    curl https://api.unifyport.ai/v1/workspace \
      -H "X-Api-Key: <YOUR_API_KEY>"
    ดูพื้นที่ทำงานปัจจุบัน
  2. 2

    ลงทะเบียนจุดเชื่อมต่อ webhook

    ทำขั้นนี้ก่อน: ความคืบหน้าการให้สิทธิ์และข้อความขาเข้าทุกฉบับมาถึงในรูปอีเวนต์ webhook เท่านั้น และอีเวนต์ที่พลาดไปจะไม่ถูกส่งซ้ำ การ subscribe ด้วย ["*"] จะได้รับแคตตาล็อก event มาตรฐานครบชุด

    curl -X POST https://api.unifyport.ai/v1/webhook-endpoints \
      -H "X-Api-Key: <YOUR_API_KEY>" \
      -H "Content-Type: application/json" \
      -d '{
      "url": "https://example.com/webhook",
      "subscribed_events": ["*"],
      "signing_secret": "<WEBHOOK_SIGNING_SECRET>"
    }'
    สร้าง จุดเชื่อมต่อ Webhook
  3. 3

    ตรวจสอบภูมิภาคที่ใช้งานได้

    บัญชีถูกผูกกับภูมิภาคหนึ่ง และไม่ใช่ผู้ให้บริการทุกรายจะให้บริการในทุกภูมิภาค ให้เรียกดูรายการภูมิภาคของผู้ให้บริการก่อน แล้วเลือกภูมิภาคที่ allocatable: true — การสร้างบัญชีในภูมิภาคที่จัดสรรไม่ได้จะล้มเหลวด้วย 409 no_allocatable_server

    curl https://api.unifyport.ai/v1/providers/whatsapp/regions \
      -H "X-Api-Key: <YOUR_API_KEY>"
    รายชื่อภูมิภาคของผู้ให้บริการ
  4. 4

    สร้างบัญชี WhatsApp

    หนึ่งบัญชีคืออุปกรณ์เสมือนหนึ่งเครื่อง ใช้ภูมิภาคที่ allocatable ตามขั้นก่อนหน้า สำหรับการจับคู่ WhatsApp ด้วยหมายเลขโทรศัพท์ ให้ใช้ auth_mode=code และตั้ง provider_data.phone เป็นหมายเลข E.164 ตัวเลขล้วน — ระบบจะบันทึกไว้ในบัญชีและใช้ซ้ำในขั้นถัดไป

    curl -X POST https://api.unifyport.ai/v1/accounts \
      -H "X-Api-Key: <YOUR_API_KEY>" \
      -H "Content-Type: application/json" \
      -d '{
      "name": "WhatsApp Support",
      "provider": "whatsapp",
      "region": "global",
      "status": "active",
      "auth_mode": "code",
      "provider_data": { "phone": "8613800138000" }
    }'
    สร้างบัญชี
  5. 5

    จับคู่โทรศัพท์

    เริ่มโฟลว์ด้วย body ว่าง — ระบบจะใช้หมายเลขที่บันทึกไว้ และการตอบกลับจะมี verify_code 8 ตัวอักษรอยู่ใน auth_payload บนโทรศัพท์ให้เปิด WhatsApp → อุปกรณ์ที่เชื่อมต่อ → เชื่อมต่อด้วยหมายเลขโทรศัพท์ แล้วกรอกรหัสภายในประมาณ 3 นาที เมื่อสำเร็จ webhook ของคุณจะได้รับ account.auth.succeeded ตามด้วย account.started รันไทม์เริ่มอัตโนมัติ ไม่ต้องเรียก /runtime/start

    curl -X POST https://api.unifyport.ai/v1/accounts/<ACCOUNT_ID>/auth/start \
      -H "X-Api-Key: <YOUR_API_KEY>"
    เริ่มยืนยันด้วยรหัส
  6. 6

    ส่งข้อความแรกของคุณ

    ส่ง JSON ที่ปรับเป็นมาตรฐาน — UnifyPort จะแปลให้เข้ากับผู้ให้บริการเอง สำหรับ WhatsApp id ของผู้รับคือ <E.164>@s.whatsapp.net

    curl -X POST https://api.unifyport.ai/v1/messages \
      -H "X-Api-Key: <YOUR_API_KEY>" \
      -H "Content-Type: application/json" \
      -d '{
      "account_id": "<ACCOUNT_ID>",
      "to": { "id": "8613912345678@s.whatsapp.net", "type": "user" },
      "message": { "type": "text", "text": "Hello from UnifyPort" }
    }'
    ส่งข้อความตัวอักษร
  7. 7

    รับอีเวนต์แรกของคุณ

    ตอบกลับจากโทรศัพท์อีกเครื่อง: อีเวนต์ message.received จะมาถึงจุดเชื่อมต่อ webhook ของคุณภายในไม่กี่วินาที จากจุดนี้ค่อยตรวจสอบลายเซ็นของการส่งและจัดการแคตตาล็อก event มาตรฐานต่อ

    Webhook delivery & signature verification