Bate-papos e mensagens

Métodos de API para buscar metadados de conversas do ChatHub, gerenciar status e revisar cadeias históricas de mensagens.

URL: https://chatapi.smsbat.com

1. Obtenha todos os bate-papos

Obtenha uma lista de chats com filtragem dinâmica e paginação.

Solicitação - Método: OBTER - URL: /api/chat/chats - Autorização: Bearer Token (Obrigatório)

Parâmetros de consulta

Parâmetro	Tipo	Descrição
`página`	`inteiro`	Número da página. Padrão: `1`
`por_página`	`inteiro`	Itens por página. Padrão: `20`
`pesquisar`	`string`	Pesquisa de texto (por exemplo, nome, telefone)
`fonte`	`inteiro`	Enum de origem do bate-papo (por exemplo, `1` para Viber Bot, `2` para Telegram)
`data`	`datahora`	Busca bate-papos entre duas datas (requer duas chaves de parâmetro idênticas na URL). Ex: `?data=2026-01-28&date=2026-01-29`
`tg_user_id`	`inteiro`	ID de usuário do telegrama
`telefone`	`string`	Número de telefone
`estado`	`inteiro`	`0` = Novo, `1` = Aberto, `2` = Aguardando, `3` = OnPause, `4` = Fechado
`organizationId`	`inteiro`	Limitar por organização
`operadorId`	`inteiro`	Limitar por operador atribuído

Resposta (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. Alterar status do bate-papo

Atualiza o status atribuído de uma sessão de chat específica.

Solicitação - Método: COLOCAR - URL: /api/chat/status - Autorização: Bearer Token - Cabeçalhos: Tipo de conteúdo: aplicativo/json

Corpo:

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

Valores de enumeração de status: - 0: Novo (recém-gerado) - 1: Aberto (manuseado ativamente pelo operador) - 2: Aguardando (Aguardando resposta do usuário) - 3: OnPause (estado pausado) - 4: Fechado (Arquivado)

3. Excluir um bate-papo

Exclui permanentemente um bate-papo por meio de seu ID exclusivo.

Solicitação - Método: EXCLUIR - URL: /api/chat/chats/{id} - Autorização: Bearer Token

Resposta (200 OK) Retorna um HTTP 200 para confirmar a exclusão bem-sucedida. O corpo normalmente está vazio ou estritamente "OK".

4. Recuperar mensagens de bate-papo

Despeja todas as mensagens enviadas e recebidas historicamente em um bate-papo específico.

Solicitação - Método: OBTER - URL: /api/chat/chats/{chatId}/messages - Autorização: Bearer Token

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

Autores: - 0: Operador - 1: Cliente - 2: Bot do sistema - 3: Conta Empresarial Viber

Tipos de mensagem: - 0: Texto - 1: Foto - 2: Arquivo

5. Atualizar status das mensagens

Marca uma mensagem (ou várias mensagens) dentro de um chat ativo com novos status de entrega.

Solicitação - Método: COLOCAR - URL: /api/chat/messages/status - Autorização: Bearer Token - Cabeçalhos: Tipo de conteúdo: aplicativo/json

Corpo: CODE_BLOCO_3 (O status 3 marca os IDs das mensagens enviadas como "Lidas")