Tham chiếu API

Contacts

Lấy liên hệ

Liên hệ thông thường không tồn tại trả 404 contact_not_found. Nếu hội thoại đích không tồn tại, trả 422 contact_not_found, numeric_code 35000 và message Conversation not found.

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

Kênh được hỗ trợ

WhatsAppLINEWhatsApp Protocol

Trước khi gọi

Dùng X-Api-Key của workspace sở hữu tài nguyên trên máy chủ. Thay mọi giá trị mẫu trước khi chạy.

Nguồn tham số
account_id
Lấy data.id từ phản hồi tạo hoặc truy vấn tài khoản. ID thuộc workspace của X-Api-Key. Lấy tài khoản
contact_id
Định danh liên hệ phía provider; truyền dưới dạng chuỗi opaque. whatsapp và whatsapp-protocol dùng LID (xxx@lid). whatsapp-protocol có thể trả về thành công dù thiếu các trường hồ sơ liên hệ; hãy dựa vào các trường thực tế được trả về.

WhatsApp Protocol: Chi tiết liên hệ cần LID có sẵn (xxx@lid). Chỉ dùng data.sender.id hoặc data.conversation.id khi đã kết thúc bằng @lid. Protocol không có truy vấn danh sách liên hệ và API này không suy ra LID từ số điện thoại. Không có LID thì không thể tra cứu. Phản hồi thành công có thể thiếu trường hồ sơ.

Tham số yêu cầu

Tiêu đề

X-Api-Key
stringbắt buộc

API key của không gian làm việc. Không gian làm việc được xác định từ tiêu đề này.

Tham số đường dẫn

account_id
stringbắt buộc

Định danh dùng cho route contacts.

Tham số truy vấn

contact_id
stringbắt buộc

Định danh liên hệ phía provider; truyền dưới dạng chuỗi opaque. whatsapp và whatsapp-protocol dùng LID (xxx@lid). whatsapp-protocol có thể trả về thành công dù thiếu các trường hồ sơ liên hệ; hãy dựa vào các trường thực tế được trả về.

Nội dung yêu cầu

Điểm cuối này không cần nội dung JSON.

Hiểu kết quả

Chỉ dùng trường hồ sơ thực sự trả về. Xem ID là chuỗi không diễn giải; thiếu trường không chứng minh liên hệ không tồn tại.

Phản hồi 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"
    }
  }
}

Nội dung phản hồi

id
string

Định danh liên hệ.

conversation_id
string

Định danh cuộc trò chuyện cho liên hệ này; dùng để gửi tin nhắn hoặc định vị cuộc trò chuyện.

display_name
string

Tên hiển thị của liên hệ, hoặc chuỗi rỗng khi thiếu.

avatar_url
string

URL ảnh đại diện của liên hệ, hoặc chuỗi rỗng khi thiếu.

provider_user_id
string

Định danh người dùng phía nhà cung cấp cho liên hệ.

is_blocked
boolean

Liên hệ có bị tài khoản kết nối chặn hay không.

extra
object

Các trường bổ sung riêng của nhà cung cấp, ví dụ phone.

phone
string

Số điện thoại được trích xuất từ phone JID của WhatsApp.

first_name
string

Tên viết tắt hoặc tên riêng của liên hệ được lưu trong danh bạ của tài khoản hiện tại.

full_name
string

Tên đầy đủ của liên hệ được lưu trong danh bạ của tài khoản hiện tại.

push_name
string

Tên hồ sơ do liên hệ tự đặt trong WhatsApp.

business_name
string

Tên doanh nghiệp hoặc tên đã xác minh của tài khoản WhatsApp Business.

redacted_phone
string

Số điện thoại được che một phần khi nhà cung cấp chỉ trả về một phần số.

Phản hồi

200

200 OK

Yêu cầu thành công. Xem ví dụ nội dung phản hồi.

400

Bad Request

Body, đường dẫn hoặc tham số yêu cầu không hợp lệ.

401

Unauthorized

Header X-Api-Key thiếu hoặc không hợp lệ.

404

Not Found

Không tìm thấy tài nguyên được yêu cầu. Kiểm tra error.code cùng với thao tác hiện tại.

409

Conflict

Thao tác đang yêu cầu xung đột với tài khoản hoặc tài nguyên nhà cung cấp đã có.

422

Unprocessable Entity

Yêu cầu hợp lệ nhưng không thể xác định hội thoại provider đích.

500

Internal Server Error

Dịch vụ gặp lỗi không mong muốn.

501

Not Implemented

Provider đã chọn chưa triển khai thao tác này.

502

Bad Gateway

Adapter hoặc upstream provider không thể hoàn tất thao tác.

Khi yêu cầu thất bại

Kiểm tra HTTP và error.code/numeric_code, giữ request_id. Sửa tham số, tiếp tục xác thực hoặc kiểm tra runtime tùy nguyên nhân. Xác nhận kết quả cũ trước khi thử lại thao tác gửi hoặc ghi. Tham chiếu mã lỗi

invalid_request · 10000 · 400
Kiểm tra trường bắt buộc, định dạng và điều kiện kênh rồi sửa yêu cầu.
missing_api_key · 11000 · 401
Kiểm tra X-Api-Key và workspace còn hoạt động.
invalid_api_key · 11001 · 401
Kiểm tra X-Api-Key và workspace còn hoạt động.