O Omni oferece APIs robustas para consulta e exportação de dados históricos de atendimentos, chamadas, pesquisas de satisfação e atividades dos usuários. Veja como autenticar, acessar e utilizar as principais rotas.
Autenticação
- Copie a x-api-key no menu de canais do Omni.
- Acesse https://docs-history.omni.digitalcontact.cloud/, clique em “Authorize” e cole a key no campo api_key.
- Para APIs de contato/integração, use a rota `/Login/loginApi` (informe login e senha) e copie o token retornado.
- Para APIs de relatório, use `/Login/organization` (login, senha e organization id) e copie o token.
- Sempre adicione “Bearer “ antes do token no campo Authorization.
Principais rotas disponíveis
- service-history: Retorna dados de todos os atendimentos entre datas especificadas.
- voice-log: Retorna dados de chamadas receptivas e ativas.
- service-history-audio-links: Fornece links para gravações de atendimentos.
- activity-history: Retorna logins, logouts e pausas dos usuários.
- satisfaction-survey-history: Retorna pesquisas de satisfação atribuídas aos atendimentos.
- service-history-messages: Retorna o histórico de mensagens dos atendimentos.
Parâmetros comuns das rotas
- report-skip: Paginação (0 = primeira página, cada página com até 1000 registros).
- date_ini / date_end: Datas inicial e final do período consultado (aceita formatos com ou sem hora).
Como executar uma requisição
- Acesse a rota desejada e clique em “Try it out”.
- Preencha os parâmetros obrigatórios (datas, paginação, etc).
- Clique em “Execute” para visualizar ou exportar os dados retornados.
Exemplos de uso
- Consultar todos os atendimentos de um período: use `/ReportsApi/service-history` com as datas desejadas.
- Obter gravações de chamadas: use `/ReportsApi/service-history-audio-links`.
- Consultar logins e pausas: use `/ReportsApi/activity-history`.
- Exportar pesquisas de satisfação: use `/ReportsApi/satisfaction-survey-history`.
