Network-based calls

info

BASE_URL for this API is https://api.frejun.com/api/v1.

Network-based calls follow a 2-legged flow.

1. FreJun makes the first call to the User.
2. User answers the call.
3. The second call is made to the intended callee.

tip

Network-based calls can be useful when the user doesn't have a stable internet connection for VoIP calls.

note

To make and receive network-based calls, users must have set their real number (the phone number that will be involved in the call). It can be configured via:

• The Connected to field in Settings → Calling & SMS
• The Update User API

Initiating a Network-based call

POST /integrations/create-call/

Headers

Name	Value
Authorization	Bearer Access Token
Content-Type	application/json

Payload

user_email required	string <email> Email of FreJun user
candidate_number required	string Number to Dial (E.164 format)
virtual_number	string Virtual Number to use (E.164 format). If not provided, the default virtual number will be used.
candidate_name	string Callee Name
candidate_id	string Custom Metadata Field
job_id	string Custom Metadata Field
transaction_id	string Custom Metadata Field

Response

{
 "success": true,
 "message": "Successfully initiated the call",
 "data": {
  "status": 4,
  "info": "on-going",
  "event_id": 123,
  "call_id": 456,
  "candidate_name": "John Doe"
 }
}