The Make a Call endpoint allows you to programmatically trigger an outbound call to any phone number using a specific voice assistant. This is useful for automated notifications, appointment reminders, or immediate lead qualification.
Endpoint
POST /admin/assistant/call
Request Flow
Before the call is placed, the system validates your workspace, checks the assistant’s availability, and then initiates the telephony connection.
Request Parameters
| Header | Type | Required | Description |
|---|
workspace | string | Yes | Your unique workspace ID. |
organization | string | Yes | Your organization ID. |
Content-Type | string | Yes | Must be application/json. |
Authorization | string | Yes | Bearer token for authentication. |
Body Parameters
| Parameter | Type | Required | Description |
|---|
assistant_id | string | Yes | The unique identifier of the assistant to place the call. |
to_number | string | Yes | The phone number to call in E.164 format (e.g., +919723067241). |
Code Examples
curl --location 'https://api.voice-agents.miraiminds.co/v1/admin/assistant/call' \
--header 'workspace: 68d63c242cd956c2bb41cd3a' \
--header 'organization: 68d63c242cd956c2bb41cd12' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <YOUR_TOKEN>' \
--data '{
"assistant_id": "68c128a658cd7d0668bce78d",
"to_number": "+919723067241"
}'
Response
Returns a JSON object containing the status of the call request.
Success Response (200 OK)
{
"success": true,
"message": "Call initiated successfully",
"data": {
"call_id": "c_1234567890",
"status": "queued",
"assistant_id": "68c128a658cd7d0668bce78d",
"to_number": "+919723067241"
}
}
Common Errors
400 Bad Request: Missing to_number or invalid assistant_id.401 Unauthorized: Invalid or missing workspace/organization/Authorization headers.404 Not Found: Assistant ID does not exist in the specified workspace.