Skip to Content
CallMitraDocs
API referenceAgents

Place a test call

Calls `destination` from one of your numbers so you can hear the agent. Not a campaign call and not billed; free plans have a test-call allowance.

POST
/api/v1/agents/{agent_id}/test-call

Calls destination from one of your numbers so you can hear the agent. Not a campaign call and not billed; free plans have a test-call allowance.

Authorization

headerX-API-Key<token>

Create in the console: Settings → API & webhooks.

Path Parameters

agent_id*Agent Id

Request Body

application/json
  1. body

Place a test call from one of your numbers.

destination*Destination

E.164 or local number to dial.

Length3 <= length
dynamicValues?

Values for the script's placeholders, e.g. {"name": "Asha"}.

phoneNumberId*Phonenumberid

Your phone number id to call from.

Length1 <= length

Response Body

OK

application/json
  1. response

The test call was placed.

callId?|

Id of the call; read it with getCall.

message?|

Human-readable status.

phoneNumber?|

Number being dialed, in E.164 format.

success?Success

Always true on success.

Defaulttrue
[key: string]?any
Example Request
curl -X POST 'https://api.callmitra.ai/api/v1/agents/string/test-call' \  -H 'Content-Type: application/json' \  -d '{  "destination": "+919812345678",  "phoneNumberId": "8a1d4c2e-0b7f-4e9a-9c3d-5f6e7a8b9c0d"}'
Example Response
{  "callId": "c2b7e0d4-1f3a-4b5c-8d9e-0a1b2c3d4e5f",  "message": "Test call initiated",  "phoneNumber": "+919812345678",  "success": true}