Contacts

เพิ่มผู้ติดต่อ

เพิ่มผู้ติดต่อไปยังสมุดรายชื่อของบัญชีที่เชื่อมต่อ ต้องระบุ phone_number หรือ username อย่างน้อยหนึ่งฟิลด์ whatsapp_options รองรับเฉพาะ WhatsApp และต้องส่งเป็นออบเจ็กต์ซ้อน provider ที่ไม่รองรับจะคืน 501 unsupported_by_provider

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

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

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

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

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

คำขอ

curl -X POST "https://api.unifyport.ai/v1/accounts/{account_id}/contacts/add" \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "phone_number": "8600000000000",
  "username": "alice_user",
  "whatsapp_options": {
    "first_name": "Alice",
    "full_name": "Alice Example",
    "sync_to_device_contacts": false
  }
}'

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

ส่วนหัว

X-Api-Key

stringจำเป็น

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

Content-Type

stringจำเป็น

ใช้ application/json เมื่อต้องส่งเนื้อหาของคำขอเป็น JSON

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

account_id

stringจำเป็น

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

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

phone_number

string

หมายเลขโทรศัพท์ของผู้ติดต่อในรูปแบบสากล ต้องระบุ phone_number หรือ username อย่างน้อยหนึ่งฟิลด์

minLength: 1

username

string

ชื่อผู้ใช้ของผู้ติดต่อฝั่ง provider ต้องระบุ username หรือ phone_number อย่างน้อยหนึ่งฟิลด์

minLength: 1

whatsapp_options

object

ตัวเลือกการสร้างผู้ติดต่อสำหรับ WhatsApp เท่านั้น ต้องส่งเป็นออบเจ็กต์ซ้อนใน whatsapp_options

first_name

string

ชื่อจริงของผู้ติดต่อ WhatsApp (ไม่บังคับ)

full_name

string

ชื่อเต็มของผู้ติดต่อ WhatsApp (ไม่บังคับ)

sync_to_device_contacts

boolean

กำหนดว่าจะซิงค์ผู้ติดต่อไปยังสมุดรายชื่อของอุปกรณ์ WhatsApp หรือไม่ ค่าเริ่มต้นคือ false

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

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

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

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "id": "8600000000000@s.whatsapp.net",
    "conversation_id": "123456789012345@lid",
    "display_name": "Alice Example",
    "avatar_url": "",
    "provider_user_id": "8600000000000@s.whatsapp.net",
    "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 หายไปหรือไม่ถูกต้อง

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