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