Instalar el widget en la cuenta

Limitaciones
El método está disponible solo para administradores de la cuenta.

Parámetros de solicitud

Para instalar un widget, se deben pasar los parámetros obligatorios según la configuración del widget.

Los tipos de campos y sus formatos disponibles se detallan a continuación.

Parámetro	Tipo de dato	Descripción
text	string	El valor para este tipo se envía como una cadena de texto regular.
pass	string	El valor para este tipo se envía como una cadena de texto regular.
users	object	Un objeto que contiene el ID del usuario como clave y su número de extensión como valor.
users_lp	object	Un objeto que contiene el ID del usuario como clave y un objeto con el usuario y la contraseña como valor.
users_lp[{user_id}][login]	object	Usuario.
users_lp[{user_id}][password]	object	Contraseña.

Un ejemplo de la solicitud
En el siguiente ejemplo, pasaremos los campos requeridos para instalar el widget asterisk.
Los campos “login” y “script_path” son de tipo “text”.
El campo “password” es de tipo “pass”.
El campo “phones” es de tipo “users”.

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

Encabezado de tipo de datos cuando la solicitud es exitosa
Content-Type: application/hal+json.

Encabezado de tipo de datos en caso de un error
Content-Type: application/problem+json.

Parámetros de respuesta

El método retorna un objeto del widget instalado y sus configuraciones.

Parámetro	Tipo de dato	Descripción
id	int	ID del widget.
code	string	Código del widget.
version	string	Versión del widget.
rating	string\|float	Calificación del widget (el sistema de calificaciones aún no existe en Kommo).
settings_template	array	Un arreglo con los campos de configuración del widget.
settings_template[0]	obj	Campo de configuración del widget.
settings_template[0][key]	string	Clave del valor del campo.
settings_template[0][name]	string	Nombre del campo de configuración del widget.
settings_template[0][type]	string	Tipo de dato del campo de configuración (text, pass, custom, users o users_lp).
settings_template[0][is_required]	bool	Indica si completar el campo es obligatorio.
is_lead_source	bool	Indica si el widget puede configurarse como fuente de leads.
is_work_with_dp	bool	Indica si el widget está disponible en el Pipeline Digital.
is_crm_template	bool	Indica si el widget es una plantilla de CRM.
client_uuid	string\|null	UUID de la integración oAuth del widget.
is_active_in_account	bool	Indica si el widget está instalado en la cuenta.
pipeline_id	int	ID del pipeline donde el widget está configurado como fuente de leads.
settings	array	Configuraciones del widget. La clave solo se retorna cuando una integración solicita sus propias configuraciones.