מדריך ה-API — הפניה מלאה לקריאות

הפניה לקריאות ה-API של IsraelNumber המתועדות באוסף ה-Postman שסופק, בתוספת נקודות קצה תפעוליות שזוהו בנפרד. קריאות הפלטפורמה המתועדות משתמשות ב-HTTP POST אלא אם צוין אחרת. בצעו אימות תחילה עם Login, ולאחר מכן השתמשו בערכי החשבון שהוחזרו ובאימות ה-session שנוצר בהתאם לדרישות כל קריאה.

כתובת בסיס: https://newsip.israelnumber.com

קבלו מפתח API בחינם חזרה למדריך ה-API

אימות (Authentication)

Login

נקודת קצה: https://newsip.israelnumber.com/api/login/

לפני השימוש ב-API, הוסיפו את כתובת ה-IP של השרת השולח את הבקשות לרשימת ההיתרים בפורטל החשבון של המשתמש. לכל חשבון יש שם משתמש וסיסמה משלו. עבור בקשת ה-Login הראשונית, השתמשו בפרטים אלו יחד עם ה-x-auth-token הקבוע המפורסם בתיעוד ה-API. Login מוצלח מחזיר את ה-id של החשבון, את ה-account_token, ו-x-auth-token חדש עבור ה-session. השתמשו ב-x-auth-token של ה-session שנוצר בכותרת הבקשה עבור הקריאות הבאות באותו session ה-API, ושלחו את ה-id וה-account_token שהוחזרו בגופי בקשה כערכי ה-id וה-token המתועדים.

משתנה	תיאור
username	מספר חשבון ה-Israelnumber שלכם
password	סיסמת חשבון ה-Israelnumber שלכם

דוגמת בקשה:

POST https://newsip.israelnumber.com/api/login/
x-auth-token: YOUR_INITIAL_X_AUTH_TOKEN
Content-Type: application/json

{
  "username": "YOUR_ACCOUNT_NUMBER",
  "password": "YOUR_PASSWORD"
}

⚠️ שמרו את ה-id, ה-account_token, וה-x-auth-token של ה-session שנוצר, שהוחזרו. השתמשו ב-x-auth-token של ה-session בכותרת הקריאות הבאות ל-API, והשתמשו ב-id וב-account_token שהוחזרו בגופי בקשה כ-id ו-token.

חשבון

היסטוריית חיובים

נקודת קצה: {{URL}}/api/charges_history/get_charges_history_list/

מחזירה את היסטוריית החיובים של החשבון המאומת.

משתנה	תיאור
id	מזהה חשבון שהוחזר מ-Login
token	account_token שהוחזר מ-Login
number	מספר החשבון שלכם

דוגמת בקשה:

{
  "id": "{{id}}",
  "token": "{{token}}",
  "number": "{{account_number}}"
}

ייצוא CDRs

נקודת קצה: https://newsip.israelnumber.com/api/cdrs_export

יוצרת דוח פירוט שיחות (CDR) עבור טווח התאריכים המבוקש. לאחר בקשת ה-API, הדוח נשלח לכתובת האימייל הרשומה בחשבון. האימייל כולל קובץ ZIP מצורף המכיל את דוח ה-CDR בפורמט Excel.

משתנה	תיאור
id	מזהה חשבון
token	account_token
from_date	תאריך ושעת התחלה
to_date	תאריך ושעת סיום

ניהול מספרים (DID)

קבלת רשימת מדינות מושבת בהפניה הנוכחית

הפניית ה-API הנוכחית מסמנת קריאה זו כמושבתת, ומספקת את רשימת המדינות המלאה בדוגמה שלה. השתמשו במזהה ה-country_id המספרי מאותה הפניה בעת קריאה לרשימת המספרים הזמינים.

רשימת מספרים (DID) זמינים

נקודת קצה: {{URL}}/customer/did_crud/

מחזירה מספרים זמינים עבור מדינה נבחרת.

