Como direcionar usuários para um subbot e bloco específico via API

1. Introdução
2. Direcionar para um subbot/serviço de um roteador (Master State)
3. Direcionar para um bloco específico do subbot (Change User State)

Introdução

Esta documentação ensina como direcionar um usuário para um subbot (serviço) específico de um roteador e, opcionalmente, para um bloco determinado dentro desse fluxo, utilizando a API da Blip.

Essa ação é útil para:

• Realizar testes e validações em pontos específicos do fluxo.
   

Importante: Para que este processo funcione corretamente, a opção "Utilizar o contexto do Roteador" deve estar ativada nas configurações de fluxo de todos os subbots (serviços) vinculados ao roteador.

Direcionar para um subbot/serviço de um roteador 

(Master-State)

Para mover o cliente para um subbot/serviço vinculado ao roteador, utilize a requisição abaixo:

Requisição (Master State)

POST https://{{contractid}}.http.msging.net/commands HTTP/1.1
Content-Type: application/json
Authorization: Key {YOUR_ROUTER_TOKEN}
{
"id": "{{$guid}}",
"to": "postmaster@msging.net",
"method": "set",
"uri": "/contexts/{{contact.identity}}/Master-State",
"type": "text/plain",
"resource": "{{idDoSubbot}}@msging.net"
}

Onde:

• YOUR_ROUTER_TOKEN: Token de autorização do Roteador (e não do subbot).
  Dica: Consulte a documentação Como encontrar a API-KEY do meu bot?

• contact.identity: Identificador do usuário no roteador 
  Exemplo: No WhatsApp, é o número do telefone + sufixo (ex: 5511999999999@wa.gw.msging.net).

• idDoSubbot: O ID de identificação do subbot de destino.
  Dica: Consulte a documentação Como encontrar seu ID caso precise localizar essa informação.

   

Direcionar para um bloco específico do subbot 

(Change-User-State)

Se desejar direcionar o usuário para um bloco específico do fluxo, utilize a requisição Change User State após a execução do passo anterior.
 

POST https://{{contractid}}.http.msging.net/commands HTTP/1.1
Content-Type: application/json
Authorization: Key {YOUR_ROUTER_TOKEN}
{
  "id": "{{$guid}}",
  "to": "postmaster@msging.net",
  "method": "set",
  "uri": "/contexts/{{contact.identity}}/stateid@{{flow-identifier}}",
  "type": "text/plain",
  "resource": "{{state-id}}"
}

Onde:

• {{contact.identity}} e {YOUR_ROUTER_TOKEN}: Utilize os mesmos dados da requisição Master State;
• {{flow-identifier}}: É o identificador do fluxo do subbot. Pode ser localizado nas Configurações gerais do Builder;
• {{state-id}}: O ID do bloco de destino no Builder.
  Como encontrar: Acesse o Builder, clique no bloco desejado com o botão direito do mouse e selecione a opção "Copiar ID"’

Vale ressaltar que o bloco para o qual o usuário será direcionado, não exibirá seu conteúdo, executando somente as condições e ações de saída, que serão validadas após a resposta do usuário.

Por este motivo, é aconselhável manter um botão de input do usuário (entrada do usuário) no bloco onde será recebida a mensagem do usuário e sem conteúdo (mensagens). Logo criar uma condição de saída para tratar a resposta dele e direcionar para o bloco desejado.

Exemplo:

Para mais informações, acesse a discussão sobre o assunto em nossa comunidade ou os vídeos no nosso canal. 😃