Sign in
latestOpenAPI 3.0.12026-08-1914141.6 MB

c656412a58bc

Chats

Listar chats da caixa de entrada

Lista os chats que estão na caixa de entrada da sua organização.

get/chats/inbox

Query parameters

offsetinteger

Número da página a ser retornada

limitinteger

Número de itens retornados na página

department_idinteger

Filtrar os chats por ID do departamento

client_idinteger

Filtrar os chats por ID do cliente

requestor_idinteger

Filtrar os chats por ID do solicitante vinculado ao chat

numberinteger

Filtrar os chats pelo número que entrou em contato. É necessário uma licença Whatsapp para utilizar esse parâmetro

origins'chat' | 'site_widget' | 'campaign' | 'whatsapp' | 'whatsapp_web' | 'gupshup' | 'whatsapp_cloud'

Filtrar os chats pelo canal de origem. Pode ser informada mais de uma origem, separada por vírgula

started_by'Client' | 'Attendant' | 'Campaign' | 'API'

Filtrar os chats pela forma de como eles foram iniciados

created_at_startstring

Filtrar chats com data de criação maior ou igual ao valor informado (YYYY-MM-DDTHH:MM:SSZ)

created_at_endstring

Filtrar chats com data de criação menor ou igual ao valor informado (YYYY-MM-DDTHH:MM:SSZ)

Response

idinteger required

Identificador do chat

archivedboolean required

O chat está arquivado ou finalizado?

assessmentinteger nullable required

Nota da avaliação do chat

created_atstring required

Data de criação do chat

last_client_messagestring nullable required

Data e hora da última mensagem enviada pelo cliente no chat

onlineboolean required

Específico para origem widget, indica se na conversa, quem abriu o chat ainda está online

roomstring required

Identificador da sessão do chat. Pode ser o número do chat, o identificador do WhatsApp ou um identificador único de sessão

started_by'Client' | 'Attendant' | 'Campaign' | 'API' required

Indicador de quem iniciou o chat

updated_atstring required

Data da última modificação no chat

waiting_answerboolean required

O chat está esperando resposta do atendente?

assumed_atstring nullable required

Data em que o chat foi assumido