Help Center ჩეთები და შეტყობინებები

ჩეთები და შეტყობინებები

API მეთოდები ChatHub საუბრის მეტამონაცემების მისაღებად, სტატუსების მართვისა და ისტორიული შეტყობინებების ჯაჭვების გადახედვისთვის.

URL: https://chatapi.smsbat.com

1. მიიღეთ ყველა ჩატი

მიიღეთ ჩეთების სია დინამიური გაფილტვრით და პაგინაციის საშუალებით.

** მოთხოვნა **

  • ** მეთოდი: ** GET
  • URL: /api/chat/chats
  • ავტორიზაცია: მიმტანის ჟეტონი (აუცილებელია)

შეკითხვის პარამეტრები

პარამეტრიტიპიაღწერა
გვერდი`მთლიანი~გვერდის ნომერი. ნაგულისხმევი: 1
თითო_გვერდზე`მთლიანი~ნივთები თითო გვერდზე. ნაგულისხმევი: 20
ძებნასტრიქონიტექსტის ძიება (მაგ. სახელი, ტელეფონი)
წყარო`მთლიანი~ჩატის წყაროს ნომერი (მაგ. 1 Viber Bot-ისთვის, 2 Telegram-ისთვის)
თარიღითარიღის დროიღებს ჩეთებს ორ თარიღს შორის (საჭიროა ორი იდენტური პარამეტრის გასაღები URL-ში). მაგ: ?თარიღი=2026-01-28&თარიღი=2026-01-29
tg_user_id`მთლიანი~Telegram-ის მომხმარებლის ID
ტელეფონისტრიქონიტელეფონის ნომერი
სტატუსს`მთლიანი~0 = ახალი, 1 = ღია, 2 = ლოდინი, 3 = პაუზა, 4 = დახურულია
ორგანიზაციის IDმთელი რიცხვივიწრო ორგანიზაციის მიხედვით
ოპერატორის IDმთელი რიცხვიშევიწროება მინიჭებული ოპერატორის მიერ

** პასუხი (200 OK) **

{
  "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
  • ავტორიზაცია: ტარების ნიშანი
  • Headers: შინაარსის ტიპი: აპლიკაცია/json

** სხეული: **

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

** სტატუსის შეყვანის მნიშვნელობები:**

  • 0: ახალი (ახალი გენერირებული)
  • 1: ღია (აქტიურად დამუშავებულია ოპერატორის მიერ)
  • 2: ლოდინი (მომხმარებლის პასუხის მოლოდინში)
  • 3: პაუზაზე (დაპაუზებული მდგომარეობა)
  • 4: დახურულია (დაარქივებულია)

3. წაშალე ჩატი

სამუდამოდ შლის ჩატს თავისი უნიკალური ID-ის მეშვეობით.

** მოთხოვნა **

  • მეთოდი: წაშლა
  • URL: /api/chat/chats/{id}
  • ავტორიზაცია: ტარების ნიშანი

** პასუხი (200 OK) ** აბრუნებს HTTP 200 წარმატებული წაშლის დასადასტურებლად. ტექსტი ჩვეულებრივ ცარიელია ან მკაცრად "OK".

4. მიიღეთ ჩატის შეტყობინებები

ათავსებს ისტორიულად გაგზავნილ და მიღებულ ყველა შეტყობინებას კონკრეტულ ჩატში.

** მოთხოვნა **

  • ** მეთოდი: ** GET
  • URL: /api/chat/chats/{chatId}/messages
  • ავტორიზაცია: ტარების ნიშანი

** პასუხი (200 OK) **

[
  {
        "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
  • ავტორიზაცია: ტარების ნიშანი
  • Headers: შინაარსის ტიპი: აპლიკაცია/json

** სხეული: **

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

(სტატუსი 3 აღნიშნავს გაგზავნილ შეტყობინების ID-ებს, როგორც “წაკითხული”)