Skip to main content

How to direct users to a specific subbot and block via API

  • Updated

Introduction

This documentation teaches how to direct a user to a specific subbot (service) of a router and, optionally, to a determined block within that flow, using the Blip API. 

This action is useful for:

  • Performing tests and validations in specific points of the flow.

Important: For this process to work correctly, the option "Use Router context" must be activated in the flow settings of all subbots (services) linked to the router.

 

Directing to a subbot/service of a router (Master-State)

To move the customer to a subbot/service linked to the router, use the request below:

Request (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"
}

Where:

  • YOUR_ROUTER_TOKEN: Router authorization token (and not from the subbot).

  • contact.identity: User identifier in the router.

    • Example: In WhatsApp, it is the phone number + suffix (e.g.: 5511999999999@wa.gw.msging.net).

  • idDoSubbot: The identification ID of the destination subbot.

 

Directing to a specific block of the subbot (Change-User-State)

If you wish to direct the user to a specific block of the flow, use the Change User State request after executing the previous step.

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}}"
}

Where:

  • {{contact.identity}} and {YOUR_ROUTER_TOKEN}: Use the same data from the Master State request;

  • {{flow-identifier}}: It is the subbot's flow identifier. It can be located in the Builder's General Settings;

  • {{state-id}}: The ID of the destination block in the Builder.

    • How to find: Access the Builder, right-click the desired block, and select the option "Copy ID".

It is worth noting that the block to which the user will be directed will not display its content, executing only the exit conditions and actions, which will be validated after the user's response. 

For this reason, it is advisable to keep a user input button (user entry) in the block where the user's message will be received and without content (messages). Then create an exit condition to handle their response and direct them to the desired block. 

Example:

 

mceclip0.png
mceclip2.png

 

For more information, access the discussion about the subject in our community or the videos on our channel. 😃

Related articles