מדריך למפתח — Gambot API
ה-API הרשמי של Gambot לשליחת הודעות, ניהול תבניות, אנשי קשר, לידים ועוד.
אימות
https://api.gambot.co.il/api/v1Fallback: https://gambot.azurewebsites.net/api/v1
כל בקשה מאומתת באמצעות ה-Gambot Token של הארגון (מתחיל ב-gmbt_). זהו אותו טוקן שמשמש גם ל-Webhooks. שולחים אותו באחת משלוש הדרכים:
- כותרת
Authorization: Bearer gmbt_...(מומלץ) - כותרת
X-Api-Key: gmbt_... - פרמטר ב-URL
?api_key=gmbt_...(רק כשאין ברירה, למשל Zapier)
את הטוקן מוצאים בפאנל הניהול תחת הגדרות → כללי. ה-API דלוק כברירת מחדל — אין צורך בהגדרה נוספת.
מבנה התשובה
כל התשובות מוחזרות במעטפת אחידה:
{
"success": true,
"message": "…",
"data": { }
}שגיאות
| HTTP | error | תיאור |
|---|---|---|
| 401 | missing_api_key / invalid_api_key | טוקן חסר או שגוי |
| 403 | api_disabled | ה-API כבוי לארגון זה |
| 403 | insufficient_scope | לטוקן אין הרשאה לפעולה |
| 400 | missing_fields | שדות חובה חסרים בבקשה |
| 404 | not_found | המשאב לא נמצא |
| 502 | send_failed | השליחה נכשלה (בעיה מול WhatsApp) |
הודעות WhatsApp
שליחת הודעות טקסט חופשי ותבניות ללקוחות.
/messages/send-textהרשאה: messages:sendשליחת הודעת טקסט חופשי. פעיל רק בתוך חלון 24 השעות (מאז ההודעה האחרונה של הלקוח); מחוצה לו יש לשלוח תבנית.
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
to | string | body | כן | מספר הנמען בפורמט בינלאומי (9725...). אפשר גם phoneNumber. |
text | string | body | כן | תוכן ההודעה. |
{
"to": "972501234567",
"text": "שלום! תודה שפנית אלינו 😊"
}curl -X POST "https://api.gambot.co.il/api/v1/messages/send-text" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "to": "972501234567", "text": "Hello!" }'{
"success": true,
"message": "Message sent",
"data": { "messageId": "wamid.HBg…" }
}/messages/send-templateהרשאה: messages:sendשליחת תבנית מאושרת עם משתנים. אפשר לפתוח שיחה חדשה גם מחוץ לחלון 24 השעות.
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
to | string | body | כן | מספר הנמען. אפשר גם phoneNumber. |
templateId | string | body | כן | מזהה התבנית. |
variables | string[] | body | לא | משתני ה-Body לפי סדר. לחלופין templateVariableQuery. |
{
"to": "972501234567",
"templateId": "welcome_new_customer_0626",
"variables": ["דנה", "הזמנה #1234"]
}curl -X POST "https://api.gambot.co.il/api/v1/messages/send-template" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "to": "972501234567", "templateId": "welcome_0626", "variables": ["Dana"] }'{
"success": true,
"message": "Template sent",
"data": { "messageId": "wamid.HBg…" }
}שיחות
רשימת שיחות והיסטוריית הודעות.
/conversationsהרשאה: conversations:readרשימת שיחות (אנשי קשר) לפי ההודעה האחרונה.
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
pageNumber | int | query | לא | ברירת מחדל 1. |
pageSize | int | query | לא | ברירת מחדל 50 (מקסימום 200). |
search | string | query | לא | חיפוש חופשי. |
curl "https://api.gambot.co.il/api/v1/conversations?pageSize=50&search=דנה" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN"{
"success": true,
"data": {
"pageNumber": 1,
"pageSize": 50,
"count": 2,
"items": [ { "phoneNumber": "972501234567", "name": "דנה", "lastMessage": "…" } ]
}
}/conversations/{phone}/messagesהרשאה: conversations:readהיסטוריית הודעות של שיחה בודדת (עמודים לפי מזהה הודעה).
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
phone | string | path | כן | מספר הלקוח. |
pageSize | int | query | לא | ברירת מחדל 50 (מקסימום 200). |
before | string | query | לא | הבא הודעות לפני messageId זה. |
after | string | query | לא | הבא הודעות אחרי messageId זה. |
curl "https://api.gambot.co.il/api/v1/conversations/972501234567/messages?pageSize=50" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN"{
"success": true,
"data": { "messages": [ { "id": "…", "text": "…", "direction": "in", "time": "…" } ] }
}תבניות
ניהול תבניות WhatsApp — רשימה, פרטים, משתנים ויצירה. יצירת תבניות תומכת ב-Header טקסט או מדיה (תמונה/וידאו/מסמך), Body עם משתנים {{1}}, Footer וכפתורים (Quick Reply / URL / טלפון). ראו דוגמאות מלאות למטה.
/templatesהרשאה: templates:readכל התבניות של הארגון.
curl "https://api.gambot.co.il/api/v1/templates" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN"{
"success": true,
"data": [ { "id": "…", "name": "welcome_0626", "language": "he", "status": "APPROVED" } ]
}/templates/{templateId}הרשאה: templates:readתבנית בודדת כולל סטטוס האישור של Meta.
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
templateId | string | path | כן | מזהה התבנית. |
curl "https://api.gambot.co.il/api/v1/templates/welcome_0626" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN"{
"success": true,
"data": { "id": "…", "name": "welcome_0626", "status": "APPROVED", "components": [ … ] }
}/templates/{templateId}/variablesהרשאה: templates:readהמשתנים הדינמיים של התבנית.
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
templateId | string | path | כן | מזהה התבנית. |
curl "https://api.gambot.co.il/api/v1/templates/welcome_0626/variables" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN"{
"success": true,
"data": [ { "key": "dynamic_var1", "label": "שם" } ]
}/templatesהרשאה: templates:writeיצירת תבנית חדשה (נשלחת ל-Meta לאישור). תומך ב-Header טקסט/מדיה, Body עם משתנים, Footer וכפתורים. שמות חייבים להיות באנגלית, lowercase_with_underscores.
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
name | string | body | כן | שם התבנית (אנגלית, קו תחתון). |
language | string | body | כן | קוד שפה, למשל he / en. |
category | string | body | כן | MARKETING / UTILITY / AUTHENTICATION. |
components | object[] | body | כן | רכיבי התבנית: HEADER (TEXT או IMAGE/VIDEO/DOCUMENT), BODY, FOOTER, BUTTONS. ראו דוגמאות למטה. |
headerMediaUrl | string | body | לא | קיצור: כתובת URL ציבורית של מדיה. Gambot יעלה אותה ל-Meta ויזריק את ה-header_handle לרכיב ה-HEADER אוטומטית. |
headerFormat | string | body | לא | פורמט ל-headerMediaUrl: IMAGE / VIDEO / DOCUMENT (ברירת מחדל IMAGE). |
gmbtMediaId | string | body | לא | מזהה מדיה של Gambot (לתצוגה מקדימה). לרוב מיותר כשמשתמשים ב-headerMediaUrl. |
{
"name": "order_confirmation_0626",
"language": "he",
"category": "UTILITY",
"components": [
{ "type": "HEADER", "format": "TEXT", "text": "הזמנה {{1}}", "example": { "header_text": ["1234"] } },
{ "type": "BODY", "text": "שלום {{1}}, ההזמנה {{2}} התקבלה בהצלחה!", "example": { "body_text": [["דנה", "1234"]] } },
{ "type": "FOOTER", "text": "Gambot • שירות לקוחות" },
{ "type": "BUTTONS", "buttons": [
{ "type": "QUICK_REPLY", "text": "מעקב הזמנה" },
{ "type": "URL", "text": "צפייה באתר", "url": "https://shop.co.il/orders/{{1}}", "example": ["1234"] },
{ "type": "PHONE_NUMBER", "text": "התקשרו אלינו", "phone_number": "+972500000000" }
] }
]
}curl -X POST "https://api.gambot.co.il/api/v1/templates" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "name": "order_confirmation_0626", "language": "he", "category": "UTILITY", "components": [ { "type": "BODY", "text": "…{{1}}" } ] }'{
"success": true,
"message": "Template created",
"data": { "id": "…", "status": "PENDING" }
}curl -X POST "https://api.gambot.co.il/api/v1/templates" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "welcome_new_customer_0626",
"language": "he",
"category": "MARKETING",
"components": [
{ "type": "BODY", "text": "שלום {{1}}! תודה שנרשמת 🙌", "example": { "body_text": [["דנה"]] } }
]
}'curl -X POST "https://api.gambot.co.il/api/v1/templates" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "appointment_reminder_0626",
"language": "he",
"category": "UTILITY",
"components": [
{ "type": "HEADER", "format": "TEXT", "text": "תזכורת לתור" },
{ "type": "BODY", "text": "היי {{1}}, יש לך תור ב-{{2}}.", "example": { "body_text": [["דנה", "10:00"]] } },
{ "type": "FOOTER", "text": "ניתן לבטל עד 24 שעות מראש" }
]
}'curl -X POST "https://api.gambot.co.il/api/v1/templates" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "promo_summer_sale_0626",
"language": "he",
"category": "MARKETING",
"headerMediaUrl": "https://cdn.example.com/summer.jpg",
"headerFormat": "IMAGE",
"components": [
{ "type": "BODY", "text": "מבצע קיץ! עד 50% הנחה ל-{{1}} בלבד.", "example": { "body_text": [["היום"]] } },
{ "type": "FOOTER", "text": "בתוקף עד סוף החודש" },
{ "type": "BUTTONS", "buttons": [ { "type": "URL", "text": "לחנות", "url": "https://shop.co.il" } ] }
]
}'curl -X POST "https://api.gambot.co.il/api/v1/templates" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "receipt_document_0626",
"language": "he",
"category": "UTILITY",
"components": [
{ "type": "HEADER", "format": "DOCUMENT", "example": { "header_handle": ["4::aW1hZ2Uv...<handle-from-upload>"] } },
{ "type": "BODY", "text": "מצורפת חשבונית עבור הזמנה {{1}}.", "example": { "body_text": [["1234"]] } }
]
}'curl -X POST "https://api.gambot.co.il/api/v1/templates" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "product_demo_0626",
"language": "he",
"category": "MARKETING",
"headerMediaUrl": "https://cdn.example.com/demo.mp4",
"headerFormat": "VIDEO",
"components": [
{ "type": "BODY", "text": "צפו בהדגמה של {{1}} 🎬", "example": { "body_text": [["המוצר החדש"]] } }
]
}'curl -X POST "https://api.gambot.co.il/api/v1/templates" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "order_shipped_0626",
"language": "he",
"category": "UTILITY",
"components": [
{ "type": "BODY", "text": "ההזמנה {{1}} נשלחה! 📦", "example": { "body_text": [["1234"]] } },
{ "type": "BUTTONS", "buttons": [
{ "type": "QUICK_REPLY", "text": "קיבלתי, תודה" },
{ "type": "URL", "text": "מעקב משלוח", "url": "https://track.co.il/{{1}}", "example": ["1234"] },
{ "type": "PHONE_NUMBER", "text": "התקשרו אלינו", "phone_number": "+972500000000" }
] }
]
}'// MCP tool call — gambot_create_template
{
"name": "promo_summer_sale_0626",
"language": "he",
"category": "MARKETING",
"headerMediaUrl": "https://cdn.example.com/summer.jpg",
"headerFormat": "IMAGE",
"components": [
{ "type": "BODY", "text": "מבצע קיץ! עד 50% הנחה.", "example": { "body_text": [["היום"]] } },
{ "type": "FOOTER", "text": "בתוקף עד סוף החודש" },
{ "type": "BUTTONS", "buttons": [ { "type": "QUICK_REPLY", "text": "אני רוצה!" } ] }
]
}/templates/mediaהרשאה: templates:writeהעלאת מדיה (תמונה/וידאו/מסמך) מכתובת URL ציבורית ל-Meta, וקבלת header_handle לשימוש חוזר ברכיב HEADER של תבנית.
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
url | string | body | כן | כתובת URL ציבורית של המדיה. |
type | string | body | לא | סוג MIME (למשל image/png, video/mp4, application/pdf). |
{
"url": "https://cdn.example.com/summer.jpg",
"type": "image/jpeg"
}curl -X POST "https://api.gambot.co.il/api/v1/templates/media" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "url": "https://cdn.example.com/summer.jpg", "type": "image/jpeg" }'{
"success": true,
"message": "Media uploaded",
"data": {
"headerHandle": "4::aW1hZ2Uv...",
"gmbtMediaId": "…",
"mediaId": "…",
"mediaUrl": "https://cdn.example.com/summer.jpg"
}
}// MCP tool call — gambot_upload_template_media
{ "url": "https://cdn.example.com/summer.jpg", "type": "image/jpeg" }
// → returns { headerHandle } to place in a HEADER component's example.header_handleאנשי קשר
יצירה, שליפה ועדכון של אנשי קשר.
/contactsהרשאה: contacts:writeיצירת איש קשר (אם קיים — מוחזר הקיים).
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
phoneNumber | string | body | כן | מספר הטלפון. אפשר גם to. |
name | string | body | לא | שם. |
email | string | body | לא | אימייל. |
keys | string[] | body | לא | תגיות/רשימות (ברירת מחדל Leads). |
{
"phoneNumber": "972501234567",
"name": "דנה לוי",
"email": "dana@example.com",
"keys": ["Leads", "VIP"]
}curl -X POST "https://api.gambot.co.il/api/v1/contacts" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "phoneNumber": "972501234567", "name": "Dana" }'{ "success": true, "message": "Contact created", "data": { "id": "…" } }/contacts/{phone}הרשאה: contacts:readשליפת איש קשר לפי מספר טלפון.
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
phone | string | path | כן | מספר הטלפון. |
curl "https://api.gambot.co.il/api/v1/contacts/972501234567" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN"{ "success": true, "data": { "phoneNumber": "972501234567", "name": "דנה לוי" } }/contacts/{phone}הרשאה: contacts:writeעדכון איש קשר — רק השדות שנשלחו. אפשר גם POST.
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
phone | string | path | כן | מספר הטלפון. |
name | string | body | לא | שם. |
email | string | body | לא | אימייל. |
keys | string[] | body | לא | תגיות/רשימות. |
{ "name": "דנה כהן", "keys": ["Customers"] }curl -X PATCH "https://api.gambot.co.il/api/v1/contacts/972501234567" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "name": "Dana Cohen" }'{ "success": true, "message": "Contact updated" }לידים
יצירה, שליפה, רשימה ועדכון של לידים.
/leadsהרשאה: leads:readרשימת לידים (עם עימוד וחיפוש).
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
pageNumber | int | query | לא | ברירת מחדל 1. |
pageSize | int | query | לא | ברירת מחדל 50 (מקס׳ 200). |
search | string | query | לא | חיפוש חופשי. |
curl "https://api.gambot.co.il/api/v1/leads?pageSize=50" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN"{ "success": true, "data": { "total": 12, "count": 12, "items": [ { "id": "…", "title": "…" } ] } }/leads/{leadId}הרשאה: leads:readשליפת ליד בודד לפי מזהה.
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
leadId | string | path | כן | מזהה הליד. |
curl "https://api.gambot.co.il/api/v1/leads/LEAD_ID" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN"{ "success": true, "data": { "id": "LEAD_ID", "title": "…", "status": "…" } }/leadsהרשאה: leads:writeיצירת ליד (איש קשר נוצר אם חסר, ואפשר לשלוח תבנית).
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
lead | object | body | כן | אובייקט הליד: PhoneNumber, Name, Email, keys. |
templateMessageData | object | body | לא | תבנית לשליחה מיידית לליד. |
{
"lead": { "PhoneNumber": "972501234567", "Name": "דנה", "Email": "dana@example.com", "keys": ["Leads"] }
}curl -X POST "https://api.gambot.co.il/api/v1/leads" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "lead": { "PhoneNumber": "972501234567", "Name": "Dana" } }'{ "success": true, "message": "Lead created successfully." }/leads/{leadId}הרשאה: leads:writeעדכון ליד — רק השדות שנשלחו. אפשר גם POST.
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
leadId | string | path | כן | מזהה הליד. |
status | string | body | לא | סטטוס. |
stageId | string | body | לא | שלב בפייפליין. |
value | string | body | לא | ערך העסקה. |
tags | string[] | body | לא | תגיות. |
{ "status": "in_progress", "value": "1500" }curl -X PATCH "https://api.gambot.co.il/api/v1/leads/LEAD_ID" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "status": "in_progress" }'{ "success": true, "message": "Lead updated" }פניות
יצירה, שליפה, רשימה ועדכון של פניות (Tickets).
/casesהרשאה: cases:readרשימת פניות (עם עימוד וחיפוש).
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
pageNumber | int | query | לא | ברירת מחדל 1. |
pageSize | int | query | לא | ברירת מחדל 50 (מקס׳ 200). |
search | string | query | לא | חיפוש חופשי. |
curl "https://api.gambot.co.il/api/v1/cases?pageSize=50" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN"{ "success": true, "data": { "total": 5, "count": 5, "items": [ { "id": "…", "subject": "…" } ] } }/cases/{caseId}הרשאה: cases:readשליפת פנייה בודדת לפי מזהה.
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
caseId | string | path | כן | מזהה הפנייה. |
curl "https://api.gambot.co.il/api/v1/cases/CASE_ID" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN"{ "success": true, "data": { "id": "CASE_ID", "subject": "…", "statusId": "…" } }/casesהרשאה: cases:writeיצירת פנייה חדשה.
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
subject | string | body | כן | נושא הפנייה. |
description | string | body | לא | תיאור. |
contactPhone | string | body | לא | קישור לאיש קשר. |
priority | string | body | לא | עדיפות. |
{ "subject": "בעיה בהזמנה", "contactPhone": "972501234567", "priority": "high" }curl -X POST "https://api.gambot.co.il/api/v1/cases" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "subject": "Order issue", "contactPhone": "972501234567" }'{ "success": true, "message": "Case created", "data": { "id": "…" } }/cases/{caseId}הרשאה: cases:writeעדכון פנייה — רק השדות שנשלחו. אפשר גם POST.
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
caseId | string | path | כן | מזהה הפנייה. |
statusId | string | body | לא | סטטוס. |
priority | string | body | לא | עדיפות. |
{ "statusId": "closed" }curl -X PATCH "https://api.gambot.co.il/api/v1/cases/CASE_ID" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "statusId": "closed" }'{ "success": true, "message": "Case updated" }משימות
יצירה, רשימה, שליפה ועדכון של משימות (עם קישור אופציונלי לאיש קשר).
/tasksהרשאה: tasks:readרשימת המשימות של הארגון.
curl "https://api.gambot.co.il/api/v1/tasks" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN"{ "success": true, "data": { "count": 3, "items": [ { "id": "…", "title": "…" } ] } }/tasks/{taskId}הרשאה: tasks:readשליפת משימה בודדת לפי מזהה.
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
taskId | string | path | כן | מזהה המשימה. |
curl "https://api.gambot.co.il/api/v1/tasks/TASK_ID" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN"{ "success": true, "data": { "id": "TASK_ID", "title": "…", "status": "open" } }/tasks/{taskId}הרשאה: tasks:writeעדכון משימה — רק השדות שנשלחו. אפשר גם POST.
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
taskId | string | path | כן | מזהה המשימה. |
status | string | body | לא | סטטוס (open/done…). |
priority | string | body | לא | עדיפות. |
dueDate | string | body | לא | תאריך יעד. |
{ "status": "done" }curl -X PATCH "https://api.gambot.co.il/api/v1/tasks/TASK_ID" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "status": "done" }'{ "success": true, "message": "Task updated" }/tasksהרשאה: tasks:writeיצירת משימה חדשה.
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
title | string | body | כן | כותרת המשימה. |
description | string | body | לא | תיאור. |
dueDate | string | body | לא | תאריך יעד. |
priority | string | body | לא | עדיפות (low/medium/high). |
contactPhone | string | body | לא | קישור לאיש קשר. |
{ "title": "לחזור לדנה", "dueDate": "2026-09-20", "priority": "high", "contactPhone": "972501234567" }curl -X POST "https://api.gambot.co.il/api/v1/tasks" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "title": "Call Dana", "priority": "high" }'{ "success": true, "message": "Task created", "data": { "id": "…" } }קמפיינים
הרצת קמפיין קיים לפי מזהה.
/campaigns/{campaignId}/runהרשאה: campaigns:runהרצת קמפיין קיים (פותר נמענים ומריץ).
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
campaignId | string | path | כן | מזהה הקמפיין. |
curl -X POST "https://api.gambot.co.il/api/v1/campaigns/CAMPAIGN_ID/run" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN"{
"success": true,
"message": "Campaign run started.",
"data": { "campaignResultsId": "…", "status": "In Progress" }
}הצעות מחיר
יצירה, רשימה, שליפה ועדכון של הצעות מחיר.
/quotesהרשאה: quotes:readרשימת הצעות מחיר (עימוד + סינון סטטוס).
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
pageNumber | int | query | לא | ברירת מחדל 1. |
pageSize | int | query | לא | ברירת מחדל 50. |
search | string | query | לא | חיפוש. |
status | string | query | לא | draft/sent/accepted… |
curl "https://api.gambot.co.il/api/v1/quotes?pageSize=50" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN"{ "success": true, "data": { "total": 8, "items": [ { "id": "…", "quoteNumber": "Q-001", "total": 1500 } ] } }/quotes/{quoteId}הרשאה: quotes:readשליפת הצעת מחיר בודדת.
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
quoteId | string | path | כן | מזהה ההצעה. |
curl "https://api.gambot.co.il/api/v1/quotes/QUOTE_ID" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN"{ "success": true, "data": { "id": "QUOTE_ID", "items": [ … ], "total": 1500 } }/quotesהרשאה: quotes:writeיצירת הצעת מחיר. גוף הבקשה = שדות ההצעה (או תחת quoteData).
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
title | string | body | לא | כותרת. |
contactPhone | string | body | לא | טלפון הלקוח. |
items | object[] | body | לא | שורות ההצעה. |
total | number | body | לא | סה"כ. |
currency | string | body | לא | מטבע. |
{
"title": "הצעה לשירותי ייעוץ",
"contactPhone": "972501234567",
"currency": "ILS",
"items": [ { "name": "ייעוץ", "quantity": 2, "price": 750 } ],
"total": 1500
}curl -X POST "https://api.gambot.co.il/api/v1/quotes" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "title": "Consulting", "total": 1500 }'{ "success": true, "message": "Quote created", "data": { "id": "…" } }/quotes/{quoteId}הרשאה: quotes:writeעדכון שדות הצעה (partial). אפשר גם POST.
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
quoteId | string | path | כן | מזהה ההצעה. |
status | string | body | לא | סטטוס. |
{ "status": "sent" }curl -X PATCH "https://api.gambot.co.il/api/v1/quotes/QUOTE_ID" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "status": "sent" }'{ "success": true, "message": "Quote updated" }חשבוניות
יצירה, רשימה, שליפה, עדכון והפקה (issue) של חשבוניות.
/invoicesהרשאה: invoices:readרשימת חשבוניות (עימוד + סינון סטטוס/סוג).
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
pageNumber | int | query | לא | ברירת מחדל 1. |
pageSize | int | query | לא | ברירת מחדל 50. |
status | string | query | לא | draft/issued… |
type | string | query | לא | tax_invoice/receipt… |
curl "https://api.gambot.co.il/api/v1/invoices?pageSize=50" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN"{ "success": true, "data": { "total": 20, "items": [ { "id": "…", "documentNumber": "…", "total": 1755 } ] } }/invoices/{invoiceId}הרשאה: invoices:readשליפת חשבונית בודדת.
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
invoiceId | string | path | כן | מזהה החשבונית. |
curl "https://api.gambot.co.il/api/v1/invoices/INVOICE_ID" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN"{ "success": true, "data": { "id": "INVOICE_ID", "status": "draft", "total": 1755 } }/invoicesהרשאה: invoices:writeיצירת טיוטת חשבונית. גוף = שדות החשבונית (או תחת invoiceData).
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
type | string | body | לא | tax_invoice / receipt / combined… |
contactPhone | string | body | לא | טלפון הלקוח. |
items | object[] | body | לא | שורות. |
total | number | body | לא | סה"כ. |
{
"type": "tax_invoice",
"contactPhone": "972501234567",
"items": [ { "name": "מוצר", "quantity": 1, "price": 1500 } ],
"vatRate": 17,
"total": 1755
}curl -X POST "https://api.gambot.co.il/api/v1/invoices" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "type": "tax_invoice", "total": 1755 }'{ "success": true, "message": "Invoice created", "data": { "id": "…" } }/invoices/{invoiceId}הרשאה: invoices:writeעדכון חשבונית (חסום אחרי הפקה/נעילה). אפשר גם POST.
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
invoiceId | string | path | כן | מזהה החשבונית. |
{ "notes": "תודה!" }curl -X PATCH "https://api.gambot.co.il/api/v1/invoices/INVOICE_ID" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "notes": "Thanks!" }'{ "success": true, "message": "Invoice updated" }/invoices/{invoiceId}/issueהרשאה: invoices:writeהפקת חשבונית — נעילה והקצאת מספר מסמך רשמי.
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
invoiceId | string | path | כן | מזהה החשבונית. |
curl -X POST "https://api.gambot.co.il/api/v1/invoices/INVOICE_ID/issue" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN"{ "success": true, "message": "Invoice issued", "data": { "documentNumber": "2026-0001" } }הזמנות
יצירה, רשימה, שליפה ועדכון של הזמנות חנות.
/ordersהרשאה: orders:readרשימת הזמנות (סינון סטטוס/חנות/טווח תאריכים).
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
status | string | query | לא | סטטוס. |
storeId | string | query | לא | מזהה חנות. |
dateFrom | string | query | לא | מתאריך. |
dateTo | string | query | לא | עד תאריך. |
curl "https://api.gambot.co.il/api/v1/orders?status=new" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN"{ "success": true, "data": { "count": 4, "items": [ { "id": "…", "orderNumber": "1001", "total": 299 } ] } }/orders/{orderId}הרשאה: orders:readשליפת הזמנה בודדת.
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
orderId | string | path | כן | מזהה ההזמנה. |
curl "https://api.gambot.co.il/api/v1/orders/ORDER_ID" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN"{ "success": true, "data": { "id": "ORDER_ID", "status": "new", "items": [ … ] } }/ordersהרשאה: orders:writeיצירת הזמנה. גוף = שדות ההזמנה.
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
customerName | string | body | לא | שם הלקוח. |
customerPhone | string | body | לא | טלפון הלקוח. |
items | object[] | body | לא | פריטים. |
total | number | body | לא | סה"כ. |
{
"customerName": "דנה",
"customerPhone": "972501234567",
"items": [ { "name": "חולצה", "quantity": 2, "price": 99 } ],
"total": 198,
"status": "new"
}curl -X POST "https://api.gambot.co.il/api/v1/orders" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "customerPhone": "972501234567", "total": 198 }'{ "success": true, "message": "Order created", "data": { "orderId": "…" } }/orders/{orderId}הרשאה: orders:writeעדכון הזמנה (merge). אפשר גם POST.
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
orderId | string | path | כן | מזהה ההזמנה. |
{ "status": "shipped", "trackingNumber": "IL123" }curl -X PATCH "https://api.gambot.co.il/api/v1/orders/ORDER_ID" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "status": "shipped" }'{ "success": true, "message": "Order updated" }חתימה דיגיטלית
קריאה בלבד — מסמכי חתימה ותוצאות החתימה. יצירה נעשית בממשק גמבוט.
/signaturesהרשאה: signatures:readרשימת מסמכי חתימה (מהחדש לישן).
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
limit | int | query | לא | ברירת מחדל 100. |
curl "https://api.gambot.co.il/api/v1/signatures?limit=100" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN"{ "success": true, "data": { "count": 12, "items": [ { "id": "…", "documentName": "…", "status": "…" } ] } }/signatures/{documentId}הרשאה: signatures:readמסמך חתימה בודד כולל תוצאות החתימה (Signatures).
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
documentId | string | path | כן | מזהה המסמך. |
curl "https://api.gambot.co.il/api/v1/signatures/DOC_ID" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN"{ "success": true, "data": { "id": "DOC_ID", "Signatures": [ { "signerName": "…", "signedAt": "…" } ] } }טפסי ווב
קריאה בלבד — הגדרות טפסים ותוצאות (submissions). יצירת טפסים נעשית בממשק גמבוט.
/formsהרשאה: forms:readרשימת טפסי ווב.
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
limit | int | query | לא | ברירת מחדל 200. |
curl "https://api.gambot.co.il/api/v1/forms" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN"{ "success": true, "data": { "count": 3, "items": [ { "id": "…", "title": "צור קשר" } ] } }/forms/{formId}הרשאה: forms:readהגדרת טופס בודד.
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
formId | string | path | כן | מזהה הטופס. |
curl "https://api.gambot.co.il/api/v1/forms/FORM_ID" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN"{ "success": true, "data": { "id": "FORM_ID", "title": "…", "fields": [ … ] } }/forms/{formId}/submissionsהרשאה: forms:readתוצאות (submissions) של טופס.
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
formId | string | path | כן | מזהה הטופס. |
limit | int | query | לא | ברירת מחדל 500. |
curl "https://api.gambot.co.il/api/v1/forms/FORM_ID/submissions" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN"{ "success": true, "data": { "count": 40, "items": [ { "id": "…", "data": { … } } ] } }תבניות מסמכים
קריאה בלבד — תבניות מסמכים ותוצאות מילוי (submissions).
/documentsהרשאה: documents:readרשימת תבניות מסמכים.
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
limit | int | query | לא | ברירת מחדל 200. |
curl "https://api.gambot.co.il/api/v1/documents" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN"{ "success": true, "data": { "count": 5, "items": [ { "id": "…", "name": "הסכם" } ] } }/documents/{templateId}הרשאה: documents:readתבנית מסמך בודדת.
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
templateId | string | path | כן | מזהה התבנית. |
curl "https://api.gambot.co.il/api/v1/documents/TEMPLATE_ID" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN"{ "success": true, "data": { "id": "TEMPLATE_ID", "name": "…" } }/documents/{templateId}/submissionsהרשאה: documents:readתוצאות מילוי שנוצרו מהתבנית (fill-only).
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
templateId | string | path | כן | מזהה התבנית. |
limit | int | query | לא | ברירת מחדל 500. |
curl "https://api.gambot.co.il/api/v1/documents/TEMPLATE_ID/submissions" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN"{ "success": true, "data": { "count": 7, "items": [ { "id": "…", "Signatures": [ … ] } ] } }משתמשים
ניהול משתמשי הארגון (חברי צוות) — הוספה, רשימה, שליפה, עדכון והשבתה.
/usersהרשאה: users:readרשימת משתמשי הארגון (ללא בוטים מערכתיים).
curl "https://api.gambot.co.il/api/v1/users" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN"{ "success": true, "data": { "count": 4, "items": [ { "uID": "…", "FullName": "…", "SecurityRole": "Admin" } ] } }/users/{userId}הרשאה: users:readשליפת משתמש בודד.
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
userId | string | path | כן | מזהה המשתמש. |
curl "https://api.gambot.co.il/api/v1/users/USER_ID" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN"{ "success": true, "data": { "uID": "USER_ID", "FullName": "…", "Status": "active" } }/usersהרשאה: users:writeיצירת/הזמנת משתמש — מקים חשבון ושולח מייל + וואטסאפ.
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
email | string | body | כן | כתובת אימייל. |
fullName | string | body | לא | שם מלא (או firstName+lastName). |
phoneNumber | string | body | לא | טלפון. |
securityRole | string | body | לא | Admin/StoreManager/StoreAgent/Chat/Basic/Custom. |
language | string | body | לא | שפה. |
{
"email": "agent@example.com",
"fullName": "יוסי נציג",
"phoneNumber": "972501234567",
"securityRole": "StoreAgent"
}curl -X POST "https://api.gambot.co.il/api/v1/users" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "email": "agent@example.com", "fullName": "Agent" }'{ "success": true, "message": "User created", "data": { "email": "agent@example.com" } }/users/{userId}הרשאה: users:writeעדכון משתמש — רק השדות שנשלחו. אפשר גם POST.
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
userId | string | path | כן | מזהה המשתמש. |
securityRole | string | body | לא | תפקיד אבטחה. |
status | string | body | לא | active/inactive. |
{ "securityRole": "StoreManager" }curl -X PATCH "https://api.gambot.co.il/api/v1/users/USER_ID" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "securityRole": "StoreManager" }'{ "success": true, "message": "User updated" }/users/{userId}/disableהרשאה: users:writeהשבתת משתמש (status=inactive).
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
userId | string | path | כן | מזהה המשתמש. |
curl -X POST "https://api.gambot.co.il/api/v1/users/USER_ID/disable" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN"{ "success": true, "message": "User inactive" }/users/{userId}/enableהרשאה: users:writeהפעלת משתמש (status=active).
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
userId | string | path | כן | מזהה המשתמש. |
curl -X POST "https://api.gambot.co.il/api/v1/users/USER_ID/enable" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN"{ "success": true, "message": "User active" }/users/{userId}הרשאה: users:writeמחיקת משתמש לצמיתות (חשבון + פרופיל).
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
userId | string | path | כן | מזהה המשתמש. |
curl -X DELETE "https://api.gambot.co.il/api/v1/users/USER_ID" \
-H "Authorization: Bearer gmbt_YOUR_TOKEN"{ "success": true, "message": "User deleted" }הרשאות (Scopes)
ברירת המחדל: הטוקן מורשה לכל הפעולות. אפשר לצמצם הרשאות בהגדרות.
| הרשאה | תיאור |
|---|---|
messages:send | שליחת הודעות ותבניות |
conversations:read | קריאת שיחות והודעות |
templates:read | קריאת תבניות |
templates:write | יצירת תבניות |
contacts:read | קריאת אנשי קשר |
contacts:write | יצירה/עדכון אנשי קשר |
leads:read | קריאת לידים |
leads:write | יצירה/עדכון לידים |
cases:read | קריאת פניות |
cases:write | יצירה/עדכון פניות |
tasks:read | קריאת משימות |
tasks:write | יצירה/עדכון משימות |
quotes:read | קריאת הצעות מחיר |
quotes:write | יצירה/עדכון הצעות מחיר |
invoices:read | קריאת חשבוניות |
invoices:write | יצירה/עדכון/הפקת חשבוניות |
orders:read | קריאת הזמנות |
orders:write | יצירה/עדכון הזמנות |
signatures:read | קריאת מסמכי חתימה |
forms:read | קריאת טפסים ותוצאות |
documents:read | קריאת תבניות מסמכים ותוצאות |
users:read | קריאת משתמשים |
users:write | יצירה/עדכון/מחיקת משתמשים |
campaigns:run | הרצת קמפיינים |
העברת הודעות נכנסות (Webhook)
אפשר להגדיר ש-Gambot יעביר כל הודעה נכנסת מ-WhatsApp אל שרת משלכם — בדיוק כמו Botomation שהטריגר שלו הוא "הודעה נכנסת" ואז שולח HTTP, רק אוטומטי לכל ההודעות. הגוף מועבר AS-IS — בדיוק כפי שהתקבל ממטא.
הפעלה
בפאנל הניהול: הגדרות → כללי → העברת הודעות נכנסות (Webhook). מסמנים את הצ׳קבוקס, מזינים כתובת URL (חובה), ואופציונלית כותרת Authorization.
מה תקבלו
לכל הודעה נכנסת נשלח POST אל ה-URL שלכם עם גוף ה-JSON המקורי של מטא (WhatsApp Cloud API), והכותרות:
| Header | תיאור |
|---|---|
Authorization | הערך שהגדרתם (אם הגדרתם). |
X-Gambot-Organization | שם הארגון שלכם. |
X-Gambot-Event | תמיד inbound-webhook. |
דוגמת גוף (מבנה מטא, מקוצר):
{
"object": "whatsapp_business_account",
"entry": [{
"id": "<WABA_ID>",
"changes": [{
"field": "messages",
"value": {
"metadata": { "display_phone_number": "9725...", "phone_number_id": "..." },
"contacts": [{ "profile": { "name": "דנה" }, "wa_id": "972501234567" }],
"messages": [{
"from": "972501234567",
"id": "wamid.HBg...",
"timestamp": "1757600000",
"type": "text",
"text": { "body": "שלום, אשמח לפרטים" }
}]
}
}]
}]
}200 OK מהר. העיבוד אצלכם צריך להיות אסינכרוני. ההעברה היא fire-and-forget ולא חוזרת על עצמה (no retry).שרת MCP
שרת ה-Gambot MCP חושף את כל ה-API ככלים (tools) עבור סוכני AI כמו Cursor ו-Claude — שליחת הודעות, ניהול לידים, חשבוניות, משתמשים ועוד — הכל דרך שיחה טבעית. הוא עוטף את אותו api/v1 ומאומת עם ה-Gambot Token.
התקנה
git clone <gambot-mcp>
cd gmbt_mcp
npm install && npm run buildחיבור ל-Cursor / Claude Desktop
הוסיפו ל-.cursor/mcp.json (או claude_desktop_config.json):
{
"mcpServers": {
"gambot": {
"command": "node",
"args": ["/path/to/gmbt_mcp/dist/index.js"],
"env": { "GAMBOT_TOKEN": "gmbt_your_token_here" }
}
}
}gambot_send_text, gambot_create_lead, gambot_issue_invoice, gambot_create_user ועוד (40+ כלים). ליצירת תבניות עם מדיה, כפתורים ו-Footer: gambot_create_template (אפשר להעביר headerMediaUrl) ו-gambot_upload_template_media.