API ציבורית ותיעוד

התחברו למערכות שלכם ל‑Whatsplaid באמצעות API, מחברים ו‑webhook.

השתמש ב-API הציבורי כדי לשלב אנשי קשר, שיחות, הודעות, תמיכה אנושית והסוכן ה-AI. השתמש במחבר החיצוני לשאילתת נתונים מהמערכת שלך וב-webhooks לקבלת אירועים בזמן אמת.

פתח תיעוד הצג אינטגרציות

Base URL https://api.whatsplaid.com/v1

# autenticação
Authorization: Bearer {"{api_token}"}

# validar conta, módulos e integrações
GET /capabilities

# pausar o agente de IA nesta conversa
PATCH /conversations/5511999999999/ai-agent
{
  "active": false
}

שלושה חוזים

בחר את כיוון האינטגרציה הנכון.

תיעוד Swagger מבדיל בין הזרמים כדי למנוע בלבול בין קריאות ל‑Whatsplaid, שאלות המבוצעות על‑ידי העוזר ואירועים שנשלחים למערכת שלך.

01 Public API

המערכת שלך קוראת ל‑Whatsplaid כדי לשאול יכולות, לנהל אנשי קשר, לעקוב אחרי שיחות, לשלוח הודעות, לשלוט בסוכן ה‑IA ולבקש תמיכה אנושית.

02 Custom Data Connector

Whatsplaid קורא למערכת שלך על מנת לשאול על מוצרים, הזמנות, לקוחות או זמינות בזמן אמת במהלך שיחה.

הכירו את המחבר החיצוני דרך ה‑API

03 Outgoing Webhooks

Whatsplaid שולחת אירועי לידים, הודעות, סטטוסי משלוח, פניות ושינויים בסוכן ה‑IA לכתובת URL המוגדרת.

04 תיעוד

ה-Swagger ב-`api.whatsplaid.com/docs/` מכיל את הסכמות, דוגמאות, התגובות הצפויות והחוזים הטכניים המלאים.

מדריך מהיר לנקודות הקצה העיקריות.

תצוגה זו מסכמת את התכונות שמופיעות בתיעוד הרשמי. היישום הסופי חייב לעקוב אחר Swagger.

GET /store

מחזיר נתוני חשבון, חנות אלקטרונית מחוברת ומודולים פעילים.

Account

GET /capabilities

מציג אילו פעולות זמינות בפועל בהתאם לחשבון, לתוכנית, למודולים ולשילובים.

Account

GET /ecommerce/products/search

חפש מוצרים באינטגרציות המקומיות המחוברות, כגון Nuvemshop, Wix או Shopify.

Ecommerce

GET /ecommerce/orders/search

חפש הזמנות לפי מספר, דוא"ל או טלפון באינטגרציות המקומיות המחוברות.

Ecommerce

POST /contacts

יוצר או מעדכן איש קשר באמצעות מספר הטלפון כמפתח ראשי.

Contacts

GET /conversations

רשימת שיחות שהחלו על ידי אנשי קשר, עם חלוקה לעמודים, חלון תגובה ומצב סוכן ה‑AI.

Conversations

GET /conversations/{conversationId}/messages

מחזיר את היסטוריית ההודעות המחולקת לעמודים של שיחה.

Conversations

PATCH /contacts/{contactId}/custom-fields

מעדכן שדות מותאמים אישית למטרות מיקוד והקשר תפעולי.

Fields

POST /messages/send

שולח הודעת טקست בתוך חלון התמיכה של 24 השעות של WhatsApp.

Messaging

POST /handoffs

בקש תמיכה אנושית באמצעות תצורת החברה הנוכחית.

Handoff

GET /tickets

רשימת פניות תמיכה אדם עם מסננים ודפי תוצאות.

Tickets

POST /tickets/{ticketId}/close

מסיים את הכרטיס, מפעיל את האירוע המתאים ומחדש את הפעלת סוכן ה‑AI של השיחה.

Tickets

PATCH /conversations/{conversationId}/ai-agent

הפעל או השהה את סוכן ה-AI רק עבור השיחה שצוינה.

Conversations

GET /ai-agent/prompt

בוחן את הפרומפט הניתן לעריכה המשמש כהוראת הבסיס של סוכן ה‑IA.

AI Agent

PATCH /ai-agent/prompt

עדכן את ה-prompt הניתן לעריכה עם בקרת גרסאות כדי למנוע כתיבה-חוזרת מקבילה.

AI Agent

חוזים טכניים

התיעוד מכסה את ה-API, את המחבר החיצוני ואת ה-webhooks.

החוזים מפרידים בין קריאות שנשלחות ל‑Whatsplaid, שאילתות שבסוכן מבצע במערכות חיצוניות ואירועים שנשלחים על‑ידי Whatsplaid.

API ציבורית

בודק חשבון ויכולות, מנהל אנשי קשר, תגיות ושדות מותאמים אישית, עוקב אחר שיחות ושולח הודעות במסגרת החלון המותרים.

סוכן בינה מלאכותית

עיין ועדכן את ה‑prompt שניתן לעריכה, והפעל או השה את הסוכן באופן נפרד בכל שיחה.

שיחות והודעות

ניגש להיסטוריית השיחות, לעימוד, לחלון התשובה של WhatsApp ולמצב הנוכחי של סוכן ה-IA.

מחבר חיצוני

המערכת שלך עשויה לחשוף שאילתות לגבי מוצרים, הזמנות, לקוחות וזמינות לשימוש הסוכן במהלך השיחה.

Webhookים

אירועים זמינים: `lead.created`, `message.received`, `message.sent`, `message.status.updated`, `ticket.created`, `ticket.closed` ו-`conversation.ai_agent.updated`.

אספקה אמינה

webhook‎ים משתמשים ב־`delivery_id` לדדליקציה ולניסיונות חוזרים כשיש כשל זמני. המסירה נחשבת להשלמה רק לאחר השבת HTTP 2xx.

בעזרתכם להטמיע או לאמת אינטגרציה?

פתח את התיעוד האינטראקטיבי כדי לעבור בין `Whatsplaid Public API`, `Custom Data Connector Contract` ו-`Outgoing Webhooks`.

פתח Swagger