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

Contacts

ตรวจสอบสถานะผู้ติดต่อ

ตรวจสอบว่าผู้ติดต่ออยู่ในสมุดรายชื่อของบัญชีที่เชื่อมต่อหรือไม่ สำหรับ WhatsApp ให้ใช้ LID ที่ Contact API คืนเป็น conversation_id ค่า is_in_contacts=false เป็นผลลัพธ์ 200 ปกติ ไม่ใช่ 404 และ provider ที่ไม่รองรับจะคืน 501 unsupported_by_provider

GEThttps://api.unifyport.ai/v1/accounts/{account_id}/contacts/membership

ก่อนเรียกใช้

ใช้ X-Api-Key ของ workspace เจ้าของทรัพยากรบนเซิร์ฟเวอร์ แทนค่าตัวอย่างทั้งหมดก่อนเรียกใช้

ที่มาของพารามิเตอร์
account_id
รับ data.id จากการสร้างหรือค้นหาบัญชี รหัสเป็นของ workspace ที่ระบุด้วย X-Api-Key ดูบัญชี
contact_id
ผู้ติดต่อที่ต้องการตรวจสอบ สำหรับ WhatsApp ให้ใช้ LID ที่ Contact API คืนเป็น conversation_id และ URL-encode เครื่องหมาย @ ใน query string

พารามิเตอร์คำขอ

ส่วนหัว

X-Api-Key
stringจำเป็น

API key ของพื้นที่ทำงาน ระบบจะระบุพื้นที่ทำงานจากส่วนหัวนี้

พารามิเตอร์ใน path

account_id
stringจำเป็น

ตัวระบุที่ใช้ใน route ของ contacts

พารามิเตอร์ Query

contact_id
stringจำเป็น

ผู้ติดต่อที่ต้องการตรวจสอบ สำหรับ WhatsApp ให้ใช้ LID ที่ Contact API คืนเป็น conversation_id และ URL-encode เครื่องหมาย @ ใน query string

เนื้อหาของคำขอ

จุดเชื่อมต่อนี้ไม่ต้องใช้เนื้อหา JSON

ทำความเข้าใจผลลัพธ์

อ่านฟิลด์ตอบกลับและสถานะ HTTP ตามเอกสาร 204 สำเร็จไม่มีเนื้อหา ใช้ X-Request-Id เพื่อตรวจสอบ ขั้นตอนต่อไปอยู่ในการทำงานที่เกี่ยวข้อง

การตอบกลับ 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "contact_id": "123456789012345@lid",
    "is_in_contacts": true
  }
}

เนื้อหาการตอบกลับ

contact_id
string

ตัวระบุผู้ติดต่อที่ตรวจสอบ สำหรับ WhatsApp คือ LID ที่ส่งในคำขอ

is_in_contacts
boolean

ผู้ติดต่ออยู่ในสมุดรายชื่อของบัญชีที่เชื่อมต่อหรือไม่ ค่า false ยังคงเป็นผลลัพธ์ 200 ที่สำเร็จ

การตอบกลับ

200

200 OK

คำขอสำเร็จ ดูตัวอย่างเนื้อหาตอบกลับด้านบน

400

Bad Request

เนื้อหาของคำขอ path หรือพารามิเตอร์ไม่ถูกต้อง

401

Unauthorized

ส่วนหัว X-Api-Key หายไปหรือไม่ถูกต้อง

409

Conflict

การดำเนินการขัดแย้งกับบัญชีของผู้ให้บริการหรือทรัพยากรที่มีอยู่

500

Internal Server Error

บริการพบข้อผิดพลาดที่ไม่คาดคิด

501

Not Implemented

provider ที่เลือกยังไม่รองรับการดำเนินการนี้

502

Bad Gateway

อะแดปเตอร์หรือ upstream provider ไม่สามารถทำรายการให้เสร็จได้

เมื่อคำขอล้มเหลว

ตรวจ HTTP และ error.code/numeric_code เก็บ request_id แล้วแก้พารามิเตอร์ ยืนยันตัวตนต่อ หรือตรวจ runtime ตามสาเหตุ ตรวจผลครั้งก่อนก่อนส่งหรือเขียนซ้ำ อ้างอิงรหัสข้อผิดพลาด

invalid_request · 10000 · 400
ตรวจฟิลด์บังคับ รูปแบบ และเงื่อนไขช่องทาง แล้วแก้คำขอ
invalid_api_key · 11001 · 401
ตรวจ X-Api-Key และว่า workspace ยังใช้งานอยู่