API ReferenceCalls
Place an outbound call
Place a test outbound call when is_test_call is true (uses BimpeAI test telephony infrastructure with capacity checks). When is_test_call is false, a configured live telephony channel is required.
Authorization
ApiKeyAuth AuthorizationBearer <token>
Team API key (prefix sk_). You may also send the key via X-Api-Key header.
In: header
Path Parameters
agentId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v1/console/agents/string/calls" \ -H "Content-Type: application/json" \ -d '{ "destination": "+2348012345678", "is_test_call": true }'{ "message": "Success", "data": { "status": "initiated", "call_id": "string", "detail": "string" }}{ "message": "telephony channel is not configured for this agent", "error": "Bad Request", "code": "channel_not_configured", "statusCode": 400, "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}{ "message": "Invalid API key.", "error": "Unauthorized", "code": "api_key_invalid", "statusCode": 401, "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}{ "message": "This API key is missing the required scope: conversations:read.", "error": "Forbidden", "code": "insufficient_scope", "statusCode": 403, "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}{ "message": "Agent not found", "error": "Not Found", "code": "not_found", "statusCode": 404, "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}