בקשות לשמות אלפא

נתיבי API ליצירה ולרשימה של שמות אלפא (שמות עסקים מאומתים המשמשים כשולח הודעות).

1. צור שם אלפא של הארגון

בקשת POST זו משמשת ליצירת שם אלפא חדש המשויך לארגון. הבקשה דורשת מפתח הרשאת ארגון בכותרות.

בקשה - כתובת אתר: https://restapi.smsbat.com/organizations/alpha_name - שיטה: פוסט - כותרות: - קבל: application/json - X-Authorization-Key: {organization_token} (נוצר בקטע פרופיל משתמש).

גוף:

{
  "name": "testName",
  "companyCode": "88888888"
}

פרמטרי גוף: 1. שם (מחרוזת): שם האלפא המוצע. - דרישה: האורך צריך להיות פחות מ-12 תווים. 2. companyCode (מחרוזת): קוד רישום החברה המשויך ל-Alphaname (ERPOU/IPN עבור אוקראינה).

תגובות אפשריות: - 200 בסדר: שם אלפא נשלח בהצלחה לניהול/יצירה. - 400 בקשה שגויה: שגיאת אימות (למשל, השם ארוך מדי). - 401 לא מורשה: 'X-Authorization-Key' לא חוקי או חסר.

---

2. אחזר רשימת שמות אלפא

מאחזר רשימה עדכנית של שמות אלפא, כולל מצבי הניהול הנוכחיים שלהם.

בקשה - כתובת אתר: https://restapi.smsbat.com/organizations/alpha_name/list - שיטה: קבל - כותרות: - X-Authorization-Key: {organization_token}

תגובה (200 בסדר):

[
    {
        "name": "test1",
        "status": "Pending Approval",
        "statusCode": "PA",
        "statusUpdateDate": "2024-07-24T16:34:40.137432Z"
    },
    {
        "name": "test2",
        "status": "Approved",
        "statusCode": "A",
        "statusUpdateDate": "2024-07-24T15:46:50.494443Z"
    }
]

סטטוסי שם אלפא (statusCode): - PA - ממתין לאישור - A - אושר - D - נדחה