NovaSynth

Claim an inbound run

Reserves a Noveum phone number for this run and starts a NovaSynth listener. Returns status 'arming' once a number is reserved; poll the run until status is 'ready' before dialling. A claim without the idempotency key that armed the run returns its current status with reason 'already_claimed', and the caller must not dial it.

post/api/v1/novasynth/inbound/runs/{runId}/claim

Request

  • Base URL: https://dev.noveum.ai
  • URL: https://dev.noveum.ai/api/v1/novasynth/inbound/runs/{runId}/claim
  • Auth: API key in cookie apiKeyCookie and HTTP bearer

Path parameters

runIdstring required

Request body

profileobject
idempotencyKeystring

Response

Claim outcome

successboolean required
status'waiting' | 'arming' | 'ready' | 'in_progress' | 'completed' | 'failed' | 'expired' | 'cancelled' required
runIdstring
phoneNumberunknown
dialWindowClosesAtunknown
profileobject
personaNamestring
scenarioNamestring
retryAfterMsnumber
reasonstring

Changes

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