MPI/API/CmdGetConfig
De uTech Tecnologia
(Diferença entre revisões)
(→Exemplo) |
(→Comando) |
||
Linha 57: | Linha 57: | ||
|- | |- | ||
| align="left"| release || Informação da versão de firmware do equipamento. | | align="left"| release || Informação da versão de firmware do equipamento. | ||
+ | | align="left"| http_server || Endereço do Servidor de Integração. | ||
+ | | align="left"| http_port || Porta do Servidor de Integração. | ||
+ | | align="left"| http_username || Usuário do Servidor de Integração. | ||
+ | | align="left"| http_password || Senha do Servidor de Integração. | ||
+ | | align="left"| http_url || URL do Servidor de Integração. | ||
+ | | align="left"| http_timeout || Timeout da Requisição em segundos. | ||
+ | | align="left"| http_retries || Número de Tentativas da Requisição. | ||
+ | | align="left"|interface1_control_enable || Habilitar/Desabilitar Acionamento (Relê) da Interface 1. | ||
+ | * '''true''': Habilita. | ||
+ | * '''false''': Desabilita. | ||
+ | | align="left"|interface1_control_type || Tipo de Acionamento da Interface 1: | ||
+ | * '''0''': Contínuo. | ||
+ | * '''1''': Pulsado. | ||
+ | * '''2''': Manual. | ||
+ | | align="left"|interface1_control_time || Tempo de acionamento da interface 1 (segundos) | ||
+ | | align="left"|interface1_control_acc_time || Tempo de acionamento da interface 1 para acessibilidade (segundos). | ||
+ | | align="left"|interface1_interlocking || Habilitar/Desabilitar intertravamento na interface 1. | ||
+ | * '''true''': Habilita. | ||
+ | * '''false''': Desabilita. | ||
+ | | align="left"|interface1_sensor_enable || Habilitar/Desabilitar sensor da interface 1. | ||
+ | * '''true''': Habilita. | ||
+ | * '''false''': Desabilita. | ||
+ | | align="left"|interface1_sensor_panic || Habilitar/Desabilitar função pâncio no sensor da interface 1. | ||
+ | * '''true''': Habilita. | ||
+ | * '''false''': Desabilita. | ||
+ | | align="left"|interface1_sensor_alarm || Tempo, em segundos, para alarme no sensor de porta aberta da interface 1 (0 - Desabilitado). | ||
+ | * '''true''': Habilita. | ||
+ | * '''false''': Desabilita. | ||
+ | | align="left"|interface1_sensor_breakin || Habilitar/Desabilitar alarme de arrombamento na Interface 1. | ||
+ | * '''true''': Habilita. | ||
+ | * '''false''': Desabilita. | ||
+ | | align="left"|interface1_button_enable || Habilitar/Desabilitar botoeira na interface 1. | ||
+ | * '''true''': Habilita. | ||
+ | * '''false''': Desabilita. | ||
+ | | align="left"|interface1_button_panic || Habilitar/Desabilitar função pânico na botoeira na interface 1. | ||
+ | * '''true''': Habilita. | ||
+ | * '''false''': Desabilita. | ||
+ | | align="left"|interface1_button_relay || Habilitar/Desabilitar acionamento da botoeira na interface 1. || | ||
+ | * '''true''': Habilita. | ||
+ | * '''false''': Desabilita. | ||
+ | | align="left"|interface1_button_interface || Interface de acionamento da botoeira na interface 1. | ||
+ | * '''0''': Ambas | ||
+ | * '''1''': Interface 1 | ||
+ | * '''2''': Interface 2 | ||
+ | | align="left"|interface2_control_enable || Habilitar/Desabilitar Acionamento (Relê) da Interface 1. | ||
+ | * '''true''': Habilita. | ||
+ | * '''false''': Desabilita. | ||
+ | | align="left"|interface2_control_type || Tipo de Acionamento da Interface 1: | ||
+ | * '''0''': Contínuo. | ||
+ | * '''1''': Pulsado. | ||
+ | * '''2''': Manual. | ||
+ | | align="left"|interface2_control_time || Tempo de acionamento da interface 1 (segundos) | ||
+ | | align="left"|interface2_control_acc_time || Tempo de acionamento da interface 1 para acessibilidade (segundos). | ||
+ | | align="left"|interface2_interlocking || Habilitar/Desabilitar intertravamento na interface 1. | ||
+ | * '''true''': Habilita. | ||
+ | * '''false''': Desabilita. | ||
+ | | align="left"|interface2_sensor_enable || Habilitar/Desabilitar sensor da interface 1. | ||
+ | * '''true''': Habilita. | ||
+ | * '''false''': Desabilita. | ||
+ | | align="left"|interface2_sensor_panic || Habilitar/Desabilitar função pâncio no sensor da interface 1. | ||
+ | * '''true''': Habilita. | ||
+ | * '''false''': Desabilita. | ||
+ | | align="left"|interface2_sensor_alarm || Tempo, em segundos, para alarme no sensor de porta aberta da interface 1 (0 - Desabilitado). | ||
+ | * '''true''': Habilita. | ||
+ | * '''false''': Desabilita. | ||
+ | | align="left"|interface2_sensor_breakin || Habilitar/Desabilitar alarme de arrombamento na Interface 1. | ||
+ | * '''true''': Habilita. | ||
+ | * '''false''': Desabilita. | ||
+ | | align="left"|interface2_button_enable || Habilitar/Desabilitar botoeira na interface 1. | ||
+ | * '''true''': Habilita. | ||
+ | * '''false''': Desabilita. | ||
+ | | align="left"|interface2_button_panic || Habilitar/Desabilitar função pânico na botoeira na interface 1. | ||
+ | * '''true''': Habilita. | ||
+ | * '''false''': Desabilita. | ||
+ | | align="left"|interface2_button_relay || Habilitar/Desabilitar acionamento da botoeira na interface 1. || | ||
+ | * '''true''': Habilita. | ||
+ | * '''false''': Desabilita. | ||
+ | | align="left"|interface2_button_interface || Interface de acionamento da botoeira na interface 1. | ||
+ | * '''0''': Ambas | ||
+ | * '''1''': Interface 1 | ||
+ | * '''2''': Interface 2 | ||
|} | |} | ||
Edição de 19h59min de 20 de junho de 2018
Tabela de conteúdo |
O comando Buscar Configuração é utilizado solicitar as configurações básicas do porteiro.
Comando
MÉTODO: GET
Parâmetros enviados para o Porteiro | |
---|---|
request | getconfig |
Resposta enviada pelo o Porteiro | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
serial | Numero de série do equipamento. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mac | Endereço MAC do porteiro. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
dhcp | Identifica se o cliente dhcp está habilitado.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ip | Endereço IP do porteiro. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
netmask | Endereço da mascara de rede do porteiro. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gateway | Endereço da rota padrão do porteiro. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
dns | Endereço do servidor DNS primário do porteiro. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ntp | Endereço do servidor NTP do porteiro. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
server | Servidor SIP primário. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
port | Porta de sinalização do servidor SIP. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
stun | Endereço do servidor STUN. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
exten | Ramal/extensão do porteiro. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
passowrd | Senha do ramal/extensão do porteiro. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
hotline | Numero discado nao pressionar o botão Portaria. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
volmicrofone | Volume do microfone (min:0 - max:20) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
volspeaker | Volume do alto falante (min:0 - max:20) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keyboard | Define se está habilitado ou não o teclado do porteiro.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
release | Informação da versão de firmware do equipamento. | http_server | Endereço do Servidor de Integração. | http_port | Porta do Servidor de Integração. | http_username | Usuário do Servidor de Integração. | http_password | Senha do Servidor de Integração. | http_url | URL do Servidor de Integração. | http_timeout | Timeout da Requisição em segundos. | http_retries | Número de Tentativas da Requisição. | interface1_control_enable | Habilitar/Desabilitar Acionamento (Relê) da Interface 1.
|
interface1_control_type | Tipo de Acionamento da Interface 1:
|
interface1_control_time | Tempo de acionamento da interface 1 (segundos) | interface1_control_acc_time | Tempo de acionamento da interface 1 para acessibilidade (segundos). | interface1_interlocking | Habilitar/Desabilitar intertravamento na interface 1.
|
interface1_sensor_enable | Habilitar/Desabilitar sensor da interface 1.
|
interface1_sensor_panic | Habilitar/Desabilitar função pâncio no sensor da interface 1.
|
interface1_sensor_alarm | Tempo, em segundos, para alarme no sensor de porta aberta da interface 1 (0 - Desabilitado).
|
interface1_sensor_breakin | Habilitar/Desabilitar alarme de arrombamento na Interface 1.
|
interface1_button_enable | Habilitar/Desabilitar botoeira na interface 1.
|
interface1_button_panic | Habilitar/Desabilitar função pânico na botoeira na interface 1.
|
interface1_button_relay | Habilitar/Desabilitar acionamento da botoeira na interface 1. |
|
interface1_button_interface | Interface de acionamento da botoeira na interface 1.
|
interface2_control_enable | Habilitar/Desabilitar Acionamento (Relê) da Interface 1.
|
interface2_control_type | Tipo de Acionamento da Interface 1:
|
interface2_control_time | Tempo de acionamento da interface 1 (segundos) | interface2_control_acc_time | Tempo de acionamento da interface 1 para acessibilidade (segundos). | interface2_interlocking | Habilitar/Desabilitar intertravamento na interface 1.
|
interface2_sensor_enable | Habilitar/Desabilitar sensor da interface 1.
|
interface2_sensor_panic | Habilitar/Desabilitar função pâncio no sensor da interface 1.
|
interface2_sensor_alarm | Tempo, em segundos, para alarme no sensor de porta aberta da interface 1 (0 - Desabilitado).
|
interface2_sensor_breakin | Habilitar/Desabilitar alarme de arrombamento na Interface 1.
|
interface2_button_enable | Habilitar/Desabilitar botoeira na interface 1.
|
interface2_button_panic | Habilitar/Desabilitar função pânico na botoeira na interface 1.
|
interface2_button_relay | Habilitar/Desabilitar acionamento da botoeira na interface 1. |
|
interface2_button_interface | Interface de acionamento da botoeira na interface 1.
|
Exemplo
http://ip:porta/?request=getconfig |
---|
Resposta:
- 400 => Parâmetros incorretos
- 401 => Erro de autenticação da API
- 200 => OK
Content-Type: application/json { "serial":"0000005555", "mac":"F8:E7:B5:00:0B:3F", "dhcp":"off", "ip":"10.0.0.1", "netmask":"255.255.255.0", "gateway":"10.0.0.3", "dns":"8.8.8.8", "ntp":"", "server":"10.0.0.2", "port":"5060", "stun":"", "exten":"7000", "password":"1234", "hotline":"98", "volmicrophone":"15", "volspeaker":"18", "keyboard":"true", "release":"1.0.22" } |
---|
PHP
<?php $user = "utech"; $pass = "1234"; $port = "8080"; $ipaddr = "10.0.0.1"; $url = ""; $url = "$ipaddr:$port?request=getconfig"; $ch = curl_init($url); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC); curl_setopt($ch, CURLOPT_USERPWD, "$user:$pass"); $result = curl_exec($ch); if(!$result) { echo "error!\n"; return 2; } print_r(json_decode($result, true)); ?> |