Flows

Deliver a reply as though the recipient sent it

Sandbox keys only. This is how you exercise a flow — every branch, follow-up, closing and opt-out — without creating an agent at Google (irreversible) and waiting weeks for a carrier launch.

It runs the real inbound path rather than a lookalike, so what you see in sandbox is what the webhook will do. Refused on live keys: fabricating a message from a real person writes words they never sent into their transcript and consent record.

post/v1/conversations/{id}/simulate-inbound

Request

  • Base URL: https://api.cadencercs.com
  • URL: https://api.cadencercs.com/v1/conversations/{id}/simulate-inbound
  • Auth: HTTP bearer

Path parameters

idstring required

Conversation id.

Request body

textstring

Something the recipient typed, e.g. "182.4", "STOP" or "START".

optionIndexnumber

A chip they tapped, 1-based against the reply chips currently on offer. Delivered as a real postback, so handler code branching on intent can be exercised before live traffic. Out of range is refused, with the offered chips in the body. Action chips have no index — use postbackData for those.

postbackDatastring

A chip from any recent message, named by the slug we generated when we sent it. This is how you rehearse a late tap: someone reads the morning message and answers after the next one has already gone out. optionIndex cannot express that — it means "a chip on the newest message" — and a late tap behaves differently enough to be worth a test of its own. An unknown slug is refused with the ones we do know.

Response

What actually happened, so you can assert on it rather than poll.

okboolean required
deliveredstring required

The text that was delivered — for a chip tap, its label.

as'text' | 'postback'
optionIndexnumber

Echoed when a chip was tapped.

statestring required

The conversation's state afterwards.

lastOutboundstring nullable

What Cadence sent back, as the recipient would have received it on their channel — the numbered fallback on the SMS leg.

lastOutboundComposedstring nullable

The same message as composed, before fallback rendering.

Changes

No recorded changes to this operation across all 1 revision of this API.