Skip to main content
POST
/
call
Initiate call
curl --request POST \
  --url https://app.freyavoice.ai/api/v2/call \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phoneNumber": "<string>",
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "callerNumber": "<string>",
  "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "properties": {},
  "externalCallId": "<string>",
  "assistantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "entityVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "skipE164Normalization": true
}
'
{
  "success": true,
  "data": {
    "message": "<string>",
    "result": {
      "success": true,
      "callId": "<string>",
      "jobUuid": "<string>",
      "job_uuid": "<string>",
      "message": "<string>",
      "error": "<string>"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
phoneNumber
string
required

Customer/destination phone number

​
workspaceId
string<uuid>
required

Workspace ID

​
callerNumber
string

Caller ID phone number (used to look up SIP/trunk config). Required for regular calls; campaign calls derive it from the campaign

​
campaignId
string<uuid>

Campaign ID (presence triggers campaign call flow)

​
properties
object

Custom properties to pass to the agent

​
externalCallId
string

External call ID for client-side tracking

Required string length: 1 - 255
​
assistantId
string<uuid>

Override campaign assistant ID

​
entityVersionId
string<uuid>

Version ID of the entity (agent/workflow) active during the call

​
skipE164Normalization
boolean

Skip E.164 normalization of the phone number (default: false)

Response

Call initiated

​
success
enum<boolean>
required
Available options:
true
​
data
object
required