Limitações
O método está disponível apenas para administradores da conta.

Parâmetros da solicitação

Para instalar um widget, os parâmetros obrigatórios com base nas configurações do widget devem ser passados.

Os tipos de campo disponíveis e seus formatos estão listados abaixo.

Parâmetro	Tipo de dado	Descrição
text	string	O valor para este tipo é passado como uma string comum
pass	string	O valor para este tipo é passado como uma string comum
users	object	Um objeto contendo o ID do usuário como chave e seu número de ramal como valor
users_lp	object	Um objeto contendo o ID do usuário como chave e um objeto com login e senha como valor
users_lp[login]	object	Login do usuário
users_lp[password]	object	Senha do usuário

Exemplo de solicitação
No exemplo a seguir, passaremos os campos necessários para instalar o widget asterisk.
Os campos “login” e “script_path” têm o tipo “text”.
O campo “password” tem o tipo “pass”.
O campo “phones” tem o tipo “users”.

{
    "login": "exemplo",
    "password": "123456",
    "phones": {
        504141: "1039"    
    },
    "script_path": "https://example.com/"
}

Cabeçalho do tipo de dados quando a solicitação for bem-sucedida
Content-Type: application/hal+json

Cabeçalho do tipo de dados em caso de erro
Content-Type: application/problem+json

Parâmetros de resposta

O método retorna um objeto do widget instalado e suas configurações.

Parâmetro	Tipo de dado	Descrição
id	int	ID do widget
code	string	Código do widget
version	string	Versão do widget
rating	string\|float	Classificação do widget (o sistema de classificação ainda não existe na Kommo)
settings_template	array	Um array de campos de configurações do widget
settings_template[0]	obj	Campo de configuração do widget
settings_template[key]	string	Chave do valor do campo
settings_template[name]	string	Nome do campo de configuração do widget
settings_template[type]	string	Tipo de dado do campo de configuração do widget (text, pass, custom, users ou users_lp)
settings_template[is_required]	bool	Mostra se o preenchimento do campo é obrigatório
is_lead_source	bool	Mostra se um widget pode ser definido como uma fonte de leads
is_work_with_dp	bool	Mostra se um widget está disponível no Digital Pipeline
is_crm_template	bool	Mostra se um widget é um modelo de CRM
client_uuid	string\|null	UUID da integração oAuth do widget
is_active_in_account	bool	Mostra se o widget está instalado na conta
pipeline_id	int	ID do pipeline onde um widget está definido como fonte de leads
settings	array	Configurações do widget. A chave é retornada apenas quando uma integração solicita suas próprias configurações

200200

400400

401401

404404