← บทความทั้งหมด
คู่มือ

รับ Webhook สาย WhatsApp ขาออกในเวิร์กสเปซทั่วไป

เวิร์กสเปซทั่วไปของ UnifyPort เตรียมสาย WhatsApp ขาออกแบบตัวต่อตัวได้ หาก endpoint ของ Webhook สมัครเพียง ["*"] ข้อความอาจยังมาถึง แต่ callback ของสายขาออกอาจไม่มา ให้ระบุชื่อ call.answered และ call.ended โดยตรงเพื่อรับทั้งสองเหตุการณ์

เอกสารการสร้างสาย ครอบคลุมสายเสียงและวิดีโอขาออกที่มนุษย์เริ่มผ่านอินเทอร์เฟซไม่เป็นทางการของ UnifyPort ส่วน call.incoming สงวนไว้สำหรับสายเข้าในอนาคต

1. ตรวจสอบกฎการสมัครเหตุการณ์

เวิร์กสเปซการสมัครเหตุการณ์สายขาออก
ทั่วไป["*"], [] หรือละรายการเฉพาะเหตุการณ์ทั่วไป
ทั่วไประบุชื่อใน subscribed_events โดยตรงรับเหตุการณ์สายขาออกที่ระบุ
รุ่นทดสอบรายการที่ระบุชื่อ wildcard รายการว่าง หรือละรายการรับเหตุการณ์สายขาออกที่ตรงกัน

endpoint ที่เข้าเงื่อนไขจะได้รับเหตุการณ์ตามชื่อที่ระบุ สำหรับเวิร์กสเปซทั่วไป สามารถคง * ไว้พร้อมชื่อเหตุการณ์การโทรทั้งสองรายการ เพื่อคงการครอบคลุมเหตุการณ์ทั่วไป การสมัคร call.incoming ที่สงวนไว้โดยตรงในเวิร์กสเปซทั่วไปจะได้รับ 403 beta_feature_not_enabled (41002)

2. อ่านการตั้งค่า endpoint ก่อนอัปเดต

ใช้การอ่าน endpoint ของ Webhook เพื่อตรวจสอบ URL ปลายทาง สถานะ การสมัครปัจจุบัน และนโยบายลองส่งซ้ำ ตรวจสอบว่า endpoint เป็นของเวิร์กสเปซหรือบัญชีรับส่งข้อความใด การอัปเดตจะคงการผูกบัญชีเดิมไว้

การอัปเดต endpoint ของ Webhook จะแทนที่การตั้งค่า เตรียมค่าที่ต้องการให้ครบก่อนส่ง และคง URL สถานะ และนโยบายลองส่งซ้ำเดิม หากเปิดการลงลายเซ็น ให้ดึงคีย์ลับเดิมจากการตั้งค่าที่ปลอดภัยของแอป การตอบกลับการอ่านมี signing_enabled ส่วนคีย์ลับเก็บไว้ฝั่งแอป การละ signing_secret หรือส่งค่าว่างจะปิดการลงลายเซ็น การละนโยบายลองส่งซ้ำจะคืนค่าเริ่มต้นเป็นการลองอีกสามครั้งหลังการส่งครั้งแรก

3. เพิ่มเหตุการณ์การโทรและคงการสมัครข้อความ

สำหรับ endpoint ที่ใช้ wildcard ให้ส่งเนื้อหาต่อไปนี้ไปที่ PATCH /v1/webhook-endpoints/{endpoint_id} ตัวอย่างใช้ endpoint ที่เปิดใช้งาน เปิดลายเซ็น และตั้งให้ลองส่งซ้ำสามครั้ง แทน URL สถานะ คีย์ลับ และค่าลองส่งซ้ำด้วยค่าปัจจุบัน เก็บ API key และคีย์ลับไว้บนเซิร์ฟเวอร์

{
  "url": "https://support.example.com/webhook",
  "status": "active",
  "subscribed_events": ["*", "call.answered", "call.ended"],
  "signing_secret": "<EXISTING_WEBHOOK_SIGNING_SECRET>",
  "retry_policy": { "max_attempts": 3 }
}

