Help Center Chats u Messaġġi

Chats u Messaġġi

Metodi API biex iġibu l-metadejta tal-konversazzjoni ta’ ChatHub, jimmaniġġjaw l-istatus, u jirrevedu ktajjen ta’ messaġġi storiċi.

URL: https://chatapi.smsbat.com


1. Ikseb iċ-Chats Kollha

Iġbor lista ta’ chats b’filtrazzjoni dinamika u paġnar.

Talba

  • Metodu: IKOLLOK
  • URL: /api/chat/chats
  • Awtorizzazzjoni: ‘Bearer Token’ (Meħtieġa)

Parametri tal-Mistoqsija

ParametruTipDeskrizzjoni
paġna”numru sħiħ”Numru tal-paġna. Default: 1
per_page”numru sħiħ”Oġġetti għal kull paġna. Default: “20"
"tfittxija""sekwenza”Tfittxija bit-test (eż., isem, telefon)
“sors""numru sħiħ”Chat Sors Enum (eż. 1 għal Viber Bot, 2 għal Telegram)
“data""data-ħin”Iġbor iċ-chats bejn żewġ dati (jeħtieġ żewġ ċwievet tal-parametri identiċi fil-URL). Eż: ?data=2026-01-28&date=2026-01-29
tg_user_id”numru sħiħ”ID tal-Utent tat-Telegram
telefon”sekwenza”Numru tat-Telefon
”status""numru sħiħ”0 = Ġdid, 1 = Miftuħ, 2 = Stennija, 3 = OnPause, 4 = Magħluq
organizationIdnumru sħiħIddejjaq skond l-organizzazzjoni
”operatorId”numru sħiħIddejjaq skond l-operatur assenjat

Tweġiba (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. Ibdel l-Istatus taċ-Chat

Taġġorna l-istatus assenjat ta’ sessjoni ta’ chat speċifika.

Talba

  • Metodu: PUT
  • URL: /api/chat/status
  • Awtorizzazzjoni: ‘Bearer Token’
  • Headers: Content-Type: application/json

Korp:

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

Valuri Enum ta’ Status:

  • 0: Ġdid (Ġenerat ġdid)
  • “1”: Miftuħ (Immaniġġjat b’mod attiv mill-operatur)
  • 2: Stennija (Qed jistenna t-tweġiba tal-utent)
  • 3: OnPause (Stat ta’ waqfa pawża)
  • “4”: Magħluq (Arkivat)

3. Ħassar Chat

Permanentment iħassar chat permezz tal-ID unika tiegħu.

Talba

  • Metodu: Ħassar
  • URL: /api/chat/chats/{id}
  • Awtorizzazzjoni: ‘Bearer Token’

Tweġiba (200 OK) Jirritorna HTTP 200 biex jikkonferma t-tħassir b’suċċess. Il-korp huwa tipikament vojt jew strettament "OK".


4. Irkupra l-Messaġġi taċ-Chat

Dumps kollha messaġġi storikament mibgħuta u riċevuti fi chat partikolari.

Talba

  • Metodu: IKOLLOK
  • URL: /api/chat/chats/{chatId}/messages
  • Awtorizzazzjoni: ‘Bearer Token’

Tweġiba (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
  }
]

Awturi:

  • 0: Operatur
  • 1: Klijent
  • “2”: System Bot
  • “3”: Kont tan-Negozju Viber

Tipi ta’ messaġġi:

  • 0: Test
  • 1: Ritratt
  • 2: Fajl

5. Aġġorna l-Istatus tal-Messaġġi

Jimmarka messaġġ (jew messaġġi multipli) ġewwa chat attiv bi status ta’ kunsinna ġodda.

Talba

  • Metodu: PUT
  • URL: /api/chat/messages/status
  • Awtorizzazzjoni: ‘Bearer Token’
  • Headers: Content-Type: application/json

Korp:

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

(L-istat 3 jimmarka l-IDs tal-messaġġ mibgħut bħala “Aqra”)