Skip to main content

​
1. Get your API key

Go to the Yappr dashboard → Settings → API Keys → create a new key. Store it as an environment variable: 
export YAPPR_API_KEY="ypr_live_..."

​
2. Check your balance

curl -s https://api.goyappr.com/billing \
  -H "Authorization: Bearer $YAPPR_API_KEY" | jq .
You need at least $3 balance to place outbound calls. Top up in the dashboard under Settings → Billing.

​
3. Create an agent

curl -s -X POST https://api.goyappr.com/agents \
  -H "Authorization: Bearer $YAPPR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My First Agent",
    "system_prompt": "You are a friendly assistant. Greet the caller, ask how you can help, and keep responses brief.",
    "voice": "Kore",
    "language": "he",
    "greeting_message": "שלום! איך אוכל לעזור?"
  }' | jq .
Copy the id from the response — you’ll need it for the call.

​
4. Get a phone number

Search for available Israeli numbers: 
curl -s -X POST https://api.goyappr.com/phone-numbers/search \
  -H "Authorization: Bearer $YAPPR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit": 5}' | jq '.data[].phone_number'
Purchase one: 
curl -s -X POST https://api.goyappr.com/phone-numbers/purchase \
  -H "Authorization: Bearer $YAPPR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"phoneNumber": "+972551234567"}' | jq .
Purchasing a number starts a $15/month subscription charged to your saved card.

​
5. Make a call

curl -s -X POST https://api.goyappr.com/calls \
  -H "Authorization: Bearer $YAPPR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_id": "YOUR_AGENT_ID",
    "to": "+972501234567",
    "from": "+972551234567"
  }' | jq .
to and from must never be the same number — calling a number from itself creates an infinite loop.

​
6. Check call status

curl -s "https://api.goyappr.com/calls?limit=1" \
  -H "Authorization: Bearer $YAPPR_API_KEY" | jq '.data[0].status'

​
Next steps