Skip to content

PlaceCall

Place outbound calls, follow their progress, and read the outcome.

PlaceCall gives an agent a phone through one REST API. Use it to reach a business, track the call, and work with the structured result in your product.

Get an API key, then use the key delivered by email as the PLACECALL_API_KEY environment variable in your server or terminal. Keep it out of client-side code and public repositories. Authentication explains how API keys work.

Replace +1XXXXXXXXXX with a US number you own or are authorized to call, in E.164 format. The placeholder cannot be dialed. Describe the task in brief; submitting the request with a valid number places a real call.

Terminal window
curl --request POST https://api.voygr.tech/calls \
--header "X-API-Key: $PLACECALL_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"target_phone": "+1XXXXXXXXXX",
"brief": "Ask what time the business closes today. Thank them and end the call.",
"language": "en"
}'

Save the call ID from the response. Its location depends on whether the call starts immediately or is queued:

Response Call ID field
201 Created call.call_id
202 Accepted (queued) call_id

Use either ID with the same lookup below. A queued call has been accepted and is waiting to start.

Set CALL_ID to the returned ID, then request the call:

Terminal window
curl "https://api.voygr.tech/calls/$CALL_ID" \
--header "X-API-Key: $PLACECALL_API_KEY"

The lookup returns the call fields directly. Check status until it reaches completed, failed, or cancelled. Read outcome_type, outcome_summary, and transcript_full for the result. After completed, the outcome can arrive a little later; check again if outcome_type is still null.

For a step-by-step walkthrough, read Place a voice call. It covers writing the task, handling queued calls, reading the outcome, and retrying a request without placing a duplicate call.

The REST API reference describes requests, responses, and errors. The GitHub installation guide adds PlaceCall to your agent; installing it does not place a call.