Test a message
Simulate a first message and see which task the inbound router would pick, without sending anything or saving a lead.
- The router must be on (
is_active: true). Otherwise the API returns 400inbound_router_inactive. channelacceptswhatsapp,webchat,email, orapi.- Each call is a new first message. Earlier tests are not remembered. When the result has a
clarify_question, that is what the agent would ask the lead. - Rules on
phoneandmetadatause thephoneandmetadatayou send in the body. The test sends no email or tags, so rules onemailortagsfind no value, and onlynot_existsmatches them. - MCP keys need
workflows:read. The test does not needconfirm.
Authorizations
API key for authentication. Keys are prefixed with nxr_live_.
Path Parameters
Agent ID (master_workflow in the API). A malformed ID returns 400 invalid_group_id.
Body
Channel the message arrives on.
whatsapp, webchat, email, api The lead's first message.
1Optional phone number of the simulated lead. Rules on phone check this value.
Optional metadata of the simulated lead. Rules on metadata.<key> check these values.
Response
Result of the simulation.
true Step that decided. Same values as layer in List decisions.
What the AI step did: ROUTE picked a task, ASK_AGAIN asks a clarifying question, FALLBACK used the default task. null when another step decided.
ROUTE, ASK_AGAIN, FALLBACK, null Task that would answer. null while a clarifying question is pending.
Question the agent would ask the lead.
true when the clarifying questions ran out and the default or best task was used.