Ana içeriğe geç

Sohbetler ve Mesajlar

ChatHub konuşma meta verilerini almaya, durumları yönetmeye ve geçmiş mesaj zincirlerini incelemeye yönelik API yöntemleri.

URL: https://chatapi.smsbat.com


1. Tüm Sohbetleri Alın

Dinamik filtreleme ve sayfalandırma ile sohbetlerin bir listesini getirin.

Talep - Yöntem: AL - URL: /api/chat/chats - Yetkilendirme: 'Hamiliye Jetonu' (Gerekli)

Sorgu Parametreleri

Parametre Tür Açıklama
'sayfa' 'tamsayı' Sayfa numarası. Varsayılan: 1
sayfa başına 'tamsayı' Sayfa başına öğeler. Varsayılan: 20
'arama' 'dize' Metin araması (ör. ad, telefon)
'kaynak' 'tamsayı' Sohbet Kaynağı Numaralandırması (örneğin, Viber Bot için "1", Telegram için "2")
'tarih' 'tarihsaat' İki tarih arasındaki sohbetleri getirir (URL'de iki özdeş parametre anahtarı gerektirir). Örn: ?tarih=2026-01-28&tarih=2026-01-29
tg_user_id 'tamsayı' Telegram Kullanıcı Kimliği
'telefon' 'dize' Telefon Numarası
'durum' 'tamsayı' 0 = Yeni, 1 = Açık, 2 = Bekleniyor, 3 = Duraklatmada, 4 = Kapalı
'kuruluş kimliği' 'tamsayı' Kuruluşa göre daralt
'operatörKimliği' 'tamsayı' Atanan operatöre göre daralt

Yanıt (200 Tamam)

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


2. Sohbet Durumunu Değiştirin

Belirli bir sohbet oturumunun atanan durumunu günceller.

Talep - Yöntem: PUT - URL: /api/chat/status - Yetkilendirme: 'Hamiliye Jetonu' - Başlıklar: İçerik Türü: application/json

Gövde:

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

Durum Sayısı Değerleri: - 0: Yeni (Yeni oluşturulan) - 1: Açık (Operatör tarafından aktif olarak gerçekleştirilir) - 2: Bekleniyor (Kullanıcı yanıtı bekleniyor) - 3: Duraklatmada (Duraklatılmış durum) - 4: Kapalı (Arşivlendi)


3. Sohbeti Sil

Benzersiz kimliği aracılığıyla bir sohbeti kalıcı olarak siler.

Talep - Yöntem: SİL - URL: /api/chat/chats/{id} - Yetkilendirme: 'Hamiliye Jetonu'

Yanıt (200 Tamam) Başarılı silme işlemini onaylamak için bir HTTP 200 döndürür. Gövde genellikle boştur veya kesinlikle "Tamam"dır.


4. Sohbet Mesajlarını Alın

Belirli bir sohbette geçmişte gönderilen ve alınan tüm mesajların dökümünü alır.

Talep - Yöntem: AL - URL: /api/chat/chats/{chatId}/messages - Yetkilendirme: 'Hamiliye Jetonu'

Yanıt (200 Tamam)

[
  {
        "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
  }
]
Yazarlar: - 0: Operatör - '1': İstemci - 2: Sistem Botu - 3: Viber İşletme Hesabı

Mesaj Türleri: - 0: Metin - 1: Fotoğraf - '2': Dosya


5. Mesaj Durumunu Güncelleyin

Etkin bir sohbet içindeki bir mesajı (veya birden fazla mesajı) yeni teslimat durumlarıyla işaretler.

Talep - Yöntem: PUT - URL: /api/chat/messages/status - Yetkilendirme: 'Hamiliye Jetonu' - Başlıklar: İçerik Türü: application/json

Gövde:

{
  "status": 3,
  "messageIds": [1, 2, 3]
}
(Durum '3', gönderilen mesaj kimliklerini "Okundu" olarak işaretler)