Calls

Initiate real-time outbound customer calls and fetch history logs, call metadata, and conversation transcripts.

List Calls

Retrieve a list of all current and historical call sessions along with brief transcript snippets.

<div class="endpoint-path">
  <span class="badge badge-get">GET</span>
  <code>/v1/calls</code>
</div>

<h3>Authorizations</h3>
<div class="param-row">
  <div class="param-name">X-API-Key</div>
  <div class="param-badges">
    <span class="badge-type">string</span>
    <span class="badge-loc">header</span>
    <span class="badge-req">required</span>
  </div>
  <div class="param-desc">Voice Platform authentication secret token key.</div>
</div>

<h3>Response</h3>
<span class="response-status-info">200 - application/json</span>

<div class="param-row">
  <div class="param-name">id</div>
  <div class="param-badges">
    <span class="badge-type">string</span>
    <span class="badge-req">required</span>
  </div>
  <div class="param-desc">Unique identifier of the call.</div>
</div>

<div class="param-row">
  <div class="param-name">phoneNumber</div>
  <div class="param-badges">
    <span class="badge-type">string</span>
    <span class="badge-req">required</span>
  </div>
  <div class="param-desc">E.164 formatted user phone number.</div>
</div>

<div class="param-row">
  <div class="param-name">status</div>
  <div class="param-badges">
    <span class="badge-type">string</span>
    <span class="badge-req">required</span>
  </div>
  <div class="param-desc">Status of call session (e.g. <code>completed</code>, <code>ringing</code>, <code>failed</code>).</div>
</div>

curl --request GET \
  --url https://api.branofy.cloud/v1/calls \
  --header 'X-API-Key: your_voice_api_secret_key'

<div class="response-preview">
  <div class="response-header">
    <span>Response</span>
    <span class="status-200">200 OK</span>
  </div>

{
  "data": [
    {
      "id": "call_98765",
      "agentId": "agent_12345",
      "phoneNumber": "+919876543210",
      "direction": "outbound",
      "status": "completed",
      "durationSeconds": 45,
      "costPaise": 150,
      "roomName": "room_live_abc",
      "idempotencyKey": null,
      "transcriptPreview": "Agent: Hello... User: Yes hi...",
      "transcriptRaw": [
        { "role": "agent", "text": "Hello, how can I help you today?" },
        { "role": "user", "text": "Yes hi, is this billing support?" }
      ]
    }
  ]
}

</div>

Dispatch Call

Trigger an outbound real-time call to connect a target customer phone number to a pre-configured voice agent.

<div class="endpoint-path">
  <span class="badge badge-post">POST</span>
  <code>/v1/agents/:agentId/calls</code>
</div>

<h3>Request Body</h3>
<div class="param-row">
  <div class="param-name">phone</div>
  <div class="param-badges">
    <span class="badge-type">string</span>
    <span class="badge-req">required</span>
  </div>
  <div class="param-desc">Target phone number in E.164 format.</div>
</div>

<div class="param-row">
  <div class="param-name">name</div>
  <div class="param-badges">
    <span class="badge-type">string</span>
    <span class="badge-opt">optional</span>
  </div>
  <div class="param-desc">Customer name for personalized conversation context.</div>
</div>

curl --request POST \
  --url https://api.branofy.cloud/v1/agents/agent_12345/calls \
  --header 'X-API-Key: your_voice_api_secret_key' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Ravi Kumar",
    "phone": "+919876543210"
  }'

<div class="response-preview">
  <div class="response-header">
    <span>Response</span>
    <span class="status-201">201 Created</span>
  </div>

{
  "callId": "call_98765",
  "roomName": "room_live_abc",
  "status": "dispatched"
}

</div>