Mudanças entre as edições de "API Agente"
| Linha 20: | Linha 20: | ||
== Requisitos == | == Requisitos == | ||
| − | agent: login do agente (não utilizar o Nome aqui), deve ser um agente válido (criado na interface). | + | '''agent''': login do agente (não utilizar o Nome aqui), deve ser um agente válido (criado na interface).<br> |
| − | exten: Número do ramal, somente dígitos, deve ser um ramal válido e configurado como ramal Call Center. | + | '''exten''': Número do ramal, somente dígitos, deve ser um ramal válido e configurado como ramal Call Center.<br> |
| − | queue: Nome da fila, fila também deve ser configurada como Call Center. | + | '''queue''': Nome da fila, fila também deve ser configurada como Call Center.<br> |
| − | reason (opcional): Utilize motivos de pausa padrão (nomes repetidos), pois as pausas podem ser agrupadas por motivos e facilitar a leitura dos relatórios. Ou utilize as pausas criadas no Nuclear. <link para acesso aos motivos de pausa do sistema> | + | '''reason''' (opcional): Utilize motivos de pausa padrão (nomes repetidos), pois as pausas podem ser agrupadas por motivos e facilitar a leitura dos relatórios.<br> |
| + | Ou utilize as pausas criadas no Nuclear. <link para acesso aos motivos de pausa do sistema><br> | ||
=== Exemplos === | === Exemplos === | ||
| Linha 40: | Linha 41: | ||
Unpause:<br> | Unpause:<br> | ||
http://'''<server_IP>'''/api/agent.php?agent='''login_agente'''&command=unpause | http://'''<server_IP>'''/api/agent.php?agent='''login_agente'''&command=unpause | ||
| + | |||
| + | == Respostas == | ||
| + | |||
| + | A página ira retornar code status 200 seguido dos valores success ou error.<br> | ||
| + | |||
| + | {| class="wikitable" | ||
| + | |- | ||
| + | ! ''success'' !! Descrição | ||
| + | |- | ||
| + | | Login OK || Login efetuado | ||
| + | |- | ||
| + | | Logoff OK || Logoff Efetuado | ||
| + | |- | ||
| + | | Pause OK || Pausa efetuada | ||
| + | |- | ||
| + | | Unpause OK || Retirado da Pausa | ||
| + | |} | ||
| + | |||
| + | {| class="wikitable" | ||
| + | |- | ||
| + | ! ''error'' !! Descrição | ||
| + | |- | ||
| + | | Argument list invalid || Faltam parâmetros não requisição | ||
| + | |- | ||
| + | | Agent not logged || A requisição não pode ser cumprida pois o ramal não esta logado (logoff, pause e unpause) | ||
| + | |- | ||
| + | | Agent not specified || POST ou GET agent não enviado | ||
| + | |- | ||
| + | | Agent not exists || Agente especificado não existe | ||
| + | |- | ||
| + | | Command not specified || POST ou GET command não enviado | ||
| + | |- | ||
| + | | Queue not exists || Fila especificada não existe (login) | ||
| + | |- | ||
| + | | Exten not exists || Ramal especificado não existe (login) | ||
| + | |- | ||
| + | | Queue Call Center false || Fila não esta configurada como Call Center, não pode receber login de agente (login) | ||
| + | |- | ||
| + | | Exten Call Center false || Ramal não esta configurado como Call Center, não pode logar (login) | ||
| + | |- | ||
| + | | Agent alredy paused || Tentando pausar um ramal já pausado (pause) | ||
| + | |- | ||
| + | | Agent alredy available || Tentando despausar um ramal disponível (unpause) | ||
| + | |} | ||
| + | |||
| + | E em caso de falha no envio dos requisitos code status 400.<br> | ||
Edição das 16h10min de 2 de setembro de 2020
Introdução
A API funciona por link HTTP, com parâmetros em GET ou POST e a resposta em JSON.
Para cada função (command) são necessários determinados parâmetros para realizar a ação.
Requisitos por função da API do Agente:
| Command | Requisitos |
|---|---|
| login | agent, exten (Ramal), queue (fila) |
| logoff | agent |
| pause | agent, [reason (motivo) opcional] |
| unpause | agent |
Requisitos
agent: login do agente (não utilizar o Nome aqui), deve ser um agente válido (criado na interface).
exten: Número do ramal, somente dígitos, deve ser um ramal válido e configurado como ramal Call Center.
queue: Nome da fila, fila também deve ser configurada como Call Center.
reason (opcional): Utilize motivos de pausa padrão (nomes repetidos), pois as pausas podem ser agrupadas por motivos e facilitar a leitura dos relatórios.
Ou utilize as pausas criadas no Nuclear. <link para acesso aos motivos de pausa do sistema>
Exemplos
Exemplos simples utilizando GET.
Login:
http://<server_IP>/api/agent.php?agent=login_agente&command=login&exten=num_ramal&queue=nome_fila
Logoff:
http://<server_IP>/api/agent.php?agent=login_agente&command=logoff
Pause:
http://<server_IP>/api/agent.php?agent=login_agente&command=pause&reason=motivo_da_pausa
Unpause:
http://<server_IP>/api/agent.php?agent=login_agente&command=unpause
Respostas
A página ira retornar code status 200 seguido dos valores success ou error.
| success | Descrição |
|---|---|
| Login OK | Login efetuado |
| Logoff OK | Logoff Efetuado |
| Pause OK | Pausa efetuada |
| Unpause OK | Retirado da Pausa |
| error | Descrição |
|---|---|
| Argument list invalid | Faltam parâmetros não requisição |
| Agent not logged | A requisição não pode ser cumprida pois o ramal não esta logado (logoff, pause e unpause) |
| Agent not specified | POST ou GET agent não enviado |
| Agent not exists | Agente especificado não existe |
| Command not specified | POST ou GET command não enviado |
| Queue not exists | Fila especificada não existe (login) |
| Exten not exists | Ramal especificado não existe (login) |
| Queue Call Center false | Fila não esta configurada como Call Center, não pode receber login de agente (login) |
| Exten Call Center false | Ramal não esta configurado como Call Center, não pode logar (login) |
| Agent alredy paused | Tentando pausar um ramal já pausado (pause) |
| Agent alredy available | Tentando despausar um ramal disponível (unpause) |
E em caso de falha no envio dos requisitos code status 400.
