MPI/API/CmdGetConfig

De uTech Tecnologia
(Diferença entre revisões)
Ir para: navegação, pesquisa
(→‎Comando)
(→‎Exemplo)
 
(5 edições intermediárias de um usuário não apresentadas)
Linha 58: Linha 58:
 
| 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"| doublepass_timeout || Tempo, em segundos, para dupla passagem (0 - Desabilitado)
−
| align="left"| http_server  || Endereço do Servidor de Integração.
+
|-
 +
| align="left"| http_server  || '''Cliente''' - Endereço do Servidor de Integração.
 +
|-
 +
| align="left"| http_port    || '''Cliente''' - Porta do Servidor de Integração.
 +
|-
 +
| align="left"| http_username || '''Cliente''' - Usuário do Servidor de Integração.
 +
|-
 +
| align="left"| http_password || '''Cliente''' - Senha do Servidor de Integração.
 +
|-
 +
| align="left"| http_url      || '''Cliente''' - URL do Servidor de Integração.
 +
|-
 +
| align="left"| http_timeout  || '''Cliente''' - Timeout da Requisição em segundos.
 +
|-
 +
| align="left"| http_retries  || '''Cliente''' - Número de Tentativas da Requisição.
 
|-
 
|-
−
| align="left"| http_port    || Porta do Servidor de Integração.
+
| align="left"| http_ssl  || '''Cliente''' - Indica se a conexão com PABX uTech ou servidor de aplicação será HTTPS.
 +
* '''true''': HTTPS habilitado.
 +
* '''false''': HTTPS desabilitado (utilizando HTTP).
 
|-
 
|-
−
| align="left"| http_username || Usuário do Servidor de Integração.
+
| align="left"| httpd_username  || '''Servidor''' - Usuário de acesso das aplicações a API do Porteiro IP MPI.
 
|-
 
|-
−
| align="left"| http_password || Senha do Servidor de Integração.
+
| align="left"| httpd_password  || '''Servidor''' - Senha de acesso das aplicações a API do Porteiro IP MPI.
 
|-
 
|-
−
| align="left"| http_url      || URL do Servidor de Integração.
+
| align="left"| httpd_port  || '''Servidor''' - Porta que o Porteiro IP receberá conexões das aplicações.
 
|-
 
|-
−
| align="left"| http_timeout || Timeout da Requisição em segundos.
+
| align="left"| httpd_timeout || '''Servidor''' - Timeout para conexão TCP.
 
|-
 
|-
−
| align="left"| http_retries || Número de Tentativas da Requisição.
+
| align="left"| httpd_auth || '''Servidor''' - Se habilitado, o Porteiro IP MPI aceitará conexões de todos os usuários configurados (com conta e senha).
 
|-
 
|-
 
| align="left"|interface1_control_enable    || Habilitar/Desabilitar Acionamento (Relê) da Interface 1.
 
| align="left"|interface1_control_enable    || Habilitar/Desabilitar Acionamento (Relê) da Interface 1.
Linha 189: Linha 204:
 
! style="text-align: left; font-weight: bold;" |
 
! style="text-align: left; font-weight: bold;" |
 
<source lang="php">  
 
<source lang="php">  
 +
User-Agent: uTech/0000002874
 +
Connection: close
 +
Date: Wed, 13 Jun 2018 17:22:35
 +
Host: 10.0.0.2
 
Content-Type: application/json
 
