קריאות API למערכת Israel Number
תיעוד API זה מתאר כל קריאת API זמינה, את נקודת הקצה שלה, המשתנים הנדרשים והשימוש בה. כל הקריאות משתמשות בשיטת POST אלא אם צוין אחרת. יש לקבל את טוקן החשבון דרך קריאת Login לפני השימוש בכל קריאה אחרת.
ארבע קבוצות קריאות API
קפצו ישירות לקבוצת הפקודות הרלוונטית.
אימות
קריאת Login לקבלת טוקן החשבון הנדרש לכל שאר הקריאות.
חשבון
יתרה, היסטוריית חיובים וייצוא רשומות שיחה (CDR).
ניהול מספרים (DID)
חיפוש, רכישה, שחרור והגדרת העברה למספרים וירטואליים.
הגדרות SMS
יצירה, עדכון ומחיקה של הגדרות העברת הודעות SMS.
🔑 אימות
קריאת החובה הראשונה לפני שימוש בכל שאר ה-API.
מאמת את החשבון שלכם ומחזיר את הטוקן הנדרש לכל קריאות ה-API הבאות.
| משתנה | תיאור |
|---|---|
username | מספר החשבון שלכם ב-IsraelNumber |
password | סיסמת החשבון שלכם |
{
"username": "{{account_number}}",
"password": "{{password}}"
}id ו-account_token המוחזרים — הם נדרשים בכל קריאות ה-API הנוספות.💳 חשבון
יתרה, היסטוריית חיובים וייצוא נתונים.
מחזיר את היתרה הנוכחית בחשבון שלכם.
מחזיר את היסטוריית החיובים והטעינות בחשבון, כולל רכישות מספרים, חידושים, טעינות וחיובים נוספים.
| משתנה | תיאור |
|---|---|
id | מזהה החשבון המוחזר מ-Login |
token | account_token המוחזר מ-Login |
number | מספר החשבון שלכם |
{
"id": "{{id}}",
"token": "{{token}}",
"number": "{{account_number}}"
}מייצא רשומות פירוט שיחות (CDR) לטווח תאריכים נבחר.
| משתנה | תיאור |
|---|---|
id | מזהה החשבון |
token | account_token |
from_date | תאריך ושעת התחלה |
to_date | תאריך ושעת סיום |
📡 ניהול מספרים (DID)
חיפוש, רכישה, שחרור והגדרת העברה למספרים וירטואליים ב-145 מדינות.
מחזיר את כל המדינות הזמינות ומזהי המדינה שלהן. השתמשו במזהה המדינה בעת חיפוש מספרים זמינים.
מחזיר מספרים זמינים למדינה נבחרת.
| משתנה | תיאור |
|---|---|
action | list |
country_id | מזהה מדינה מ-Get Country List |
id | מזהה החשבון |
token | account_token |
רוכש ומקצה מספר (DID) לחשבון שלכם.
| משתנה | תיאור |
|---|---|
action | assign |
did_id | מזהה ה-DID מרשימת המספרים הזמינים |
accountid | מזהה החשבון שלכם |
id | מזהה החשבון שלכם |
token | account_token |
מחזיר את כל המספרים המוקצים לחשבון שלכם עם פרטים מלאים לכל מספר.
| משתנה | תיאור |
|---|---|
action | purchase_list |
משחרר מספר (DID) מהחשבון שלכם.
| משתנה | תיאור |
|---|---|
action | release |
did_id | מזהה ה-DID לשחרור |
מעדכן את יעד הניתוב/העברה עבור מספר. השתמשו בקריאה זו להגדיר לאן יועברו שיחות נכנסות.
| משתנה | תיאור |
|---|---|
call_type | סוג ההעברה |
call_type_value | ערך היעד עבור סוג ההעברה |
always | יעד העברה תמידי |
user_busy | העברה כשהקו תפוס |
user_not_registered | העברה כשהשלוחה לא רשומה |
no_answer | העברה כשאין מענה |
💬 הגדרות SMS
כל קריאות הגדרת ה-SMS משתמשות בנקודת הקצה: https://newsip.israelnumber.com/api/sms
יוצר הגדרת העברת SMS עבור מספר המאפשר SMS.
| משתנה | תיאור |
|---|---|
action | add |
did | המספר המאפשר SMS |
dest_sms | מספר יעד להעברת SMS |
dest_email | כתובת אימייל יעד להעברת SMS |
מעדכן הגדרת העברת SMS קיימת.
| משתנה | תיאור |
|---|---|
action | update |
מוחק הגדרת העברת SMS קיימת עבור מספר.
| משתנה | תיאור |
|---|---|
action | delete |
מחזיר את הגדרות העברת ה-SMS עבור מספר ספציפי.
| משתנה | תיאור |
|---|---|
action | get |
מחזיר את כל הגדרות העברת ה-SMS בחשבון.
| משתנה | תיאור |
|---|---|
action | list |
סיכום — כל קריאות ה-API
טבלת התייחסות מהירה לכל הקריאות הזמינות.
| קריאה | נקודת קצה | מטרה |
|---|---|---|
| Login | /api/login/ | אימות וקבלת טוקן חשבון |
| Get Balance | — | החזרת יתרת חשבון נוכחית |
| Charges History | /api/charges_history/get_charges_history_list/ | שליפת היסטוריית עסקאות |
| CDRs Export | /api/cdrs_export | ייצוא רשומות שיחה לפי טווח תאריכים |
| Get Country List | Country List API | רשימת כל המדינות הזמינות ומזהיהן |
| DID Available List | /customer/did_crud/ | עיון במספרים זמינים לפי מדינה |
| DID Assign | /customer/did_management/ | רכישה והקצאת מספר |
| DID Purchased List | /customer/did_crud/ | רשימת כל המספרים בחשבון |
| DID Release | /customer/did_management/ | שחרור מספר מהחשבון |
| DID Forward Setting | /customer/did_management/ | הגדרת העברת שיחות עבור מספר |
| SMS Config Add | /api/sms | יצירת הגדרת העברת SMS |
| SMS Config Update | /api/sms | עדכון הגדרת העברת SMS |
| SMS Config Delete | /api/sms | מחיקת הגדרת העברת SMS |
| Get SMS Config | /api/sms | קבלת הגדרת SMS עבור מספר ספציפי |
| SMS Config List | /api/sms | רשימת כל הגדרות ה-SMS בחשבון |
מוכנים להתחיל לפתח?
פתחו חשבון חינמי וקבלו את מפתח ה-API שלכם תוך פחות מ-2 דקות.