get https://{subdominio}.kommo.com/api/v4/sources
El método permite obtener una lista de las fuentes de integración.
Limitaciones
El método está disponible de acuerdo con los permisos del usuario.
Tipo de autorización
OAuth 2.0 con Token de acceso/Token de larga duración.
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
Parámetro | Tipo de dato | Descripción |
---|---|---|
id | int | ID de la fuente. |
name | string | Nombre de la fuente. |
pipeline_id | int | ID del pipeline. El pipeline puede estar archivado. |
external_id | string | ID externo de la fuente del lado de la integración. |
default | bool | Un valor booleano que indica si esta fuente es la fuente predeterminada. Puede ser null. |
services | array | Un arreglo de servicios asociados con la fuente. Los datos de este arreglo se utilizan para mostrar el botón de chat web. |
services[type] | string | Tipo de servicio. Puede estar vacío. |
services[0][params] | object | Un objeto con la configuración de la fuente. |
services[0][params][waba] | bool | Define si la fuente es WhatsApp oficial. Debe añadirse para permitir que Salesbot trabaje con plantillas de WhatsApp aprobadas en el nuevo paso "Mensaje". Este campo es opcional. |
services[0][params][is_supports_list_message] | bool | Muestra si la fuente admite el paso "List Message" en Salesbot. Debe añadirse para mostrar un nuevo paso de "List Message" en Salesbot. |
services[pages] | string | Contiene una lista de elementos que se pueden seleccionar al configurar el botón de chat web (botones para el sitio web). |
services[0][pages][0][name] | string | El nombre del ítem que se muestra al usuario en la lista desplegable al configurar un botón en el sitio. |
services[0][pages][0][id] | string | Identificador del ítem en la lista desplegable (no se muestra al cliente ni al usuario). |
services[0][pages][0][link] | string | El ID del usuario que se indicará en el botón del messenger y al que el cliente escribirá en la página del sitio. Por ejemplo, para WhatsApp, el enlace se generará de la siguiente manera: https://wa.me/{Specified phone number} . |
origin_code | string null | Código del canal principal de la fuente. Este canal de chat se utilizará al iniciar el chat. El campo es opcional, pero si se especifica, no debe estar vacío, contener solo números, tener comillas dobles o superar los 20 caracteres. |