Skip to navigation

Get outbound call

Returns the state of an outbound call started with POST /calls: whether it is still dialing, was answered, went to voicemail or failed, and, once evaluated, whether the agent reached its goal. When call_id is set, the full call is at GET /calls/{call_id}. Required scope: calls:read. With a test key (vx_test_) it behaves exactly as with a live key and consumes nothing.

Authentication

AuthorizationBearer
API key created by an Owner or Admin of the organization. Never in the query string.

Path parameters

outbound_call_idstringRequiredformat: "uuid"

Id of the outbound call, as returned by POST /calls.

Headers

VoxAI-VersionenumOptional

API version for this request; defaults to the version the key is pinned to.

Allowed values:

Response

Successful response.
object"outbound_call"

Always outbound_call.

idstringformat: "uuid"

Id of the outbound call: use it with GET /outbound-calls/{outbound_call_id}.

statusenum

dialing: the number is being called. answered: a person answered. voicemail_left: an answering machine answered and the agent left a message. no_answer: nobody answered, or an automatic message or menu answered (it may be retried). invalid_number: the number does not exist or is a fax. completed: the call ended normally. failed: the call could not be made. missing_variables: the agent needed a variable that was not given. simulated: only with a test key, nothing was dialed. uncertain (HTTP 202): the telephone network did not answer clearly, the call may have started and is NOT repeated; read the call again (it keeps saying uncertain until the call is closed or marked failed) before deciding anything.

agent_idstring
The agent that makes the call.
call_idstring or null

Id of the call in GET /calls, once the call has started; null before.

simulatedboolean

true with a test key: nothing was dialed and the id does not exist (reading it gives 404).

goal_achievedboolean or null

Whether the agent reached the goal of the call, from its report card. null until the call has been evaluated.

created_atdatetime
When the call was requested, ISO 8601 UTC.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error