משתנה	תיאור
action	`available_list`
parent_id	ערך קבוע "0"
country_id	מזהה מדינה מספרי אופציונלי מהפניית רשימת המדינות
id	מזהה חשבון
token	account_token

שיוך מספר (DID)

נקודת קצה: {{URL}}/customer/did_management/

רוכשת ומשייכת מספר (DID) לחשבון שלכם.

משתנה	תיאור
action	assign
did_id	מזהה מספר (DID) מרשימת המספרים הזמינים
accountid	מזהה החשבון שלכם
reseller_id	ערך קבוע "0"
id	מזהה החשבון שלכם
token	account_token

רשימת מספרים (DID) שנרכשו

נקודת קצה: {{URL}}/customer/did_crud/

מחזירה את המספרים (DID) המשויכים כרגע לחשבון שלכם.

משתנה	תיאור
action	`purchase_list`
id	מזהה חשבון שהוחזר מ-Login
token	`account_token` שהוחזר מ-Login

שחרור מספר (DID)

נקודת קצה: {{URL}}/customer/did_management/

משחררת מספר (DID) מהחשבון שלכם.

משתנה	תיאור
action	`release`
did_id	מזהה המספר (DID) לשחרור
accountid	מזהה חשבון שהוחזר מ-Login
id	מזהה חשבון שהוחזר מ-Login
token	`account_token` שהוחזר מ-Login

הגדרת העברה למספר (DID)

נקודת קצה: {{URL}}/customer/did_management/

מעדכנת את הגדרות ניתוב/העברת השיחות עבור מספר (DID). דוגמת ה-API שסופקה מדגימה call_type=2 עם כתובת IP של טראנק ב-call_type_value. קריאה זו היא API להגדרת העברה טלפונית, ואין להתייחס אליה כ-API כללי ל-webhook של אירועי HTTP.

משתנה	תיאור
id	מזהה חשבון שהוחזר מ-Login
token	`account_token` שהוחזר מ-Login
action	`forward`
did_id	מזהה מספר (DID) מרשימת המספרים שנרכשו
call_type	הדוגמה המתועדת משתמשת בערך קבוע `2`
call_type_value	הדוגמה המתועדת משתמשת בכתובת ה-IP של הטראנק שלכם
always	הדוגמה המתועדת משתמשת בערך קבוע `5`
user_busy	הדוגמה המתועדת משתמשת בערך קבוע `5`
user_not_registered	הדוגמה המתועדת משתמשת בערך קבוע `5`
no_answer	הדוגמה המתועדת משתמשת בערך קבוע `5`
extensions	שדה חובה; הדוגמה המתועדת משתמשת בערך ריק
call_type_vm_flag	שדה חובה; הדוגמה המתועדת משתמשת בערך ריק
always_destination	שדה חובה; הדוגמה המתועדת משתמשת בערך ריק
always_vm_flag	שדה חובה; הדוגמה המתועדת משתמשת בערך ריק
user_busy_destination	שדה חובה; הדוגמה המתועדת משתמשת בערך ריק
user_busy_vm_flag	שדה חובה; הדוגמה המתועדת משתמשת בערך ריק
user_not_registered_destination	שדה חובה; הדוגמה המתועדת משתמשת בערך ריק
user_not_registered_vm_flag	שדה חובה; הדוגמה המתועדת משתמשת בערך ריק
no_answer_destination	שדה חובה; הדוגמה המתועדת משתמשת בערך ריק
no_answer_vm_flag	שדה חובה; הדוגמה המתועדת משתמשת בערך ריק

הגדרות SMS

כל קריאות הגדרות ה-SMS משתמשות בנקודת הקצה: https://newsip.israelnumber.com/api/sms

הוספת הגדרת SMS

יוצרת תצורת העברת SMS עבור מספר עם תמיכה ב-SMS. ניתן להגדיר העברה למספר SMS אחר, לכתובת אימייל, או לכתובת webhook. עבור העברה ל-webhook בלבד, ניתן להשמיט את dest_sms ואת dest_email.

