Chat e messaggi

Metodi API per recuperare i metadati delle conversazioni di ChatHub, gestire gli stati e rivedere le catene di messaggi storiche.

URL: "https://chatapi.smsbat.com".

1. Ottieni tutte le chat

Recupera un elenco di chat con filtraggio dinamico e impaginazione.

Richiesta - Metodo: OTTIENI - URL: /api/chat/chats - Autorizzazione: Bearer Token (richiesto)

Parametri della query

Parametro	Digitare	Descrizione
`pagina`	`intero`	Numero di pagina. Impostazione predefinita: "1"
`per_pagina`	`intero`	Articoli per pagina. Impostazione predefinita: "20"
"cerca"	`stringa`	Ricerca testuale (ad es. nome, telefono)
"fonte"	`intero`	Enumerazione sorgente chat (ad esempio "1" per Viber Bot, "2" per Telegram)
`data`	`dataora`	Recupera le chat tra due date (richiede due chiavi di parametro identiche nell'URL). Esempio: `?data=2026-01-28&data=2026-01-29`
`tg_user_id`	`intero`	ID utente Telegram
"telefono"	`stringa`	Numero di telefono
`stato`	`intero`	`0` = Nuovo, `1` = Aperto, `2` = In attesa, `3` = In pausa, `4` = Chiuso
`IDorganizzazione`	`intero`	Restringi per organizzazione
`IDoperatore`	`intero`	Restringi per operatore assegnato

Risposta (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. Modifica lo stato della chat

Aggiorna lo stato assegnato di una sessione di chat specifica.

Richiesta - Metodo: PUT - URL: /api/chat/status - Autorizzazione: "Token portatore". - Intestazioni: Content-Type: application/json

Corpo:

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

Valori enumerazione stato: - 0: Nuovo (appena generato) - "1": Aperto (gestito attivamente dall'operatore) - "2": In attesa (In attesa della risposta dell'utente) - "3": OnPause (stato in pausa) - 4: Chiuso (Archiviato)

3. Elimina una chat

Elimina permanentemente una chat tramite il suo ID univoco.

Richiesta - Metodo: ELIMINA - URL: /api/chat/chats/{id} - Autorizzazione: "Token portatore".

Risposta (200 OK) Restituisce un HTTP 200 per confermare l'avvenuta eliminazione. Il corpo è in genere vuoto o rigorosamente "OK".

4. Recupera i messaggi di chat

Scarica tutti i messaggi storicamente inviati e ricevuti all'interno di una particolare chat.

Richiesta - Metodo: OTTIENI - URL: /api/chat/chats/{chatId}/messages - Autorizzazione: "Token portatore".

Risposta (200 OK) CODICE_BLOCCO_2 Autori: - "0": Operatore - "1": Cliente - "2": Bot di sistema - "3": Conto aziendale Viber

Tipi di messaggio: - "0": testo - "1": Foto - "2": File

5. Aggiorna lo stato dei messaggi

Contrassegna un messaggio (o più messaggi) all'interno di una chat attiva con nuovi stati di consegna.

Richiesta - Metodo: PUT - URL: /api/chat/messaggi/stato - Autorizzazione: "Token portatore". - Intestazioni: Content-Type: application/json

Corpo:

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

(Lo stato 3 contrassegna gli ID dei messaggi inviati come "Letti")