לדלג לתוכן

הרשאת מפעיל וקישורים עמוקים

מדריך זה מסביר כיצד להשיג אסימון הרשאה תקף למפעילים במערכת באמצעות API וכיצד להשתמש בקישורים עמוקים כדי לנווט ללוח הצ'אט.

כתובת אתר בסיס API: https://chatapi.smsbat.com/ Swagger: https://chatapi.smsbat.com/index.html

הערה: אתה יכול להשתמש בכותרת 'X-Authorization-Key' עם האסימון שלך (זמין בפרופיל שלך בלוח המחוונים) במקום הרשאת 'Bearer' עבור בקשות ברמת החברה.

1. השג אסימון חברה

כדי לקבל את אסימון החברה, שלח בקשת HTTP POST אל /api/company/get-token המכילה את אישורי הכניסה של החברה.

בקשה - שיטה: פוסט - כתובת אתר: https://chatapi.smsbat.com/api/company/get-token - כותרות: תוכן-סוג: אפליקציה/json

גוף: 

{
  "login": "string",
  "password": "string"
}

תגובה - קוד סטטוס: 200 (בסדר) - גוף: אסימון מחרוזת ("מחרוזת_האסימון_שלך"`)

הערה: שמור את האסימון שהתקבל לבקשות עוקבות.

2. אחזר את רשימת הארגונים

שלח בקשת GET אל /api/company/organization באמצעות אסימון החברה כדי לרשום את הארגונים שלך.

בקשה - שיטה: קבל - כתובת אתר: https://chatapi.smsbat.com/api/company/organization - כותרות: - הרשאה: נושאת {אסימון} - קבל: טקסט/פשוט

תגובה - קוד סטטוס: 200 (בסדר) - גוף: 

[
  {
    "id": 6,
    "name": "string"
  }
]

3. אחזר מפעילים לפי ארגון

שלח בקשת GET אל /api/operator באמצעות הפרמטר organizationId.

בקשה - שיטה: קבל - URL: https://chatapi.smsbat.com/api/operator?organizationId={id} - כותרות: - הרשאה: נושאת {אסימון} - קבל: טקסט/פשוט

תגובה - קוד סטטוס: 200 (בסדר) - גוף: 

[
  {
    "id": 21,
    "name": "string",
    "status": 1,
    "organization": {
      "id": 24,
      "name": "test_costs"
    }
  }
]

4. הוסף אופרטורים למערכת

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

בקשה - שיטה: פוסט - URL: https://chatapi.smsbat.com/api/operator/synchronize - כותרות: - הרשאה: נושאת {אסימון} - סוג תוכן: application/json

גוף: 

[
  {
    "organizationId": 24,
    "name": "string"
  }
]

תגובה - קוד סטטוס: 200 (בסדר) - גוף: 

[
  {
    "id": 21,
    "status": 0,
    "name": "string"
  }
]

סטטוסי מפעיל אפשריים: - פעיל: 0 - לא פעיל: 1 - נמחק: 2

5. השג אסימון מפעיל

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

בקשה - שיטה: פוסט - כתובת אתר: https://chatapi.smsbat.com/api/operator/get-token - כותרות: - הרשאה: נושאת {אסימון} - סוג תוכן: application/json

גוף: 

{
  "id": 0,
  "expiresAt": "2025-01-20T14:33:34.147Z"
}
expiresAt נדרש וקובע את משך הפגישה של המפעיל (מקסימום +24 שעות).

תגובה - קוד סטטוס: 200 (בסדר) - גוף: אסימון מחרוזת

6. אמת את אסימון המפעיל

ודא את תקפות האסימון של מפעיל.

בקשה - שיטה: פוסט - כתובת אתר: https://chatapi.smsbat.com/api/operator/validate-token - כותרות: - הרשאה: נושאת {אסימון} - סוג תוכן: application/json

גוף: "operator_token_string"

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

{
  "isValid": true,
  "operatorId": 0,
  "clientId": 0,
  "expiresAt": "2024-12-28T14:04:15.861Z",
  "error": null
}

7. קישור עמוק ללוח צ'אט מפעיל

מערכות חיצוניות (CRM, ERP, אתרי אינטרנט פנימיים) יכולות לפתוח ישירות את פאנל הצ'אט תוך שימוש בקישורים העמוקים על ידי העברת ה-JWT Operator token כפרמטר. אם האסימון לא חוקי או שפג תוקפו, המשתמש יופנה לממשק הכניסה.

פורמט 1: לפי מזהה צ'אט

https://chat.smsbat.com/?chat_raw_id=<chat_id>&token=<jwt_token>

פורמט 2: לפי מספר טלפון

https://chat.smsbat.com/?phone=<phone_number>&token=<jwt_token>
מספר הטלפון חייב להיות בפורמט בינלאומי E.164.

פורמט 3: לפי שם אלפא וטלפון

https://chat.smsbat.com/?from=<bm_id>&phone=<phone_number>&token=<jwt_token>

פורמט 4: השלם את פרטי היעד

ציין בדיוק מאיזה מקור ליירט הודעות: 

https://chat.smsbat.com/?source=<sourceId>&from=<bm_id>&phone=<phone_number>&token=<jwt_token>
מקורות צ'אט: - 0 - Viber - 1 - ViberBot - 2 - TelegramBot - 3 - וואטסאפ - 4 - יישומון - 5 - רוזטקה - 6 - פייסבוק - 7 - אינסטגרם