API Documentation

התחילו לשלוח הודעות תוך דקות

ה־API של Phone Agent מאפשר לשלוח הודעות SMS מכל אתר, אפליקציה או מערכת עסקית באמצעות מספר שורות קוד בלבד. העמוד כולל דוגמאות מוכנות ל־curl, Python ו־Node.js, לצד דוגמאות לשילוב בשרתים, אוטומציות ו־AI Agents.

curl Python Node.js שרתים ואוטומציות AI Agents

SMS גלובלי

  • לא דורש טלפון מחובר
  • שליחה דרך הענן
  • נתמך כרגע לארה"ב וקנדה (+1)
  • החיוב מתבצע מהארנק

SMS מקומי

  • משתמש בטלפון המחובר שלכם
  • משתמש בחבילת הסלולר הקיימת
  • דורש את אפליקציית Phone Agent

לפני שמתחילים

כדי להשתמש ב־API יש ליצור API Key מתוך האזור האישי. יש להעביר את המפתח בכל בקשה באמצעות כותרת Authorization.

Authentication

כך נראית כותרת האימות בכל בקשה:

Authorization: Bearer YOUR_API_KEY

בחרו את מסלול השליחה

  • SMS מקומי לשליחת הודעות דרך הטלפון המחובר שלכם.
  • SMS גלובלי לשליחת הודעות דרך שירות הענן של Phone Agent.
  • בחרו את המסלול שמתאים לכם והתחילו מהדוגמה הראשונה.

מסלולי השליחה

Phone Agent תומך בשני מסלולי שליחה.

SMS מקומי

שליחת הודעות דרך הטלפון המחובר שלכם

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

  • רוצים להשתמש במספר הטלפון שלכם.
  • רוצים לנצל את חבילת הסלולר הקיימת.
  • הטלפון מחובר ל־Phone Agent.
SMS גלובלי

שליחת הודעות דרך שירות הענן של Phone Agent

מתאים לשליחה למספרים בארצות הברית ובקנדה (+1), ללא צורך בטלפון מחובר.

  • אין טלפון מחובר.
  • שולחים לארצות הברית או לקנדה.
  • רוצים שליחה ישירות מהשרת.
  • החיוב מתבצע מתוך הארנק.

שליחת SMS מקומי

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

Endpoint POST /v1/sms
Authentication Authorization: Bearer YOUR_API_KEY
Payload { "to": "+972500000000", "text": "שלום" }

דוגמאות קוד

curl
curl -X POST "https://api.phoneagent.co.il/v1/sms" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+972500000000",
    "text": "שלום, ההזמנה שלך אושרה."
  }'
Pythonrequests
import requests

url = "https://api.phoneagent.co.il/v1/sms"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "to": "+972500000000",
    "text": "שלום, ההזמנה שלך אושרה.",
}

response = requests.post(url, headers=headers, json=payload, timeout=10)
response.raise_for_status()
print(response.json())
Node.jsfetch
const response = await fetch("https://api.phoneagent.co.il/v1/sms", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    to: "+972500000000",
    text: "שלום, ההזמנה שלך אושרה.",
  }),
});

console.log(await response.json());

Response

{
  "id": "msg_8f3c12",
  "status": "queued",
  "to": "+972500000000"
}

שליחת SMS גלובלי

שליחת הודעות דרך שירות הענן של Phone Agent. מתאים לשליחה למספרים בארצות הברית ובקנדה (+1), ללא צורך בטלפון מחובר.

Endpoint POST /api/v1/messages
Channel sms_global
Base URL https://phoneagent.co.il/api/sender

דוגמאות קוד

curl
curl -X POST "https://phoneagent.co.il/api/sender/api/v1/messages" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "channel": "sms_global",
    "to": "+14155550123",
    "text": "Hello David, your appointment is confirmed."
  }'
Pythonrequests
import requests

url = "https://phoneagent.co.il/api/sender/api/v1/messages"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "channel": "sms_global",
    "to": "+14155550123",
    "text": "Hello David, your appointment is confirmed.",
}

response = requests.post(url, headers=headers, json=payload, timeout=10)
response.raise_for_status()
print(response.json())
Node.jsfetch
const response = await fetch("https://phoneagent.co.il/api/sender/api/v1/messages", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    channel: "sms_global",
    to: "+14155550123",
    text: "Hello David, your appointment is confirmed.",
  }),
});

console.log(await response.json());

אוטומציה ו־AI Agents

ניתן להשתמש באותו API מתוך backend, webhooks, cron jobs, Docker, Kubernetes, AI Agents, מערכות CRM ומערכות ERP.

איך זה משתלב בפועל

Backend Cron Jobs Webhooks AI Agents ERP CRM Docker Kubernetes

ה־Agent יכול לבחור את ערוץ השליחה המתאים, לבצע בדיקות עסקיות לפני השליחה ולשלב יכולות נוספות של Phone Agent, כגון אנשי קשר, היסטוריית הודעות וניהול ערוצים.

השלב הבא

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