Agent testing

Pick a Next Steps option or submit its form in a test conversation.

Acts on what the website shows once the conversation reaches Next Steps. select_option clicks a choice button and returns that option's form. Selections and confirmation surfaces are response-only (selectionPersisted: false); a later read shows the default first option. surface.coverage states which panels are described; live delivery and payment processing are never verified. submit_form fills in and submits it, using the field keys from the surface's form: the real submit path runs with every effect simulated (no lead, email, booking, order or pay link), and the result's surface shows what follows (confirmation, sign-up or pay link, or checkout). Free: no model call. Repeating a submit is safe, since nothing is delivered. Errors: 400 validation_error / submit_failed, 403 dashboard_test_conversation, 404 option_not_found, 409 next_steps_not_shown, 410 conversation_expired, 422 not_a_visual_channel (WhatsApp has no buttons or forms), 503 surface_unavailable.

post/api/v1/agents/{agent}/test-conversations/{conversationId}/actions

Request

  • Base URL: https://www.cysora.com
  • URL: https://www.cysora.com/api/v1/agents/{agent}/test-conversations/{conversationId}/actions
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Request body

type'select_option' | 'submit_form' required

select_option clicks a Next Steps choice button and returns that option's form; submit_form fills in and submits it (simulated, nothing delivered).

optionstring required

The Next Steps option, e.g. option_2.

valuesobject

submit_form only. Field values by key, as in the surface's form fields (first_name, last_name, email, phone, company, custom1-3).

locationstring

submit_form only. The location picked, when the option offers a choice.

Response

Success.

Changes

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