משתנה	תיאור
action	`add`
id	מזהה חשבון שהוחזר מ-Login
token	`account_token` שהוחזר מ-Login
did	מספר עם תמיכה ב-SMS
dest_sms	יעד העברה ל-SMS (אופציונלי)
dest_email	יעד העברה לאימייל (אופציונלי)
webhook_url	יעד webhook מסוג HTTP (אופציונלי)

עדכון הגדרת SMS

מעדכנת תצורת העברת SMS קיימת. ניתן לנהל את הגדרות העברת ה-SMS דרך ה-API או דרך פורטל ה-HTTP של החשבון.

משתנה	תיאור
action	`update`
id	מזהה חשבון שהוחזר מ-Login
token	`account_token` שהוחזר מ-Login
did	מספר (DID) עם תמיכה ב-SMS
dest_sms	יעד העברה ל-SMS (אופציונלי)
dest_email	יעד העברה לאימייל (אופציונלי)
webhook_url	יעד webhook מסוג HTTP (אופציונלי)

מחיקת הגדרת SMS

משתנה	תיאור
action	`delete`
id	מזהה חשבון שהוחזר מ-Login
token	`account_token` שהוחזר מ-Login
did	המספר (DID) שאת תצורת העברת ה-SMS שלו יש למחוק

קבלת הגדרת SMS

משתנה	תיאור
action	`get`
id	מזהה חשבון שהוחזר מ-Login
token	`account_token` שהוחזר מ-Login
did	המספר (DID) שאת תצורת העברת ה-SMS שלו יש להחזיר

רשימת הגדרות SMS

משתנה	תיאור
action	`list`
id	מזהה חשבון שהוחזר מ-Login
token	`account_token` שהוחזר מ-Login

SMS יוצא — נקודת קצה תפעולית נפרדת

נקודת קצה זו פעילה אך אינה חלק מאוסף ה-Postman שסופק.

שליחת SMS יוצא API נפרד

נקודת קצה: https://api.israelnumber.com/astppsend-sms

שולחת SMS יוצא דרך רשת IsraelNumber. קריאה זו משתמשת ב-HTTP GET במקום בתבנית ה-POST שבה משתמשות קריאות ה-API המתועדות של Newsip.

משתנה	תיאור
username	שם המשתמש / מספר החשבון שלכם ב-IsraelNumber
password	סיסמת החשבון שלכם
destination	מספר הטלפון של היעד
callerid	ערך השולח / מזהה המתקשר המורשה לחשבון שלכם
message	תוכן הודעת ה-SMS
sms	פרמטר מצב SMS הנדרש על ידי נקודת הקצה
whatsapp	פרמטר מצב WhatsApp הנתמך על ידי נקודת הקצה

כתובת ה-IP המקורית שלכם חייבת להיות מוגדרת תחת החשבון שלי ← הגדרות IP. מכיוון שנקודת קצה זו נמצאת מחוץ לאוסף ה-Postman שסופק, יש להתייחס לדרישות הפרמטרים שלה כחוזה API תפעולי נפרד.

דוגמת כתובת URL לבקשה:

https://api.israelnumber.com/astppsend-sms
  ?username=YOUR_ACCOUNT
  &password=YOUR_PASSWORD
  &destination=DESTINATION_NUMBER
  &callerid=YOUR_CALLER_ID
  &message=Hello
  &sms=1
  &whatsapp=0

SMS נכנס ← Webhook זמין כעת

ניתן להעביר SMS נכנס לנקודת הקצה שלכם, ואת היעד ניתן להגדיר פרוגרמטית דרך POST /api/sms באמצעות webhook_url. ניתן להגדיר את אותן הגדרות העברת SMS גם דרך פורטל ה-HTTP של החשבון תחת סוג העברה ← API.

תבנית כתובת URL: https://example.com/api?from={CallerID}&text={SMS_TEXT}&to={SMS_DST_ADDR}

