get
https://{subdomain}.kommo.com/api/v4/bots
O método permite obter uma lista de Salesbots existentes na conta
Limitaçõess
O método está disponível para todos os usuários da conta.
Parâmetros "with"
| Parâmetro | Descrição |
|---|---|
| Favorito | Adiciona a propriedade is_favorite à resposta, que define se o Salesbot está adicionado aos favoritos do usuário atual. |
Cabeçalho do tipo de dados quando a requisição é 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
| Parâmetro | Tipo de dado | Descrição |
|---|---|---|
| id | int | ID do salesbot |
| name | string | Nome do salesbot |
| is_visual_editor | bool | Define o tipo de editor do salesbot. true significa que o salesbot está com o editor visual ativado, false significa que o salesbot está em modo de texto (código). |
| type_functionality | string | Tipos de funcionalidade do salesbot: regular – Fluxo básico de um salesbot, greeting – bot de boas-vindas, marketing – bot para transmissão de mensagens, nps – bot para pesquisa de nps. |
| settings | obj | Configurações do Salesbot. |
| settings[active] | bool | Define se o Salesbot está ativo. |
| is_favorite | bool | O parâmetro with é necessário para a requisição. Defines se o salesbot está entre os favoritos do usuário. |