Sign in

v2

latestOpenAPI 3.1.02026-08-07750280.6 KB
Playground

Make a test outbound call

Make a test outbound call to a verified phone number for your organization.

This endpoint is designed for testing your agent configuration before
deploying to production. The call will be made to one of your organization's
verified phone numbers.

## Requirements
- API Key with WRITE permission and MAKE_OUTBOUND_CALLS tier permission
- Agent must be of type OUTBOUND
- Agent must have all required fields configured (voice, language, etc.)
- Target phone number must be in your organization's verified phone numbers list

## Use Cases
- Test agent configuration before going live
- Verify agent voice and conversation flow
- Test custom context and prompts
- Quality assurance for agent updates

## Response
Returns a task ID that can be used to track the call execution status.
The call will be initiated asynchronously, and you should receive the call shortly.
post/playground/test-call

Request body

agent_idstring uuid required

ID of the outbound agent to use for the test call

to_numberstring required

Phone number to call (must be in your organization's verified phone numbers list)

Example request

{
  "agent_id": "550e8400-e29b-41d4-a716-446655440000",
  "to_number": "+1234567890"
}

Response

Test call successfully queued

okboolean required

Example response

{
  "data": {
    "agent_id": "550e8400-e29b-41d4-a716-446655440000",
    "from_number": "+1987654321",
    "message": "Test call initiated from +1987654321 to +1234567890",
    "status": "queued",
    "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "to_number": "+1234567890"
  }
}