A Voiceflow API key authorized for project:READ and project.versions:READ on the connection's assigned agent. Keep the key server-side. SIP digest credentials and Socket.IO session keys do not authorize this request.
Purpose
This contract applies to connected provider phone numbers. SIP uses its own outbound operation. Use Start an outbound call for the complete task.
Authentication
Use a Voiceflow API key with access to read the assigned agent and its versions. SIP digest credentials and socket session keys do not authorize this request. Keep the key on your server.
Operations
Authentication
Path parameters
ID of an assigned phone number, not the E.164 number or project ID.
Request body
Destination in E.164 format.
Initial agent variables. Values must be strings.
Answering-machine detection. Twilio ends the call on machine_end_beep or fax; Telnyx requests detect_beep. The inspected Vonage consumer does not apply this field. This is not a configurable voicemail message.
Provider-specific options consumed by Twilio. No common provider-independent option schema. Omit unless using a verified Twilio option.
Response
Dial request accepted. Empty response body.
Error 400
Invalid destination; connection not assigned; outbound settings incomplete; or connection not ready for outbound calls. Check the destination and saved connection settings before retrying.
Error 402
Workspace credit limit reached.
Error 404
Phone number not found.
Error 429
Production concurrency limit reached. Wait for capacity before retrying.
Provider differences
Provider-specific overrides are consumed by Twilio; they are not a portable configuration object. A successful request does not establish that a human answered. Voiceflow-provisioned numbers also support outbound calling.
Minimal request
Errors and recovery
A 400 reports an invalid destination, connection or provider failure; 402 means workspace credits are exhausted; 429 means production concurrency is full. An HTTP timeout after sending does not prove the provider failed to dial. Inspect the call before retrying.