Tērzēšana un ziņas

API metodes ChatHub sarunu metadatu iegūšanai, statusu pārvaldībai un vēsturisko ziņojumu ķēžu pārskatīšanai.

URL: https://chatapi.smsbat.com

---

1. Iegūstiet visas tērzēšanas sarunas

Iegūstiet tērzēšanas sarunu sarakstu ar dinamisku filtrēšanu un lappušu šķirošanu.

Pieprasījums

• Metode: IEGŪT
• URL: /api/chat/chats
• Autorizācija: “Uzrādītāja marķieris” (obligāts)

Vaicājuma parametri

Parametrs	Tips	Apraksts
lapa	”vesels skaitlis”	Lapas numurs. Noklusējums: 1
par_lapu	”vesels skaitlis”	Vienumi vienā lapā. Noklusējums: “20”
meklēt	virkne	Teksta meklēšana (piemēram, vārds, tālrunis)
“avots"	"vesels skaitlis”	Tērzēšanas avota enum (piemēram, 1 Viber Bot, 2 Telegram)
“datums"	"datums un laiks”	Ienes tērzēšanu starp diviem datumiem (ir nepieciešamas divas identiskas parametru atslēgas URL). Piemēram: ?date=2026-01-28&date=2026-01-29
tg_user_id	”vesels skaitlis”	Telegram lietotāja ID
tālrunis	virkne	Tālruņa numurs
statuss	”vesels skaitlis”	0 = jauns, 1 = atvērts, 2 = gaida, 3 = Ieslēgts Pauze, 4 = Slēgts
organizationId	vesels skaitlis	Šaurs pēc organizācijas
operatorId	vesels skaitlis	Sašaurināt pēc piešķirtā operatora

Atbilde (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. Mainiet tērzēšanas statusu

Atjaunina noteiktas tērzēšanas sesijas piešķirto statusu.

Pieprasījums

• Metode: PUT
• URL: /api/chat/status
• Atļauja: “Beznesēja marķieris”.
• Galvenes: Satura veids: lietojumprogramma/json

Korpuss:

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

Statusa enum vērtības:

• 0: jauns (jaunģenerēts)
• 1: atvērts (aktīvi apstrādā operators)
• 2: gaida (gaida lietotāja atbildi)
• 3: OnPause (pauzēts stāvoklis)
• 4: slēgts (arhivēts)

---

3. Dzēsiet tērzēšanu

Neatgriezeniski dzēš tērzēšanu, izmantojot tās unikālo ID.

Pieprasījums

• Metode: DZĒST
• URL: `/api/chat/chats/{id}
• Atļauja: “Beznesēja marķieris”.

Atbilde (200 OK) Atgriež HTTP 200, lai apstiprinātu veiksmīgu dzēšanu. Pamatteksts parasti ir tukšs vai stingri norādīts “OK”.

---

4. Izgūt tērzēšanas ziņas

Tiek izmesti visi ziņojumi, kas vēsturiski nosūtīti un saņemti konkrētā tērzēšanas laikā.

Pieprasījums

• Metode: IEGŪT
• URL: `/api/chat/chats/{chatId}/messages
• Atļauja: “Beznesēja marķieris”.

Atbilde (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
  }
]

Autori:

• 0: operators
• 1: klients
• 2: sistēmas robots
• 3: Viber biznesa konts

Ziņojumu veidi:

• 0: teksts
• 1: Foto
• 2: fails

---

5. Atjauniniet ziņojumu statusu

Atzīmē ziņojumu (vai vairākus ziņojumus) aktīvajā tērzēšanas sarunā ar jauniem piegādes statusiem.

Pieprasījums

• Metode: PUT
• URL: /api/chat/messages/status
• Atļauja: “Beznesēja marķieris”.
• Galvenes: Satura veids: lietojumprogramma/json

Korpuss:

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

(Statuss “3” atzīmē nosūtīto ziņojumu ID kā “Izlasīts”)