Contacts

Kiểm tra trạng thái liên hệ

Kiểm tra liên hệ có nằm trong danh bạ của tài khoản đã kết nối hay không. Với WhatsApp, hãy truyền LID được Contact API trả về dưới dạng conversation_id. is_in_contacts=false là kết quả 200 bình thường, không phải lỗi 404. Kênh không hỗ trợ trả về 501 unsupported_by_provider.

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

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: Liên hệ cần kiểm tra. Với WhatsApp, truyền LID được Contact API trả về dưới dạng conversation_id và URL-encode ký tự @ trong chuỗi truy vấn.

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

Liên hệ cần kiểm tra. Với WhatsApp, truyền LID được Contact API trả về dưới dạng conversation_id và URL-encode ký tự @ trong chuỗi truy vấn.

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ả

Đọc trường phản hồi và trạng thái HTTP được mô tả. Thành công 204 không có nội dung; dùng X-Request-Id để chẩn đoán. Xem thao tác liên quan cho bước tiếp theo.

Phản hồi 200 OK

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

Nội dung phản hồi

contact_id

string

Định danh liên hệ đã kiểm tra. Với WhatsApp, đây là LID được truyền trong yêu cầu.

is_in_contacts

boolean

Liên hệ có nằm trong danh bạ của tài khoản đã kết nối hay không. false vẫn là phản hồi 200 thành công.

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ệ.

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ó.

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.
invalid_api_key · 11001 · 401: Kiểm tra X-Api-Key và workspace còn hoạt động.