Hội thoại

Thêm / gỡ nhãn trên hội thoại

Gắn hoặc gỡ nhãn cho một loạt hội thoại. action là add hoặc remove; conversation_ids phải chứa ít nhất một id. Chỉ hỗ trợ WhatsApp — các nhà cung cấp khác trả về 501 unsupported_by_provider.

POSThttps://api.unifyport.ai/v1/accounts/{account_id}/conversations/labels

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

Yêu cầu

curl -X POST "https://api.unifyport.ai/v1/accounts/{account_id}/conversations/labels" \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "label_id": "label_example",
  "action": "add",
  "conversation_ids": ["peer_example"]
}'

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.

Content-Type

stringbắt buộc

Dùng application/json khi gửi nội dung yêu cầu JSON.

Tham số đường dẫn

account_id

stringbắt buộc

Định danh dùng cho route conversations.

Nội dung yêu cầu

label_id

stringbắt buộc

Định danh nhãn.

action

stringbắt buộc

Hành động thành viên nhãn: add hoặc remove.

enum: add, remove

conversation_ids[]

string[]bắt buộc

Các định danh cuộc trò chuyện được thay đổi quan hệ với nhãn.

minItems: 1

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": {
    "label_id": "label_example",
    "action": "add",
    "conversation_ids": [
      "peer_example"
    ]
  }
}

Nội dung phản hồi

label_id

string

Định danh nhãn đã bị xóa hoặc thay đổi.

action

string

Hành động thành viên nhãn đã áp dụng.

enum: add, remove

conversation_ids[]

string[]

Các định danh cuộc trò chuyện bị ảnh hưởng bởi hành độ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.