Skip to main content
POST
/
calls
Create outbound call
curl --request POST \
  --url https://api.goyappr.com/calls \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "to": "+972501234567",
  "from": "+972551234567",
  "variables": {
    "callerName": "David Cohen",
    "orderNumber": "ORD-1234"
  }
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "queued"
}

Authorizations

​
Authorization
string
header
required

Your Yappr API key (e.g. ypr_live_...). Generate one in the dashboard under Settings → API Keys.

Body

application/json
​
agent_id
string<uuid>
required
​
to
string
required

Destination phone number. Must be different from from.

Example:

"+972501234567"

​
from
string
required

Your active Yappr phone number.

Example:

"+972551234567"

​
variables
object

Optional key-value pairs injected into the agent's system prompt.

Example:
{
  "callerName": "David Cohen",
  "orderNumber": "ORD-1234"
}

Response

Call queued

​
id
string<uuid>
​
status
string
Example:

"queued"