Sistem anda memanggil Whatsplaid untuk menyemak kebolehan, menguruskan kenalan, menjejak perbualan, menghantar mesej, mengawal ejen AI dan meminta sokongan manusia.
API awam dan dokumentasi
Sambungkan sistem anda ke Whatsplaid dengan API, penyambung dan webhook.
Gunakan API awam untuk mengintegrasi kenalan, perbualan, mesej, sokongan manusia dan ejen AI. Gunakan penyambung luaran untuk mengkuiri data dari sistem anda dan webhooks untuk menerima acara masa nyata.
Tiga kontrak
Pilih arah integrasi yang betul.
Dokumentasi Swagger memisahkan aliran untuk mengelakkan kekeliruan antara panggilan ke Whatsplaid, pertanyaan yang dibuat oleh pembantu dan acara yang dihantar ke sistem anda.
Whatsplaid memanggil sistem anda untuk menyemak produk, pesanan, pelanggan atau ketersediaan masa nyata semasa perbualan.
Kenali penyambung luaran melalui APIWhatsplaid menghantar acara lead, mesej, status penghantaran, tiket dan perubahan ejen AI ke URL yang dikonfigurasikan.
Swagger di `api.whatsplaid.com/docs/` mengandungi skema, contoh, respons yang dijangkakan dan kontrak teknikal lengkap.
Rujukan pantas untuk endpoint utama.
Paparan ini merumuskan ciri-ciri yang muncul dalam dokumentasi rasmi. Pelaksanaan akhir mesti mengikut Swagger.
GET
/store
Mengembalikan data akaun, e-dagang yang disambungkan dan modul aktif.
Account
GET
/capabilities
Menunjukkan operasi mana yang benar-benar tersedia mengikut akaun, pelan, modul dan integrasi.
Account
GET
/ecommerce/products/search
Cari produk dalam integrasi asli yang disambungkan, seperti Nuvemshop, Wix atau Shopify.
Ecommerce
GET
/ecommerce/orders/search
Cari pesanan mengikut nombor, e-mel atau telefon dalam integrasi asli yang disambungkan.
Ecommerce
POST
/contacts
Mewujudkan atau mengemas kini kenalan dengan menggunakan nombor telefon sebagai kunci utama.
Contacts
GET
/conversations
Senarai perbualan yang dimulakan oleh kenalan, dengan penomboran muka surat, tetingkap respons dan status ejen AI.
Conversations
GET
/conversations/{conversationId}/messages
Mengembalikan sejarah mesej berpaginated bagi satu perbualan.
Conversations
PATCH
/contacts/{contactId}/custom-fields
Mengemas kini medan tersuai untuk penargetan dan konteks operasi.
Fields
POST
/messages/send
Menghantar mesej teks dalam tetingkap pemesejan 24 jam WhatsApp.
Messaging
POST
/handoffs
Minta sokongan manusia menggunakan konfigurasi syarikat semasa.
Handoff
GET
/tickets
Senarai tiket sokongan manusia dengan penapis dan halaman.
Tickets
POST
/tickets/{ticketId}/close
Menutup tiket, memancarkan acara yang sepadan dan mengaktifkan semula ejen AI perbualan.
Tickets
PATCH
/conversations/{conversationId}/ai-agent
Aktifkan atau jeda ejen AI hanya untuk perbualan yang dinyatakan.
Conversations
GET
/ai-agent/prompt
Memeriksa prompt yang boleh disunting yang digunakan sebagai arahan asas ejen AI.
AI Agent
PATCH
/ai-agent/prompt
Kemas kini prompt yang boleh diedit dengan kawalan semakan untuk mengelakkan ditulis ganti serentak.
AI Agent
Kontrak teknikal
Dokumentasi merangkumi API, penyambung luaran dan webhooks.
Kontrak memisahkan panggilan yang dibuat ke Whatsplaid, pertanyaan yang dibuat oleh ejen dalam sistem luaran dan acara yang dihantar oleh Whatsplaid.
Memeriksa akaun dan keupayaan, mengurus kenalan, tag dan medan tersuai, menjejaki perbualan dan menghantar mesej dalam jendela yang dibenarkan.
Lihat dan kemas kini prompt yang boleh disunting, serta aktifkan atau jeda ejen secara berasingan dalam setiap perbualan.
Mengakses sejarah sembang, penomboran muka surat, tetingkap balasan WhatsApp dan status semasa ejen AI.
Sistem anda mungkin mendedahkan pertanyaan produk, pesanan, pelanggan dan ketersediaan untuk kegunaan agen semasa perbualan.
Peristiwa tersedia: `lead.created`, `message.received`, `message.sent`, `message.status.updated`, `ticket.created`, `ticket.closed` dan `conversation.ai_agent.updated`.
Webhooks menggunakan `delivery_id` untuk deduplikasi dan percubaan semula bagi kegagalan sementara. Penghantaran dianggap selesai hanya selepas respons HTTP 2xx.
Adakah anda perlu melaksanakan atau mengesahkan satu integrasi?
Buka dokumentasi interaktif untuk bertukar antara `Whatsplaid Public API`, `Custom Data Connector Contract` dan `Outgoing Webhooks`.