Content-Type: application/json
  
 
{
 
{
−
    "serial":"0000005555",
+
"serial":"0000003048",
−
    "mac":"F8:E7:B5:00:0B:3F",
+
"mac":"F8:E7:B5:00:0B:EE",
−
    "dhcp":"off",
+
"release":"1.1.12",
−
    "ip":"10.0.0.1",
+
"dhcp":"off",
−
    "netmask":"255.255.255.0",
+
"ip":"10.0.0.1",
−
    "gateway":"10.0.0.3",
+
"netmask":"255.255.255.0",
−
    "dns":"8.8.8.8",
+
"gateway":"10.0.0.2",
−
    "ntp":"",
+
"dns":"1.1.1.1",
−
    "server":"10.0.0.2",
+
"ntp":"2.3.4.5",
−
    "port":"5060",
+
"server":"10.0.0.3",
−
    "stun":"",
+
"port":"5060",
−
    "exten":"7000",
+
"stun":"",
−
    "password":"1234",
+
"exten":"1000",
−
    "hotline":"98",
+
"password":"1234",
−
    "volmicrophone":"15",
+
"hotline":"94",
−
    "volspeaker":"18",
+
"volmicrophone":"18",
−
    "keyboard":"true",
+
"volspeaker":"20",
−
    "release":"1.0.22"
+
"keyboard":"true",
 +
"http_server":"10.0.0.100",
 +
"http_port":"7777",
 +
"http_username":"admin",
 +
"http_password":"1234",
 +
"http_url":"",
 +
"http_timeout":"30",
 +
"http_retries":"1",
 +
"http_ssl": "false",
 +
"interface1_control_enable":"false",
 +
"interface1_control_type":"1",
 +
"interface1_control_time":"5",
 +
"interface1_control_acc_time":"20",
 +
"interface1_interlocking":"false",
 +
"interface1_sensor_enable":"true",
 +
"interface1_sensor_panic":"false",
 +
"interface1_sensor_alarm":"0",
 +
"interface1_sensor_breakin":"false",
 +
"interface1_button_enable":"false",
 +
"interface1_button_panic":"true",
 +
"interface1_button_relay":"false",
 +
"interface1_button_interface":"0",
 +
"interface2_control_enable":"true",
 +
"interface2_control_type":"1",
 +
"interface2_control_time":"5",
 +
"interface2_control_acc_time":"20",
 +
"interface2_interlocking":"false",
 +
"interface2_sensor_enable":"true",
 +
"interface2_sensor_panic":"false",
 +
"interface2_sensor_alarm":"0",
 +
"interface2_sensor_breakin":"false",
 +
"interface2_button_enable":"false",
 +
"interface2_button_panic":"false",
 +
"interface2_button_relay":"true",
 +
"interface2_button_interface":"2"
 
}
 
}
 
</source>
 
</source>

Edição atual tal como 18h45min de 15 de junho de 2021

Tabela de conteúdo


O comando Buscar Configuração é utilizado solicitar as configurações básicas do porteiro.

[editar] 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.
  • on: Habilitado
  • off: Desabilitado
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.
  • on: Teclado habilitado.
  • off: Teclado desabilitado.
release Informação da versão de firmware do equipamento.
doublepass_timeout Tempo, em segundos, para dupla passagem (0 - Desabilitado)
http_server Cliente - Endereço do Servidor de Integração.
http_port Cliente - Porta do Servidor de Integração.
http_username Cliente - Usuário do Servidor de Integração.
http_password Cliente - Senha do Servidor de Integração.
http_url Cliente - URL do Servidor de Integração.
http_timeout Cliente - Timeout da Requisição em segundos.
http_retries Cliente - Número de Tentativas da Requisição.
http_ssl Cliente - Indica se a conexão com PABX uTech ou servidor de aplicação será HTTPS.
  • true: HTTPS habilitado.
  • false: HTTPS desabilitado (utilizando HTTP).
httpd_username Servidor - Usuário de acesso das aplicações a API do Porteiro IP MPI.
httpd_password Servidor - Senha de acesso das aplicações a API do Porteiro IP MPI.
httpd_port Servidor - Porta que o Porteiro IP receberá conexões das aplicações.
httpd_timeout Servidor - Timeout para conexão TCP.
httpd_auth Servidor - Se habilitado, o Porteiro IP MPI aceitará conexões de todos os usuários configurados (com conta e senha).
interface1_control_enable Habilitar/Desabilitar Acionamento (Relê) da Interface 1.
  • true: Habilita.
  • false: Desabilita.
interface1_control_type Tipo de Acionamento da Interface 1:
  • 0: Contínuo.
  • 1: Pulsado.
  • 2: Manual.
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.
  • true: Habilita.
  • false: Desabilita.
interface1_sensor_enable Habilitar/Desabilitar sensor da interface 1.
  • true: Habilita.
  • false: Desabilita.
interface1_sensor_panic Habilitar/Desabilitar função pâncio no sensor da interface 1.
  • true: Habilita.
  • false: Desabilita.
interface1_sensor_alarm Tempo, em segundos, para alarme no sensor de porta aberta da interface 1 (0 - Desabilitado).
  • true: Habilita.
  • false: Desabilita.
interface1_sensor_breakin Habilitar/Desabilitar alarme de arrombamento na Interface 1.
  • true: Habilita.
  • false: Desabilita.
interface1_button_enable Habilitar/Desabilitar botoeira na interface 1.
  • true: Habilita.
  • false: Desabilita.