หากใช้รายการระบุชื่อ ให้คัดลอกชื่อเดิมแล้วเพิ่มเหตุการณ์การโทรสองรายการ ตัวอย่างเช่น หากรายการเดิมมีเพียง message.received และ message.read ให้ใช้ array ด้านล่างเป็นค่าฟิลด์ subscribed_events ในเนื้อหาคำขออัปเดตแบบครบถ้วน

["message.received", "message.read", "call.answered", "call.ended"]

อ่าน endpoint อีกครั้งหลังอัปเดต เทียบ URL สถานะ การสมัคร สถานะลายเซ็น และการลองส่งซ้ำกับค่าที่ตั้งใจ ตรวจสอบว่าฝั่งรับจัดการเหตุการณ์การโทรทั้งสองชนิดและเหตุการณ์ข้อความเดิมได้

4. ตรวจสอบการส่งด้วยสายขาออกใหม่หนึ่งสาย

  1. เลือกบทสนทนาทดสอบจากบัญชีรับส่งข้อความ WhatsApp เดียวกันที่ได้รับอนุญาตแล้ว เตรียมสายด้วย POST /v1/calls และเก็บ call_id ที่ได้คู่กับงานในแอป
  2. การตอบกลับ 201 ที่มี state: preparing ยืนยันว่าลิงก์พร้อม เจ้าหน้าที่เปิด join_url ส่วนตัวและกด Start call ก่อน expires_at
  3. เมื่อสายทดสอบเชื่อมต่อและสิ้นสุดแล้ว ให้หาเหตุการณ์เชื่อมต่อและเหตุการณ์สิ้นสุด เทียบ account_id และ data.call.id กับบันทึกที่เก็บไว้
  4. ส่งข้อความทดสอบผ่านขั้นตอนเดิมและยืนยันว่าเหตุการณ์ที่คาดหวังยังถึงฝั่งรับ

สำหรับ endpoint ที่ลงลายเซ็น ให้ตรวจสอบเนื้อหาคำขอดิบตามคู่มือการส่งและตรวจสอบลายเซ็น ตัดเหตุการณ์ซ้ำด้วย id และรองรับการมาผิดลำดับ เหตุการณ์เชื่อมต่อที่มาช้าสามารถเพิ่มหลักฐานได้ โดยบันทึกสายยังคงสถานะสิ้นสุด บันทึกการโทรใน message.* มีจุดประสงค์แยกกัน

5. ตรวจสอบ callback ที่ขาดและเตรียมคืนค่า

หาก callback ไม่มา ให้ตรวจชื่อเหตุการณ์ที่ตรงกัน ขอบเขต และสถานะเปิดใช้งานของ endpoint จากนั้นดูบันทึกฝั่งรับ การตอบกลับ HTTP และข้อมูลที่แอปจัดเก็บ ค่า 2xx ยืนยันการส่ง ให้ตรวจการจัดเก็บและการเชื่อมโยงกับงานแยกกัน การส่ง การลองใหม่ และการส่ง dead letter ซ้ำใช้สิทธิ์และการสมัครปัจจุบัน

เก็บการตั้งค่า endpoint เดิมและข้อมูลอ้างอิงคีย์ลับไว้ เมื่อต้องคืนค่า ให้ส่งการตั้งค่าเดิมแบบครบถ้วนและตรวจการส่งข้อความอีกครั้ง หากต้องการความช่วยเหลือ ให้ส่งรหัส endpoint บัญชี และสาย เวลา UTC และผลฝั่งรับที่ปกปิดข้อมูลลับให้ฝ่ายสนับสนุนด้านเทคนิค เก็บ API key คีย์ลับ และลิงก์สายแบบเต็มเป็นส่วนตัว

UnifyPort API

เปลี่ยนการเชื่อมต่อข้อความให้เป็น pipeline ผลิตภัณฑ์ที่เสถียร

เริ่มจากการส่งผ่าน API เดียว แล้วส่งข้อความขาเข้าทั้งหมดกลับสู่ระบบธุรกิจของคุณด้วย event มาตรฐาน