Contacts

รายการผู้ติดต่อ

แสดงผู้ติดต่อแบบเรียลไทม์ limit 1..100 ค่าเริ่มต้น 50 ส่วน cursor ที่ผิดหรือหมดอายุอาจถูกจัดการต่างกันตาม provider

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

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

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

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

account_id: รับ data.id จากการสร้างหรือค้นหาบัญชี รหัสเป็นของ workspace ที่ระบุด้วย X-Api-Key ดูบัญชี

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

ส่วนหัว

X-Api-Key

stringจำเป็น

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

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

account_id

stringจำเป็น

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

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

cursor

string

next_cursor แบบ opaque ละไว้เพื่อเริ่มหน้าแรก ส่วน cursor ที่ผิดหรือหมดอายุอาจถูกจัดการต่างกันตาม provider

limit

integer

ขนาดหน้าตั้งแต่ 1 ถึง 100 ค่าเริ่มต้นดูในคำอธิบาย endpoint

minimum: 1 · maximum: 100

q

string

ตัวกรองการค้นหาที่ตรงกับ display_name, phone หรือ username

updated_since

string

timestamp แบบ RFC3339; คืนเฉพาะผู้ติดต่อที่อัปเดตหลังจากเวลานั้น สำหรับการซิงก์แบบเพิ่มต่อเมื่อผู้ให้บริการรองรับ

format: date-time

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

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

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

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

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

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "items": [
      {
        "id": "user_example",
        "conversation_id": "peer_example",
        "display_name": "Alice",
        "avatar_url": "",
        "provider_user_id": "user_example",
        "extra": {
          "phone": "8600000000000"
        }
      }
    ],
    "next_cursor": "",
    "has_more": false
  }
}

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

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 仅返回部分号码时的遮蔽手机号。

next_cursor

string

cursor แบบ opaque สำหรับหน้าถัดไป ส่งกลับมาเป็น cursor; สตริงว่างหมายถึงไม่มีหน้าต่อไปแล้ว

has_more

boolean

เป็น true เมื่อมีผลลัพธ์เพิ่มเติมนอกเหนือจากหน้านี้

การตอบกลับ

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