interface1_button_panic Habilitar/Desabilitar função pânico na botoeira na interface 1.
  • true: Habilita.
  • false: Desabilita.
interface1_button_relay Habilitar/Desabilitar acionamento da botoeira na interface 1.
  • true: Habilita.
  • false: Desabilita.
interface1_button_interface Interface de acionamento da botoeira na interface 1.
  • 0: Ambas
  • 1: Interface 1
  • 2: Interface 2
interface2_control_enable Habilitar/Desabilitar Acionamento (Relê) da Interface 1.
  • true: Habilita.
  • false: Desabilita.
interface2_control_type Tipo de Acionamento da Interface 1:
  • 0: Contínuo.
  • 1: Pulsado.
  • 2: Manual.
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.
  • true: Habilita.
  • false: Desabilita.
interface2_sensor_enable Habilitar/Desabilitar sensor da interface 1.
  • true: Habilita.
  • false: Desabilita.
interface2_sensor_panic Habilitar/Desabilitar função pâncio no sensor da interface 1.
  • true: Habilita.
  • false: Desabilita.
interface2_sensor_alarm Tempo, em segundos, para alarme no sensor de porta aberta da interface 1 (0 - Desabilitado).
  • true: Habilita.
  • false: Desabilita.
interface2_sensor_breakin Habilitar/Desabilitar alarme de arrombamento na Interface 1.
  • true: Habilita.
  • false: Desabilita.
interface2_button_enable Habilitar/Desabilitar botoeira na interface 1.
  • true: Habilita.
  • false: Desabilita.
interface2_button_panic Habilitar/Desabilitar função pânico na botoeira na interface 1.
  • true: Habilita.
  • false: Desabilita.
interface2_button_relay Habilitar/Desabilitar acionamento da botoeira na interface 1.
  • true: Habilita.
  • false: Desabilita.
interface2_button_interface Interface de acionamento da botoeira na interface 1.
  • 0: Ambas
  • 1: Interface 1
  • 2: Interface 2

[editar] Exemplo 

http://ip:porta/?request=getconfig

Resposta:

  • 400 => Parâmetros incorretos
  • 401 => Erro de autenticação da API
  • 200 => OK 
 
User-Agent: uTech/0000002874
Connection: close
Date: Wed, 13 Jun 2018 17:22:35
Host: 10.0.0.2
Content-Type: application/json
 
{
"serial":"0000003048",
"mac":"F8:E7:B5:00:0B:EE",
"release":"1.1.12",
"dhcp":"off",
"ip":"10.0.0.1",
"netmask":"255.255.255.0",
"gateway":"10.0.0.2",
"dns":"1.1.1.1",
"ntp":"2.3.4.5",
"server":"10.0.0.3",
"port":"5060",
"stun":"",
"exten":"1000",
"password":"1234",
"hotline":"94",
"volmicrophone":"18",
"volspeaker":"20",
"keyboard":"true",
"http_server":"10.0.0.100",
"http_port":"7777",
"http_username":"admin",
"http_password":"1234",
"http_url":"",
"http_timeout":"30",
"http_retries":"1",
"http_ssl": "false",
"interface1_control_enable":"false",
"interface1_control_type":"1",
"interface1_control_time":"5",
"interface1_control_acc_time":"20",
"interface1_interlocking":"false",
"interface1_sensor_enable":"true",
"interface1_sensor_panic":"false",
"interface1_sensor_alarm":"0",
"interface1_sensor_breakin":"false",
"interface1_button_enable":"false",
"interface1_button_panic":"true",
"interface1_button_relay":"false",
"interface1_button_interface":"0",
"interface2_control_enable":"true",
"interface2_control_type":"1",
"interface2_control_time":"5",
"interface2_control_acc_time":"20",
"interface2_interlocking":"false",
"interface2_sensor_enable":"true",
"interface2_sensor_panic":"false",
"interface2_sensor_alarm":"0",
"interface2_sensor_breakin":"false",
"interface2_button_enable":"false",
"interface2_button_panic":"false",
"interface2_button_relay":"true",
"interface2_button_interface":"2"
}



[editar] 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));
?>




Voltar

Obtida de "https://wiki.utech.com.br/wiki/index.php?title=MPI/API/CmdGetConfig&oldid=8570"
Ferramentas pessoais
Espaços nominais

Variantes
Visualizações
Ações
Navegação
Ferramentas