Mudanças entre as edições de "API Agente"
(Criou página com '== Introdução == A API funciona por link HTTP, com parâmetros em GET ou POST e a resposta em JSON.<br> Para cada função (command) são necessários determinados parâme...') |
|||
| Linha 17: | Linha 17: | ||
| unpause|| agent | | 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.<br> | ||
| + | |||
| + | Login:<br> | ||
| + | http://'''<server_IP>'''/api/agent.php?agent='''login_agente'''&command=login&exten='''num_ramal'''&queue='''nome_fila''' | ||
| + | |||
| + | Logoff:<br> | ||
| + | http://'''<server_IP>'''/api/agent.php?agent='''login_agente'''&command=logoff | ||
| + | |||
| + | Pause:<br> | ||
| + | http://'''<server_IP>'''/api/agent.php?agent='''login_agente'''&command=pause&reason='''motivo_da_pausa''' | ||
| + | |||
| + | Unpause:<br> | ||
| + | http://'''<server_IP>'''/api/agent.php?agent='''login_agente'''&command=unpause | ||
Edição das 15h51min 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