מציין מקום	ערך חי
{CallerID}	מספר הטלפון של השולח
{SMS_TEXT}	תוכן הודעת ה-SMS הנכנס
{SMS_DST_ADDR}	מספר היעד של IsraelNumber עם תמיכה ב-SMS

דוגמת הגדרה דרך ה-API:

POST https://newsip.israelnumber.com/api/sms
x-auth-token: YOUR_SESSION_X_AUTH_TOKEN
Content-Type: application/json

{
  "action": "add",
  "id": "YOUR_ACCOUNT_ID",
  "token": "YOUR_ACCOUNT_TOKEN",
  "did": "YOUR_SMS_ENABLED_DID",
  "webhook_url": "https://example.com/api?from={CallerID}&text={SMS_TEXT}&to={SMS_DST_ADDR}"
}

הגדרת SMS-to-webhook זמינה גם דרך ה-API וגם דרך פורטל ה-HTTP של החשבון. עבור העברה ל-webhook בלבד, ניתן להשמיט את dest_sms ואת dest_email.

הפניה מהירה — כל קריאות ה-API

קריאה	נקודת קצה	מטרה
Login	/api/login/	אימות וקבלת טוקן חשבון
היסטוריית חיובים	/api/charges_history/get_charges_history_list/	שליפת היסטוריית עסקאות
ייצוא CDRs	/api/cdrs_export	יצירת דוח CDR עבור טווח תאריכים נבחר. הדוח נמסר לכתובת האימייל הרשומה בחשבון כקובץ Excel בתוך קובץ ZIP מצורף.
קבלת רשימת מדינות	מושבתת בהפניה הנוכחית	השתמשו במזהי מדינות מספריים המסופקים בדוגמת הפניית ה-API הנוכחית
רשימת מספרים (DID) זמינים	/customer/did_crud/	עיינו במספרים זמינים לפי מדינה
שיוך מספר (DID)	/customer/did_management/	רכישה ושיוך מספר
רשימת מספרים (DID) שנרכשו	/customer/did_crud/	הצגת כל המספרים בחשבון שלכם
שחרור מספר (DID)	/customer/did_management/	שחרור מספר מהחשבון שלכם
הגדרת העברה למספר (DID)	/customer/did_management/	הגדרת העברת שיחות עבור מספר
הוספת הגדרת SMS	/api/sms	יצירת תצורת העברה ל-SMS, אימייל, או webhook
עדכון הגדרת SMS	/api/sms	עדכון תצורת העברה ל-SMS, אימייל, או webhook
מחיקת הגדרת SMS	/api/sms	מחיקת תצורת העברת SMS
קבלת הגדרת SMS	/api/sms	קבלת הגדרת SMS עבור מספר (DID) ספציפי
רשימת הגדרות SMS	/api/sms	הצגת כל הגדרות ה-SMS בחשבון
שליחת SMS יוצא	https://api.israelnumber.com/astppsend-sms	שליחת SMS יוצא דרך API נפרד מסוג HTTP GET
SMS נכנס ← Webhook	/api/sms או פורטל ה-HTTP של החשבון	הגדרת העברת SMS נכנס לנקודת קצה מסוג HTTP באמצעות `webhook_url`

מדריכי API נוספים

שילוב סוכני AI

תנו לסוכן ה-AI שלכם מספר מקומי אמיתי. למידע נוסף ←

הקצאת מספרים (DID)

חפשו, הזמינו, ושחררו מספרים דרך ה-API. למידע נוסף ←

SMS

SMS דרך API

הגדירו העברה ל-SMS/אימייל, שלחו SMS יוצא, ונתבו SMS נכנס ל-webhook. למידע נוסף ←

Webhooks ואירועים

ניתוב SMS-to-webhook נכנס והנחיות שילוב מאומתות. למידע נוסף ←

מוכנים לקרוא ל-API?

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

קבלו מפתח API בחינם חזרה למדריך ה-API