Hệ thống của bạn gọi Whatsplaid để truy vấn khả năng, quản lý liên hệ, theo dõi cuộc trò chuyện, gửi tin nhắn, điều khiển tác nhân AI và yêu cầu hỗ trợ con người.
API công khai và tài liệu
Kết nối hệ thống của bạn với Whatsplaid thông qua API, bộ kết nối và webhook.
Sử dụng API công khai để tích hợp danh bạ, cuộc trò chuyện, tin nhắn, hỗ trợ nhân viên và đại lý AI. Sử dụng connector ngoại để truy vấn dữ liệu từ hệ thống của bạn và webhooks để nhận sự kiện theo thời gian thực.
Ba hợp đồng
Chọn hướng tích hợp chính xác.
Tài liệu Swagger tách các luồng để tránh nhầm lẫn giữa các cuộc gọi đến Whatsplaid, các truy vấn do trợ lý thực hiện và các sự kiện gửi đến hệ thống của bạn.
Whatsplaid sẽ gọi hệ thống của bạn để tra cứu sản phẩm, đơn hàng, khách hàng hoặc tình trạng sẵn có theo thời gian thực trong quá trình trò chuyện.
Tìm hiểu bộ kết nối bên ngoài qua APIWhatsplaid gửi sự kiện lead, tin nhắn, trạng thái giao hàng, ticket và thay đổi của agent AI tới một URL được cấu hình.
Swagger tại `api.whatsplaid.com/docs/` chứa các sơ đồ, ví dụ, phản hồi dự kiến và các hợp đồng kỹ thuật đầy đủ.
Tham khảo nhanh các endpoints chính.
Chế độ xem này tóm tắt các tính năng xuất hiện trong tài liệu chính thức. Việc triển khai cuối cùng phải tuân theo Swagger.
GET
/store
Trả về dữ liệu tài khoản, cửa hàng thương mại điện tử được kết nối và các mô-đun đang hoạt động.
Account
GET
/capabilities
Hiển thị những thao tác thực sự khả dụng theo tài khoản, gói, mô-đun và các tích hợp.
Account
GET
/ecommerce/products/search
Tìm kiếm sản phẩm trong các tích hợp gốc đã kết nối, chẳng hạn như Nuvemshop, Wix hoặc Shopify.
Ecommerce
GET
/ecommerce/orders/search
Tìm đơn theo số, email hoặc điện thoại trong các tích hợp gốc đã kết nối.
Ecommerce
POST
/contacts
Tạo hoặc cập nhật liên hệ sử dụng số điện thoại làm khóa chính.
Contacts
GET
/conversations
Danh sách các cuộc trò chuyện do liên hệ khởi tạo, có phân trang, cửa sổ phản hồi và trạng thái đại lý AI.
Conversations
GET
/conversations/{conversationId}/messages
Trả về lịch sử tin nhắn theo phân trang của một cuộc trò chuyện.
Conversations
PATCH
/contacts/{contactId}/custom-fields
Cập nhật trường tùy chỉnh cho mục tiêu và ngữ cảnh vận hành.
Fields
POST
/messages/send
Gửi tin nhắn văn bản trong cửa sổ hỗ trợ 24 giờ của WhatsApp.
Messaging
POST
/handoffs
Yêu cầu hỗ trợ từ con người bằng cách sử dụng cấu hình hiện tại của công ty.
Handoff
GET
/tickets
Danh sách phiếu hỗ trợ do con người xử lý với bộ lọc và phân trang.
Tickets
POST
/tickets/{ticketId}/close
Đóng ticket, phát sinh sự kiện tương ứng và kích hoạt lại đại lý AI của cuộc trò chuyện.
Tickets
PATCH
/conversations/{conversationId}/ai-agent
Kích hoạt hoặc tạm dừng tác vụ AI chỉ cho cuộc trò chuyện được chỉ định.
Conversations
GET
/ai-agent/prompt
Kiểm tra prompt có thể chỉnh sửa được sử dụng làm hướng dẫn cơ bản cho đại lý AI.
AI Agent
PATCH
/ai-agent/prompt
Cập nhật prompt có thể chỉnh sửa với kiểm soát phiên bản để tránh ghi đè đồng thời.
AI Agent
Hợp đồng kỹ thuật
Tài liệu bao gồm API, bộ kết nối bên ngoài và webhooks.
Các hợp đồng phân tách các cuộc gọi gửi đến Whatsplaid, các truy vấn do đại lý thực hiện trong hệ thống bên ngoài và các sự kiện được Whatsplaid gửi đi.
Kiểm tra tài khoản và quyền năng, quản lý liên hệ, thẻ và trường tùy chỉnh, theo dõi cuộc trò chuyện và gửi tin nhắn trong khung thời gian cho phép.
Xem và cập nhật prompt có thể chỉnh sửa, đồng thời bật hoặc tạm dừng agent riêng cho từng cuộc trò chuyện.
Truy cập lịch sử, phân trang, cửa sổ trả lời WhatsApp và trạng thái hiện tại của tác nhân AI.
Hệ thống của bạn có thể cung cấp các truy vấn về sản phẩm, đơn hàng, khách hàng và tính khả dụng để đại lý sử dụng trong cuộc trò chuyện.
Các sự kiện có sẵn: `lead.created`, `message.received`, `message.sent`, `message.status.updated`, `ticket.created`, `ticket.closed` và `conversation.ai_agent.updated`.
Webhooks sử dụng `delivery_id` để loại trùng và thử lại khi có lỗi tạm thời. Việc gửi được coi là hoàn tất chỉ sau khi nhận phản hồi HTTP 2xx.
Bạn có cần triển khai hoặc xác thực một tích hợp không?
Mở tài liệu tương tác để chuyển đổi giữa `Whatsplaid Public API`, `Custom Data Connector Contract` và `Outgoing Webhooks`.