get
https://{subdomain}.kommo.com/api/v4/bots/
Este método permite obter um Salesbot pelo seu ID.
Limitações
O método está disponível para todos os usuários da conta.
Parâmetros "with"
| Parâmetro | Descrição |
|---|---|
| favorite | Adiciona a propriedade is_favorite á resposta, que define se o Salesbot foi adicionado aos favoritos do usuário atual. |
Cabeçalho do tipo de dado para quando a requisição é bem-sucedida
Content-Type: application/hal+json
Cabeçalho do tipo de dado em casos 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 indica que o Salesbot está no modo de edição visual; false indica que o Salesbot está no modo de edição em código/texto. |
| type_functionality | string | Tipo de funcionalidade do Salesbot: regular – Salesbot de fluxo de trabalho básico, greeting – Bot de mensagem de boas-vindas, marketing – Transmissão de mensagens, nps – Bot de pesquisa de NPS. |
| settings | obj | Configurações do Salesbot. |
| settings[active] | bool | Define se o Salesbot está ativo. |
| is_favorite | bool | Necessária definição no parâmetro with. Define se o Salesbot foi adicionado aos favoritos. |
