מדריכיםVoice API לשיחות יוצאות

Voice API לשיחות יוצאות

ה-API יוצר שיחה ממערכת מורשית ומחזיר אירועים ותוצאה. השתמשו בו רק למספרים ולמטרות שמותר לפנות אליהם.

כיצד ה-Voice API עובד

המערכת שלכם שולחת בקשה מאומתת עם מספר, מטרה ונתוני שיחה. ה-API מחזיר call ID, מפעיל את השיחה ומדווח תוצאה ב-webhook או ב-Call Results API.

  • יצירה
  • חיוג
  • אירועי סטטוס
  • תוצאה מובנית
  • הקלטה או תמלול לפי הגדרה

התחלה

צרו API key בסביבה המאובטחת, שמרו אותו רק בשרת ושלחו מספרים בפורמט E.164. התחילו במספר בדיקה ובהסכמה מפורשת.

curl -X POST https://api.talktomyagent.io/v1/calls \
  -H "Authorization: Bearer $TTMA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"to":"+972501234567","purpose":"אישור תור"}'

בקשת שיחה

העבירו רק את המידע הדרוש לשיחה הזאת: מספר היעד, מטרת השיחה, הודעת פתיחה אופציונלית, שפה, metadata וכתובת callback. אל תשלחו רשומות CRM מלאות.

  • to: E.164
  • purpose: מטרה ברורה
  • language: he-IL בעת הצורך
  • metadata: מזהים לא רגישים
  • idempotency key למניעת כפילות

תגובה ושגיאות

תגובה מוצלחת כוללת call ID וסטטוס התחלתי. שגיאת 4xx דורשת תיקון בקשה; 401 דורשת בדיקת מפתח; 429 דורשת backoff; 5xx מאפשר retry מבוקר עם אותו idempotency key.

  • אל תסיקו שהשיחה הושלמה מ-200
  • שמרו call ID
  • לוג ללא secrets
  • הציגו סיבת כשל תפעולית

מה אפשר לבנות

  • אישורי ותזכורות לתורים
  • שיחות המשך ללידים שביקשו חזרה
  • עדכוני שירות חשובים
  • גבייה זהירה לאחר אישור משפטי
  • התראות עם אישור קבלה

אבטחה וציות

אמתו הרשאה לכל שיחה, זהו את העסק בתחילת השיחה וכבדו שעות, הסכמה והסרה. webhook נבדק עם HMAC, timestamp והגנת replay.

  • מינימום מידע
  • רשימת suppression
  • מגבלת ניסיונות
  • retention מוגדר
  • מסלול אנושי

מסמכי API מלאים

לשדות, קודי שגיאה ו-payloads העדכניים השתמשו בתיעוד האינטראקטיבי. המדריך מסביר את התהליך ואינו מחליף את schema החי.

https://api.talktomyagent.io/v1/docs

בדיקת בטיחות

קיום endpoint אינו היתר משפטי להתקשר; בדקו הסכמה, שעות, זיהוי והסרה.