צ'אטים והודעות

שיטות API לאחזרת מטא נתונים של שיחות ChatHub, ניהול סטטוסים ובדיקת שרשראות הודעות היסטוריות.

כתובת אתר: https://chatapi.smsbat.com

1. קבל את כל הצ'אטים

אחזר רשימה של צ'אטים עם סינון דינמי ועימוד.

בקשה - שיטה: קבל - URL: /api/chat/chats - הרשאה: 'אסימון נושא' (חובה)

פרמטרי שאילתה

פרמטר	הקלד	תיאור
`עמוד`	`מספר שלם`	מספר עמוד. ברירת מחדל: `1`
`לעמוד`	`מספר שלם`	פריטים לכל עמוד. ברירת מחדל: `20`
`חיפוש`	`מחרוזת`	חיפוש טקסט (למשל, שם, טלפון)
`מקור`	`מספר שלם`	Enum מקור צ'אט (למשל '1' עבור Viber Bot, '2' עבור טלגרם)
`תאריך`	`תאריך שעה`	מביא צ'אטים בין שני תאריכים (דורש שני מפתחות פרמטרים זהים בכתובת האתר). לדוגמה: `?date=2026-01-28&date=2026-01-29`
`tg_user_id`	`מספר שלם`	מזהה משתמש בטלגרם
`טלפון`	`מחרוזת`	מספר טלפון
`סטטוס`	`מספר שלם`	`0` = חדש, `1` = פתוח, `2` = ממתין, `3` = OnPause, `4` = סגור
`organizationId`	`מספר שלם`	צמצם לפי ארגון
`operatorId`	`מספר שלם`	צמצם לפי אופרטור שהוקצה

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

{
  "total": 124,
  "items": [
    {
       "id": 123,
       "theme": "Support Ticket #491",
       "operator": {
           "id": 21,
           "name": "Jane",
           "photo": "url_to_photo.png"
       },
       "chatStatus": 1,
       "countUnread": 3
    }
  ]
}

2. שנה סטטוס צ'אט

מעדכן את הסטטוס שהוקצה של הפעלת צ'אט ספציפית.

בקשה - שיטה: PUT - URL: /api/chat/status - הרשאה: 'אסימון נושא' - כותרות: תוכן-סוג: אפליקציה/json

גוף:

{
  "id": 123,
  "status": 1
}

ערכי מצבים: - 0: חדש (נוצר לאחרונה) - 1: פתוח (מטופל באופן פעיל על ידי המפעיל) - 2: ממתין (ממתין לתשובת משתמש) - 3: OnPause (מצב מושהה) - 4: סגור (ארכיון)

3. מחק צ'אט

מוחק לצמיתות צ'אט באמצעות המזהה הייחודי שלו.

בקשה - שיטה: מחק - URL: /api/chat/chats/{id} - הרשאה: 'אסימון נושא'

תגובה (200 בסדר) מחזירה HTTP 200 כדי לאשר מחיקה מוצלחת. הגוף בדרך כלל ריק או "בסדר" בהחלט.

4. אחזר הודעות צ'אט

שומט את כל ההודעות שנשלחו והתקבלו בעבר בצ'אט מסוים.

בקשה - שיטה: קבל - URL: /api/chat/chats/{chatId}/messages - הרשאה: 'אסימון נושא'

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

[
  {
        "id": 1,
        "chatId": 123,
        "message": "Hello, how can I help?",
        "phone": "380936670003",
        "author": 0,
        "status": 3,
        "date": "2025-04-01T09:46:24.687Z",
        "operator": {
          "id": 21,
          "name": "Jane"
        },
        "messageType": 0
  }
]

מחברים: - 0: מפעיל - 1: לקוח - 2: בוט מערכת - 3: חשבון Viber Business

סוגי הודעות: - 0: טקסט - 1: תמונה - 2: קובץ

5. עדכן סטטוס הודעות

מסמן הודעה (או מספר הודעות) בתוך צ'אט פעיל עם סטטוסי מסירה חדשים.

בקשה - שיטה: PUT - URL: /api/chat/messages/status - הרשאה: 'אסימון נושא' - כותרות: תוכן-סוג: אפליקציה/json

גוף:

{
  "status": 3,
  "messageIds": [1, 2, 3]
}

(סטטוס 3 מסמן את מזהי ההודעה שנשלחה כ"נקרא")