API v2 (בטא)
הסרה מדיוור
מספר שהוסר מדיוור שייך לאדם שלא רוצה לקבל הודעות מסביבת העבודה שלכם. למספר שהוסר מדיוור אף פעם לא נשלח כלום: הודעה חדשה אליו נדחית, והודעות שנכנסו לתור קודם לכן נכשלות עם השגיאה Opted out במקום לצאת. זה עובד בכל דרכי השליחה: ה-API (v1 ו-v2), לוח הבקרה, קמפיינים, תבניות הודעה, תזכורות, Google Sheets ו-Shopify.
הרשימה זהה ללשונית הוסרו מדיוור בדף אנשי קשר בלוח הבקרה.
| פעולה | Endpoint | הרשאה |
|---|---|---|
| הסרת מספר מדיוור | POST /api/v2/opt-outs | contacts |
| רשימת ההסרות | GET /api/v2/opt-outs | contacts |
| קבלת הסרה | GET /api/v2/opt-outs/{phone} | contacts |
| החזרת מספר לדיוור | DELETE /api/v2/opt-outs/{phone} | contacts |
תשובות STOP נוספות בשבילכם#
כשמישהו משיב לאחד ממספרי תיבת ההודעות שלכם בהודעה שהיא רק מילת הסרה, הוא מוסר מדיוור מעצמו, עם source reply וההודעה שלו כ-keyword. הודעה שהיא רק START (או Subscribe) מחזירה אותו לדיוור.
- המילים, באותיות גדולות או קטנות ועם או בלי סימני פיסוק:
STOP, Stop all, Unsubscribe, Opt out, Baja, Parar, Sair, Stopp, Abmelden, Arrêt, Désabonner, Basta, Disiscrivi, Стоп, Отписаться, Berhenti, Dur, توقف, إلغاء الاشتراك, עצור, הסר. - רק הודעה שהיא המילה לבדה נחשבת: "בבקשה תפסיקו לשלוח לי את המחירון" לא מסירה אף אחד.
- צריך שתיבת ההודעות תהיה פעילה במספר שאליו הם משיבים, כי רק מספרים עם תיבת הודעות קוראים הודעות נכנסות. תשובות ישנות מ-7 ימים, כמו אלה שנקראות כשמוסיפים מספר לתיבת ההודעות, לא נחשבות.
- שום דבר לא נשלח אליהם בחזרה, ואף תשובה אוטומטית לא עונה ל-STOP.
הסרת מספר מדיוור#
https://wbiztool.com/api/v2/opt-outsגוף הבקשה: JSON (application/json)
גוף הבקשה
phonestringחובההמספר בפורמט בינלאומי עם
+(+919876543210). רווחים, מקפים וסוגריים לא נלקחים בחשבון. גם@usernameשל Telegram עובד.notestringאופציונליהסיבה, בשביל הצוות שלכם, עד 200 תווים. מוצגת בלשונית הוסרו מדיוור.
curl -X POST https://wbiztool.com/api/v2/opt-outs \
-H "Authorization: Bearer $WBIZTOOL_API_KEY" \
-H "Content-Type: application/json" \
-d '{"phone": "+919876543210", "note": "Asked by email"}'import os
import requests
r = requests.post("https://wbiztool.com/api/v2/opt-outs", timeout=30,
headers={"Authorization": f"Bearer {os.environ['WBIZTOOL_API_KEY']}"},
json={"phone": "+919876543210", "note": "Asked by email"})
print(r.status_code, r.json())// Node.js 18+ (built-in fetch). Save as .mjs to use top-level await.
const r = await fetch("https://wbiztool.com/api/v2/opt-outs", {
method: "POST",
headers: { Authorization: `Bearer ${process.env.WBIZTOOL_API_KEY}`, "Content-Type": "application/json" },
body: JSON.stringify({ phone: "+919876543210", note: "Asked by email" }),
});
console.log(r.status, await r.json());<?php
$ch = curl_init('https://wbiztool.com/api/v2/opt-outs');
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('WBIZTOOL_API_KEY'), 'Content-Type: application/json'],
CURLOPT_POSTFIELDS => json_encode(['phone' => '+919876543210', 'note' => 'Asked by email']),
CURLOPT_RETURNTRANSFER => true,
]);
echo curl_exec($ch);
curl_close($ch);תגובה: 201 עם ההסרה. מספר שכבר הוסר מדיוור מחזיר 200 עם הרשומה הקיימת שלו, ללא שינוי.
{
"recipient": "+919876543210",
"source": "api",
"keyword": null,
"note": "Asked by email",
"created_at": "2026-10-26T09:12:03.120Z"
}
שגיאות#
| HTTP | קוד | מתי |
|---|---|---|
400 | validation_failed | note אינו טקסט או ארוך מ-200 תווים |
422 | invalid_phone | phone חסר או אינו מספר טלפון |
רשימת ההסרות#
https://wbiztool.com/api/v2/opt-outsכל מי שהוסר מדיוור, מהחדש לישן, בדפים (limit מ-1 עד 100, ברירת המחדל 25, ו-cursor). הוסיפו phone כדי לחפש מספר אחד.
curl "https://wbiztool.com/api/v2/opt-outs?limit=100" \
-H "Authorization: Bearer $WBIZTOOL_API_KEY"
{
"data": [
{ "recipient": "+919876543210", "source": "reply", "keyword": "STOP", "note": null, "created_at": "2026-10-26T09:12:03.120Z" }
],
"next_cursor": null
}
קבלת הסרה#
https://wbiztool.com/api/v2/opt-outs/{phone}המספר בכתובת בפורמט בינלאומי בלי + (919876543210). מחזיר 404 opt_out_not_found כשהמספר לא הוסר מדיוור, כך שזו בדיקה מהירה לפני שליחה.
curl https://wbiztool.com/api/v2/opt-outs/919876543210 \
-H "Authorization: Bearer $WBIZTOOL_API_KEY"
החזרת מספר לדיוור#
https://wbiztool.com/api/v2/opt-outs/{phone}מעכשיו הודעות למספר יוצאות שוב. הודעות שכבר נכשלו כ-Opted out נשארות נכשלות. עשו את זה רק כשהאדם ביקש לקבל שוב את ההודעות שלכם.
curl -X DELETE https://wbiztool.com/api/v2/opt-outs/919876543210 \
-H "Authorization: Bearer $WBIZTOOL_API_KEY"
{ "recipient": "+919876543210", "deleted": true }
מספר שלא הוסר מדיוור מחזיר 404 opt_out_not_found.
שליחה למספר שהוסר מדיוור#
-
POST /messagesמחזיר422recipient_opted_out, ושום דבר לא נכנס לתור. בשליחה מרובה, כל השליחה נדחית וה-fieldשל השגיאה מציין את הרשומה. - הודעה שנכנסה לתור לפני שהאדם הוסר מדיוור נכשלת עם
errorOpted outכשמגיע תורה, ו-Webhook מקבלmessage.failed. - ה-API v1 מכניס את ההודעה לתור והיא נכשלת עם
Opted out, כפי שתראו בסטטוס הודעה. - ניסיון חוזר להודעות שנכשלו בקמפיינים מדלג על ההודעות האלה.
האובייקט Opt-out#
| שדה | סוג | תיאור |
|---|---|---|
recipient | string | + והמספר, או @username של Telegram |
source | string | reply: השיבו STOP למספר עם תיבת הודעות. dashboard: נוסף בדף אנשי קשר. import: מקובץ CSV בדף אנשי קשר. api: ה-API הזה |
keyword | string or null | התשובה שהסירה אותם, כפי שכתבו אותה |
note | string or null | ההערה של הצוות שלכם |
created_at | string | מתי הם הוסרו מדיוור (ISO 8601, UTC) |
