Tham chiếu API

Kênh

Ủy quyền WhatsApp Protocol

WhatsApp Protocol là kênh độc lập, được xác định bằng provider=whatsapp-protocol. Hiện chỉ hỗ trợ nhập phiên (auth_mode=session), sử dụng thông tin phiên có sẵn để ủy quyền tài khoản.

Bắt đầu

  1. 1

    Liệt kê khu vực của nhà cung cấp

    Truy vấn vùng của whatsapp-protocol và chọn vùng có allocatable=true. Nếu không có vùng nào như vậy, hiện chưa thể tạo tài khoản tại các vùng này.

    curl -X GET "https://api.unifyport.ai/v1/providers/whatsapp-protocol/regions" \
  -H "X-Api-Key: <YOUR_API_KEY>"
    Liệt kê khu vực của nhà cung cấp
  2. 2

    Tạo tài khoản

    Tạo tài khoản với provider=whatsapp-protocol, auth_mode=session; lưu data.id làm account_id. Chỉ gửi thông tin giao thức tới /auth/session, không đặt trong provider_data.

    curl -X POST "https://api.unifyport.ai/v1/accounts" \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "WhatsApp Protocol",
  "provider": "whatsapp-protocol",
  "region": "<REGION>",
  "auth_mode": "session"
}'
    Tạo tài khoản
  3. 3

    Import session xác thực

    Gửi đối tượng whatsapp-protocol dưới đây. phone và bốn trường khóa là bắt buộc cho luồng này. Khóa chỉ ghi, không trả lại trong phản hồi. Bỏ trường đã ngừng dùng và không gửi edge_routing.

    curl -X POST "https://api.unifyport.ai/v1/accounts/<ACCOUNT_ID>/auth/session" \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "whatsapp-protocol": {
    "phone": "8600000000000",
    "static_pub_key": "<STATIC_PUBLIC_KEY>",
    "static_pri_key": "<STATIC_PRIVATE_KEY>",
    "identity_pub_key": "<IDENTITY_PUBLIC_KEY>",
    "identity_pri_key": "<IDENTITY_PRIVATE_KEY>"
  }
}'
    Import session xác thực
  4. 4

    Kiểm tra trạng thái sẵn sàng

    Sau khi nhập, truy vấn xác thực và runtime theo account_id. authorized không đồng nghĩa đã kết nối. Nếu vẫn ngoại tuyến, làm mới runtime trước khi thử gửi.

    curl -X GET "https://api.unifyport.ai/v1/accounts/<ACCOUNT_ID>/auth" \
  -H "X-Api-Key: <YOUR_API_KEY>"

curl -X POST "https://api.unifyport.ai/v1/accounts/<ACCOUNT_ID>/runtime/refresh" \
  -H "X-Api-Key: <YOUR_API_KEY>"
    Refresh trạng thái runtime

Ghi chú

  • Hỗ trợ text, image và chi tiết liên hệ. Không hỗ trợ trả lời trích dẫn, mentions, danh sách/ghi liên hệ, hội thoại hoặc nhóm. Ánh xạ sự kiện gồm message.received văn bản/ảnh, account.started, account.status.updated, account.auth.failed; giao nhận thực tế phụ thuộc tài khoản nguồn.
  • 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ơ.