campaigns

Start Campaign Test Run

Changed on

Save the reviewed cases as a run and queue it: the calls are placed in the background. 409 while the agent already has a run going; 502 when the run could not be queued (it is then errored, so nothing is left hanging).

post/api/v1/campaigns/{campaign_id}/test-runs

Request

  • Base URL
    https://api.getanana.com (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Path parameters

campaign_idstring uuid required

Request body

voice_agent_idstring uuid required

Response

Successful Response

idstring uuid required
voice_agent_idstring uuid required
campaign_idstring uuid nullable required
status'queued' | 'running' | 'completed' | 'errored' required

queued: saved, not yet handed to the provider. running: the provider accepted it and calls are being placed. completed: every case has a verdict. errored: the run could not be submitted or stalled; its error says why.

errorstring nullable required
max_call_secondsinteger required
created_atstring date-time required
submitted_atstring date-time nullable required
finished_atstring date-time nullable required
created_by_user_idstring uuid nullable required

Changes