{"info":{"_postman_id":"230174b6-7d8c-4b4a-9382-ba724c7bb81f","name":"API de Exportação de Dados de Voz para BI","description":"

Esta API permite exportar dados para plataformas de BI, como o Power BI, através de requisições HTTP.

A API permite consultar dados de voz do Banco de Dados do Módulo de Atendimento Smartspace, relacionados às chamadas ou às sessões de Agentes, conforme o tipo especificado.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"39004890","collectionId":"230174b6-7d8c-4b4a-9382-ba724c7bb81f","publishedId":"2sB34eK2og","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"142129","highlight":"DC4128"},"publishDate":"2025-07-18T12:33:16.000Z"},"item":[{"name":"Pré-requisitos e Permissões","item":[],"id":"005b7d66-ba4f-4871-bf79-2fe783293045","description":"

Autenticação básica via headers:

client-id
\n
client-secret
\n

Exemplo de Requisição

GET /api/exportar/bi?domain_uuid=c2146e15-e78d-45cb-985a-155326123456&data_inicial=2024-09-23&data_final=2024-09-24&tipo=chamadas

Host: example.com
client-id: your_client_id
client-secret: your_client_secret

\n","_postman_id":"005b7d66-ba4f-4871-bf79-2fe783293045"},{"name":"Endpoints","item":[{"name":"Consultar dados de chamadas ou agentes","id":"228421ac-cf61-4426-8c35-835448260f45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"

Retorna dados de chamadas ou de agentes de voz, com base no tipo informado.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"5cca6a13-2dc5-4b3a-844e-922ad36cc5df","name":"Resposta (Tipo: chamadas)","originalRequest":{"method":"GET","header":[{"key":"client-id","value":"`your_client_id`","type":"text"},{"key":"client-secret","value":"`your_client_secret`","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"member_session_uuid\": \"a89e1c13-fb54-4235-a128-59ce15107699\",\r\n \"agent\": \"agente.exemplo@dominioemail.br\",\r\n \"u_agent_id\": \"2de73398-a25c-5aec-37d9-7ef6f611db85\",\r\n \"u_agent_nome\": \"Agente Exemplo Teste\",\r\n \"queue\": \"Suporte_N1_Ativa@dominioemail.br.smartspace.us\",\r\n \"originador\": \"0125133735000\",\r\n \"inicio\": \"2024-09-23 11:47:25.947\",\r\n \"fim\": \"2024-09-23 11:47:53.667\",\r\n \"inicio_atendimento\": \"2024-09-23 11:47:26.967\",\r\n \"posicao_ao_entrar_fila\": null,\r\n \"tempo_espera\": 1,\r\n \"duracao\": 27,\r\n \"exten_transferencia\": null,\r\n \"callid_transferido\": null,\r\n \"atendente_transferido\": null,\r\n \"hangup_cause\": \"SUCCESS\",\r\n \"hangup_disposition\": null,\r\n \"cancel_reason\": \"\",\r\n \"qualificacoes\": null,\r\n \"ultima_action\": \"bridge-agent-end\",\r\n \"dominio_uuid\": \"c2146e15-e78d-45cb-985a-155326123456\",\r\n \"qtd_tentativas\": 1,\r\n \"status\": \"atendida\",\r\n \"posicao_ao_abandonar_fila\": null,\r\n \"protocolo\": \"202409232082782\",\r\n \"agent_called_time\": \"2024-09-23 11:47:25\",\r\n \"agent_answered_time\": \"2024-09-23 11:47:26\",\r\n \"qtd_toques\": 1,\r\n \"tempo_toque\": 1,\r\n \"id\": \"32599202-f524-4aa9-a239-7f6d9d47f804\",\r\n \"callback\": false,\r\n \"callback_status\": null,\r\n \"callback_tentativas\": 0,\r\n \"callback_request\": null,\r\n \"callback_first_call\": null,\r\n \"callback_first_call_duration\": 0,\r\n \"callback_answer\": null,\r\n \"callback_answer_duration\": 0,\r\n \"contador\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://seuservidor.com/api/exportar/bi?domain_uuid=c2146e15-e78d-45cb-985a-155326123456&data_inicial=2024-09-23&data_final=2024-09-24&tipo=chamadas&queue =(opcional)","protocol":"https","host":["seuservidor","com"],"path":["api","exportar","bi"],"query":[{"key":"domain_uuid","value":"c2146e15-e78d-45cb-985a-155326123456","description":"UUID do domínio "},{"key":"data_inicial","value":"2024-09-23","description":"Data inicial no formato YYYY-MM-DD"},{"key":"data_final","value":"2024-09-24","description":"Data final no formato YYYY-MM-DD"},{"key":"tipo","value":"chamadas","description":"`chamadas` ou `agentes`"},{"key":"queue ","value":"(opcional)","description":"Fila de atendimento"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"member_session_uuid\": \"a89e1c13-fb54-4235-a128-59ce15107699\",\n \"agent\": \"agente.exemplo@dominioemail.br\",\n \"u_agent_id\": \"2de73398-a25c-5aec-37d9-7ef6f611db85\",\n \"u_agent_nome\": \"Agente Exemplo Teste\",\n \"queue\": \"Suporte_N1_Ativa@dominioemail.br\",\n \"originador\": \"0125133735000\",\n \"inicio\": \"2024-09-23 11:47:25.947\",\n \"fim\": \"2024-09-23 11:47:53.667\",\n \"inicio_atendimento\": \"2024-09-23 11:47:26.967\",\n \"posicao_ao_entrar_fila\": null,\n \"tempo_espera\": 1,\n \"duracao\": 27,\n \"exten_transferencia\": null,\n \"callid_transferido\": null,\n \"atendente_transferido\": null,\n \"hangup_cause\": \"SUCCESS\",\n \"hangup_disposition\": null,\n \"cancel_reason\": \"\",\n \"qualificacoes\": null,\n \"ultima_action\": \"bridge-agent-end\",\n \"dominio_uuid\": \"c2146e15-e78d-45cb-985a-155326123456\",\n \"qtd_tentativas\": 1,\n \"status\": \"atendida\",\n \"posicao_ao_abandonar_fila\": null,\n \"protocolo\": \"202409232082782\",\n \"agent_called_time\": \"2024-09-23 11:47:25\",\n \"agent_answered_time\": \"2024-09-23 11:47:26\",\n \"qtd_toques\": 1,\n \"tempo_toque\": 1,\n \"id\": \"32599202-f524-4aa9-a239-7f6d9d47f804\",\n \"callback\": false,\n \"callback_status\": null,\n \"callback_tentativas\": 0,\n \"callback_request\": null,\n \"callback_first_call\": null,\n \"callback_first_call_duration\": 0,\n \"callback_answer\": null,\n \"callback_answer_duration\": 0,\n \"contador\": 1\n}"},{"id":"8a34f71a-5c35-4ab6-a1e1-c794dedd029a","name":"Resposta (Tipo: agentes)","originalRequest":{"method":"GET","header":[{"key":"client-id","value":"`your_client_id`","type":"text"},{"key":"client-secret","value":"`your_client_secret`","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"id\": \"a9fb561a-c04f-40dd-91c8-079aadb606c9\",\r\n \"agent\": \"Agente Exemplo\",\r\n \"inicio\": \"2024-09-23 08:00:00\",\r\n \"fim\": \"2024-09-23 16:00:00\",\r\n \"duracao\": 28800,\r\n \"motivo_pausa\": \"Almoço\",\r\n \"queue\": \"Suporte_N1\",\r\n \"action\": \"Pausa\",\r\n \"pausa_faturavel\": true,\r\n \"observacao\": \"Pausa programada\",\r\n \"usuario_id\": \"2de73398-a25c-5aec-37d9-7ef6f611db85\",\r\n \"domain_uuid\": \"c2146e15-e78d-45cb-985a-155326123456\",\r\n \"contador\": 1\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://seuservidor.com/api/exportar/bi?domain_uuid=c2146e15-e78d-45cb-985a-155326123456&data_inicial=2024-09-23&data_final=2024-09-24&tipo=chamadas&queue =(opcional)","protocol":"https","host":["seuservidor","com"],"path":["api","exportar","bi"],"query":[{"key":"domain_uuid","value":"c2146e15-e78d-45cb-985a-155326123456","description":"UUID do domínio "},{"key":"data_inicial","value":"2024-09-23","description":"Data inicial no formato YYYY-MM-DD"},{"key":"data_final","value":"2024-09-24","description":"Data final no formato YYYY-MM-DD"},{"key":"tipo","value":"chamadas","description":"`chamadas` ou `agentes`"},{"key":"queue ","value":"(opcional)","description":"Fila de atendimento"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"a9fb561a-c04f-40dd-91c8-079aadb606c9\",\n \"agent\": \"Agente Exemplo\",\n \"inicio\": \"2024-09-23 08:00:00\",\n \"fim\": \"2024-09-23 16:00:00\",\n \"duracao\": 28800,\n \"motivo_pausa\": \"Almoço\",\n \"queue\": \"Suporte_N1\",\n \"action\": \"Pausa\",\n \"pausa_faturavel\": true,\n \"observacao\": \"Pausa programada\",\n \"usuario_id\": \"2de73398-a25c-5aec-37d9-7ef6f611db85\",\n \"domain_uuid\": \"c2146e15-e78d-45cb-985a-155326123456\",\n \"contador\": 1\n }\n]"}],"_postman_id":"228421ac-cf61-4426-8c35-835448260f45"}],"id":"ae009ea1-83df-484f-bb99-59390cad1b0f","description":"

GET /api/exportar/bi

Este endpoint retorna dados de chamadas ou agentes com base no tipo solicitado.

Parâmetros

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Descrição	Obrigatório
domain_uuid	uuid	UUID do domínio para filtrar os dados	Sim
data_inicial	string	Data inicial do filtro no formato YYYY-MM-DD	Sim
data_final	string	Data final do filtro no formato YYYY-MM-DD	Sim
tipol	string	Define o tipo de consulta. Valores possíveis: chamadas, agentes	Sim
queue	string	Fila de atendimento (opcional). Utilizada para filtrar por fila nas consultas de chamadas e agentes	Não

","_postman_id":"ae009ea1-83df-484f-bb99-59390cad1b0f"},{"name":"Campos retornados","item":[],"id":"8e93bbe8-b55e-4754-8f3d-979d2ee103a1","description":"

A depender do \"Tipo\" de requisição feita serão retornados campos específicos, como descrito a seguir:

Campos Retornados (Tipo: chamadas)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Descrição
member_session_uuid	uuid	UUID da sessão do membro
agent	string	E-mail ou nome do agente
u_agent_id	uuid	UUID do agente
u_agent_nome	string	Nome do agente
queue	string	Fila de atendimento
originador	string	Número do originador da chamada
inicio	string	Data e hora de início da chamada
fim	string	Data e hora de fim da chamada
inicio_atendimento	string	Data e hora de início do atendimento
posicao_ao_entrar_fila	int	Posição do cliente ao entrar na fila
duracao	int	Duração da chamada em segundos
exten_transferencia	string	Ramal de transferência, se houver
callid_transferido	string	ID da chamada transferida, se houver
atendente_transferido	string	Nome do atendente transferido, se houver
hangup_cause	string	Motivo da finalização da chamada
hangup_disposition	string	Disposição ao desligar
cancel_reason	string	Razão do cancelamento, se houver
qualificacoes	string	Qualificações, se houver
ultima_action	string	Última ação realizada na chamada
dominio_uuid	uuid	UUID do domínio relacionado à chamada
qtd_tentativas	int	Quantidade de tentativas de chamadas
status	string	Status da chamada (atendida, perdida, etc.)
posicao_ao_abandonar_fila	int	Posição ao abandonar a fila, se houver
protocolo	string	Protocolo da chamada
agent_called_time	string	Hora em que o Agente foi chamado
agent_answered_time	string	Hora em que o Agente atendeu a chamada
agent_answered_time	string	Hora em que o Agente atendeu a chamada
qtd_toques	int	Quantidade de toques antes do atendimento
tempo_toque	int	Tempo de toque em segundos
id	uuid	UUID da sessão da chamada
callback	boolean	Indica se a chamada foi Callback
callback_status	string	Status do Callback
callback_tentativas	int	Número de tentativas de Callback
callback_request	string	Solicitação de Callback, se houver
callback_first_call	string	Primeira chamada de Callback, se houver
callback_first_call_duration	int	Duração da primeira chamada de Callback em segundos
callback_answer	string	Resposta do Callback, se houver
callback_answer_duration	int	Duração da resposta do Callback em segundos
contador	int	Valor fixo, sempre 1, utilizado para contagem

Campos Retornados (Tipo: agentes)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Descrição
id	uuid	UUID da sessão do Agente
agent	string	Nome do Agente
inicio	string	Data e hora de início da ação do Agente
fim	string	Data e hora de fim da ação do Agente
duracao	int	Duração da ação em segundos
motivo_pausa	string	Motivo da pausa (se for uma pausa)
motivo_pausa	string	Motivo da pausa (se for uma pausa)
queue	string	Fila de atendimento relacionada à ação
action	string	Tipo de ação (Pausa, Atendimento, etc.)
pausa_faturavel	boolean	Indica se a pausa é faturável
observacao	string	Observações sobre a ação
usuario_id	uuid	UUID do usuário responsável pela ação
domain_uuid	uuid	UUID do domínio relacionado à ação do agente
contador	int	Valor fixo, sempre 1, utilizado para contagem

Informações de paginação

A resposta da API agora inclui um objeto pagination com as seguintes informações:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Descrição
total	int	Total de registros disponíveis
per_page	int	Quantidade de registros por página
current_page	int	Número da página atual
last_page	int	Número da última página
from	int	Número do primeiro registro na página atual
to	int	Número do último registro na página atual

","_postman_id":"8e93bbe8-b55e-4754-8f3d-979d2ee103a1"},{"name":"Erros Comuns","item":[],"id":"a343cb99-6c5c-496a-9542-9e9f51a260aa","description":"

400 Bad Request: Quando parâmetros obrigatórios não são enviados.
\n
500 Internal Server Error: Quando ocorre algum erro na consulta ao banco de dados.
\n

Autenticação de Erro

Quando a autenticação falha, o retorno será:

{\n    \"error\": \"Autenticação falhou\"\n}\n\n

\n","_postman_id":"a343cb99-6c5c-496a-9542-9e9f51a260aa"}]}