trigger_flow
Starts/dispatches an existing conversation flow for a specific recipient phone number (E.164 format, e.g. +447700900123), optionally passing initial {{variable}} context.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"flowIdentifier": "<flowIdentifier>",
"recipient": "<recipient>"
},
"name": "trigger_flow"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| isTest | No | Optional test flag for RBM test devices (default false). | |
| agentId | No | Agent ID or display name. Defaults to the active agent in context. | |
| recipient | Yes | Recipient phone number in E.164 format (e.g. '+447700900123'). | |
| flowIdentifier | Yes | Name or ID of the flow to start. | |
| initialVariables | No | Optional key-value variables injected into flow context (e.g. { "first_name": "Alex" }). |