Have the agent call a phone number as a live test

Calls you back from your own agent - the same price and the same rules as POST /v1/calls, no discount and no special rate. An agent on volai's own voice engine calls even WITHOUT an assigned number - from the shared volai line, so the recipient sees volai's number, not yours. Assign an existing agent its own number through PATCH /v1/numbers/{e164} (routing agent) or the numberE164 field on the agent (POST/PATCH /v1/agents), or in the portal's Numbers section.

post/v1/agents/{id}/test-call

Request

  • Base URL: https://volai.cz
  • URL: https://volai.cz/v1/agents/{id}/test-call
  • Auth: HTTP bearer

Path parameters

idstring required

Headers

Idempotency-Keystring

Optional key for one logical request. Its scope is global to this API key, independent of the HTTP method, path, or body: use a new value for every distinct logical action across all endpoints and request bodies, and reuse it only to retry the exact same logical request. Reusing a non-blank key within 24 hours returns the stored response; a concurrent request with the same key returns 409 idempotency_in_progress. A missing or whitespace-only value disables idempotency.

Request body

tostring required

Phone number to receive a real, billed test call from the published agent. This does not test an unpublished draft.

Response

Created test call

idstring required
status'initiated' | 'ringing' | 'in_progress' | 'completed' | 'failed' | 'missed' | 'no_answer' required

Changes

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