Contacts

ดูผู้ติดต่อ

ผู้ติดต่อทั่วไปที่ไม่มีคืน 404 contact_not_found หากบทสนทนาเป้าหมายไม่มี คืน 422 contact_not_found, numeric_code 35000 และ message Conversation not found

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

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

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

ที่มาของพารามิเตอร์

account_id: รับ data.id จากการสร้างหรือค้นหาบัญชี รหัสเป็นของ workspace ที่ระบุด้วย X-Api-Key ดูบัญชี
contact_id: ตัวระบุผู้ติดต่อฝั่ง provider ให้ส่งเป็นสตริง opaque โดย whatsapp และ whatsapp-protocol ใช้ LID (xxx@lid) สำหรับ whatsapp-protocol อาจตอบกลับสำเร็จแม้ขาดฟิลด์โปรไฟล์ผู้ติดต่อ ให้ยึดฟิลด์ที่ส่งกลับมาจริง

WhatsApp Protocol: รายละเอียดผู้ติดต่อต้องใช้ LID ที่มีอยู่ (xxx@lid) ใช้ data.sender.id หรือ data.conversation.id ได้เฉพาะเมื่อค่าลงท้ายด้วย @lid อยู่แล้ว Protocol ไม่มี API รายชื่อผู้ติดต่อ และ API นี้ไม่สามารถหา LID จากหมายเลขโทรศัพท์ได้ หากไม่มี LID จะสอบถามไม่ได้ ผลสำเร็จอาจไม่มีข้อมูลโปรไฟล์บางฟิลด์

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

ส่วนหัว

X-Api-Key

stringจำเป็น

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

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

account_id

stringจำเป็น

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

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

contact_id

stringจำเป็น

ตัวระบุผู้ติดต่อฝั่ง provider ให้ส่งเป็นสตริง opaque โดย whatsapp และ whatsapp-protocol ใช้ LID (xxx@lid) สำหรับ whatsapp-protocol อาจตอบกลับสำเร็จแม้ขาดฟิลด์โปรไฟล์ผู้ติดต่อ ให้ยึดฟิลด์ที่ส่งกลับมาจริง

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

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

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

ใช้เฉพาะข้อมูลโปรไฟล์ที่ตอบกลับจริง มองรหัสเป็นสตริงทึบแสง การไม่มีข้อมูลไม่ได้แปลว่าไม่มีผู้ติดต่อ

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

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "id": "user_example",
    "conversation_id": "peer_example",
    "display_name": "Alice",
    "avatar_url": "",
    "provider_user_id": "user_example",
    "extra": {
      "phone": "8600000000000"
    }
  }
}

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

id

string

ตัวระบุผู้ติดต่อ

conversation_id

string

ตัวระบุบทสนทนาสำหรับผู้ติดต่อนี้ ใช้เพื่อส่งข้อความหรือค้นหาแชต

display_name

string

ชื่อแสดงผลของผู้ติดต่อ หรือสตริงว่างเมื่อไม่มีค่า

avatar_url

string

URL รูปประจำตัวของผู้ติดต่อ หรือสตริงว่างเมื่อไม่มีค่า

provider_user_id

string

ตัวระบุผู้ใช้ฝั่งผู้ให้บริการสำหรับผู้ติดต่อ

is_blocked

boolean

ผู้ติดต่อถูกบล็อกโดยบัญชีที่เชื่อมต่อหรือไม่

extra

object

ฟิลด์เพิ่มเติมเฉพาะของผู้ให้บริการ เช่น phone

phone

string

WhatsApp phone JID 中解析出的纯手机号。

first_name

string

当前账号通讯录中保存的联系人简称或名字部分。

full_name

string

当前账号通讯录中保存的完整联系人名称。

push_name

string

联系人自行在 WhatsApp 设置的个人名称。

business_name

string

WhatsApp Business 账号的商业或认证名称。

redacted_phone

string

Provider 仅返回部分号码时的遮蔽手机号。

การตอบกลับ

200

200 OK

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

400

Bad Request

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

401

Unauthorized

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

404

Not Found

ไม่พบทรัพยากรของ provider ที่ร้องขอ

409

Conflict

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

422

Unprocessable Entity

คำขอถูกต้องแต่ไม่สามารถระบุบทสนทนาเป้าหมายของ provider ได้

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 ยังใช้งานอยู่