Confirmação de execução do bloco do widget SalesBot

O método recebe dados após a execução bem-sucedida do bloco do widget no SalesBot e continua o fluxo de trabalho do Bot.

🚧

Limitações

  • O método está disponível para administradores da conta.
  • O número máximo de manipuladores que podem ser passados no parâmetro "execute_handlers" é 10.
  • Se um manipulador "show" for fornecido em "execute_handler", o parâmetro value não deve exceder 80 caracteres.
  • O número máximo de botões que podem ser passados em "execute_handler" é 25

Request parameters

Se o widget precisar passar algum dado, ele deve ser inserido no campo "data" como um objeto.

Se o widget precisar executar uma ação antes que o bot continue funcionando, você pode passar uma lista de manipuladores para o parâmetro "execute_handlers". Os manipuladores passados são executados um por um.

Exemplo de solicitação

No exemplo a seguir, passaremos um campo "status" para o widget. O widget poderá obter o valor do campo ("success") em qualquer bloco após o "widget_request" pela chave {{json.status}}. Também instruiremos o bot do widget a exibir texto, botões, botões com links e ir para a etapa 5 do bot do widget.

{ "data": { "status": "success" }, "execute_handlers": [ { "handler": "show", "params": { "type": "text", "value": "Seu texto" } }, { "handler": "show", "params": { "type": "buttons", "value": "Pressione o botão", "buttons": [ "Botão 1", "Botão 2", "Botão 3", "Botão 4", ... "Botão 25" ] } }, { "handler": "show", "params": { "type": "buttons_url", "value": "Botões com links", "buttons": [ "https://kommo.com" ] } }, { "handler": "goto", "params": { "type": "question|answer|finish", "step": 5 } } ] }
Path Params
int32
required

ID do Bot

int32
required

Continue ID. O sistema o passa para o webhook

string
required

Tipo de bot

Body Params
json

Dados para o widget. Podem ser adquiridos no código do SalesBot com a chave {{json.OBJECT_KEY_NAME}}, onde OBJECT_KEY_NAME é o nome do campo passado em “data”.

json

Atualmente, os seguintes tipos de manipuladores são suportados: show, goto.

Responses

Language
Credentials
OAuth2
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json