Agents

Atualizar dados do agente

put

Atualiza dados do agente conforme os dados enviados.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo
namestringOpcional
ramalintegerOpcional
passwordstringOpcional
new_passwordstringOpcional
default_languagestringOpcional
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
put
/v4/user/agents/update

Listar agentes online

get

Retorna agentes online conforme filtros enviados.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de consulta
paginatebooleanOpcional

Paginar resultados.

Example: true
allUsersbooleanOpcional

Listar todos os usuários.

Example: false
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
get
/v4/user/agents/online
200

Sucesso.

Login do agente

post

Processa a solicitação de login do agente e retorna o resultado.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo
Other propertiesanyOpcional
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
post
/v4/user/agents/login
200

Sucesso.

Logout do agente

post

Processa a solicitação de logout do agente e retorna o resultado.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo
Other propertiesanyOpcional
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
post
/v4/user/agents/logout
200

Sucesso.

Campanhas disponíveis para o agente

get

Processa a solicitação de campanhas disponíveis para o agente e retorna o resultado.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
get
/v4/user/agents/campaigns
200

Sucesso.

Média de notas do agente

get

Processa a solicitação de média de notas do agente e retorna o resultado.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
get
/v4/user/agents/grades
200

Sucesso.

Ativar ou desativar campanha do agente

post

Alterna campanha do agente conforme o estado informado.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo
campaign_idstringObrigatório
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
post
/v4/user/agents/toggle/campaign
200

Sucesso.

Listar atendimentos do agente

get

Retorna atendimentos do agente conforme filtros enviados.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
get
/v4/user/agents/attendances
200

Sucesso.

Listar atendimentos do agente (com paginação)

get

Retorna atendimentos do agente conforme filtros enviados.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de consulta
namestringOpcional

Filtro por nome.

Example: Cliente
paginateAttendancebooleanOpcionalExample: false
pageAttendanceinteger · mín: 1OpcionalExample: 1
paginateWaitbooleanOpcionalExample: false
pageWaitinteger · mín: 1OpcionalExample: 1
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
get
/v4/user/agents/attendances_plus
200

Sucesso.

Listar sessões em atendimento

get

Retorna sessões em atendimento conforme filtros enviados.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de consulta
namestringOpcionalExample: Cliente
paginatebooleanOpcionalExample: true
pageinteger · mín: 1OpcionalExample: 1
contact_plusbooleanOpcionalExample: false
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
get
/v4/user/agents/sessions/attendances
200

Sucesso.

Listar sessões em espera

get

Retorna sessões em espera conforme filtros enviados.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de consulta
namestringOpcionalExample: Cliente
paginatebooleanOpcionalExample: true
pageinteger · mín: 1OpcionalExample: 1
contact_plusbooleanOpcionalExample: false
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
get
/v4/user/agents/sessions/waits
200

Sucesso.

Listar pausas ativas

get

Retorna pausas ativas conforme filtros enviados.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
get
/v4/user/agents/pauses
200

Sucesso.

Iniciar pausa

post

Inicia pausa com os dados informados.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo
pause_idstringObrigatório
isPausePersonalizedbooleanOpcional
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
post
/v4/user/agents/pauses/start

Encerrar pausa

post

Encerra pausa conforme a sessão informada.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo
Other propertiesanyOpcional
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
post
/v4/user/agents/pauses/stop
200

Sucesso.

Evento de timeout de pausa

post

Processa a solicitação de evento de timeout de pausa e retorna o resultado.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo
Other propertiesanyOpcional
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
post
/v4/user/agents/pauses/timeout/event/admin
200

Sucesso.

Buscar pausa em progresso

get

Pesquisa pausa em progresso conforme critérios enviados.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
get
/v4/user/agents/pauses/progress
200

Sucesso.

Listar mensagens do chat do agente

get

Retorna mensagens do chat do agente conforme filtros enviados.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
get
/v4/user/agents/messages
200

Sucesso.

Enviar mensagem do chat do agente

post

Envia mensagem do chat do agente com os dados informados.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo
Other propertiesanyOpcional
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
post
/v4/user/agents/messages/send
200

Sucesso.

Marcar mensagens como lidas (chat)

get

Marca mensagens como lidas conforme os parâmetros informados.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota
agent_idstringObrigatório

ID do agente.

Example: agent_123
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
get
/v4/user/agents/messages/read/{agent_id}
200

Sucesso.

Mensagens pendentes (chat)

post

Processa a solicitação de mensagens pendentes e retorna o resultado.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo
Other propertiesanyOpcional
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
post
/v4/user/agents/messages/pending
200

Sucesso.

Limite de upload do agente

get

Processa a solicitação de limite de upload do agente e retorna o resultado.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
get
/v4/user/agents/uploadLimit
200

Sucesso.

Listar copilot

get

Retorna copilot conforme filtros enviados.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
get
/v4/user/agent/copilot/list
200

Sucesso.

Executar copilot

post

Processa a solicitação de executar copilot e retorna o resultado.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo
Other propertiesanyOpcional
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
post
/v4/user/agent/copilot/execute
200

Sucesso.

Obter dados WebRTC

get

Recupera dados WebRTC.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota
idstringObrigatório

ID do agente ou sessão.

Example: agent_123
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
get
/v4/user/agent/webrtc/{id}
200

Sucesso.

Listar placeholders

post

Retorna placeholders conforme filtros enviados.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo
Other propertiesanyOpcional
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
post
/v4/user/agent/placeholders
200

Sucesso.

Traduzir mensagem

post

Processa a solicitação de traduzir mensagem e retorna o resultado.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo
languagestringObrigatório
messagestringObrigatório
session_idstringOpcional
message_idstringOpcional
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
post
/v4/user/agent/stt/translate

Detectar idioma

post

Processa a solicitação de detectar idioma e retorna o resultado.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo
messagestringObrigatório
contact_idstringObrigatório
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
post
/v4/user/agent/stt/translate/detect

Ativar/desativar auto tradução

post

Alterna auto tradução conforme o estado informado.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo
session_idstringObrigatório
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
post
/v4/user/agent/stt/translate/activeAutoTranslate

Realizar chamada para contato

post

Processa a solicitação de realizar chamada para contato e retorna o resultado.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo
contact_idstringObrigatório
whatsappbooleanOpcional
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
post
/v4/user/agent/call

Listar agentes

get

Retorna agentes conforme filtros enviados.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
get
/v4/agents
200

Sucesso.

Criar agente

post

Cria agente com os dados enviados.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo
Other propertiesanyOpcional
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
post
/v4/agents
200

Sucesso.

Buscar agente por e-mail

get

Pesquisa agente por e-mail conforme critérios enviados.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota
emailstring · emailObrigatórioExample: [email protected]
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
get
/v4/agents/email/{email}

Resumo de agentes

get

Processa a solicitação de resumo de agentes e retorna o resultado.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
get
/v4/agents/summary
200

Sucesso.

Detalhar agente

get

Recupera os dados de agente identificado no caminho.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota
idstringObrigatórioExample: agent_123
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
get
/v4/agents/{id}
200

Sucesso.

Atualizar agente

put

Atualiza agente conforme os dados enviados.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota
idstringObrigatório
Corpo
Other propertiesanyOpcional
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
put
/v4/agents/{id}
200

Sucesso.

Remover agente

delete

Remove agente identificado no caminho.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota
idstringObrigatório
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
delete
/v4/agents/{id}
200

Sucesso.

Atualizar foto do agente

post

Atualiza foto do agente conforme os dados enviados.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo
photostring · binaryOpcional
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
post
/v4/agents/photo
200

Sucesso.

Atualizado

Isto foi útil?