Place Call

curl --request POST \
  --url https://api.example.com/api/v1/agents/{agent_id}/calls \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "phone_number": "+48123456789",
  "initial_context": {
    "first_name": "Anna"
  }
}
'

import requests

url = "https://api.example.com/api/v1/agents/{agent_id}/calls"

payload = {
    "phone_number": "+48123456789",
    "initial_context": { "first_name": "Anna" }
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({phone_number: '+48123456789', initial_context: {first_name: 'Anna'}})
};

fetch('https://api.example.com/api/v1/agents/{agent_id}/calls', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/agents/{agent_id}/calls",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'phone_number' => '+48123456789',
    'initial_context' => [
        'first_name' => 'Anna'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/agents/{agent_id}/calls"

	payload := strings.NewReader("{\n  \"phone_number\": \"+48123456789\",\n  \"initial_context\": {\n    \"first_name\": \"Anna\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/agents/{agent_id}/calls")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"phone_number\": \"+48123456789\",\n  \"initial_context\": {\n    \"first_name\": \"Anna\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/agents/{agent_id}/calls")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"phone_number\": \"+48123456789\",\n  \"initial_context\": {\n    \"first_name\": \"Anna\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "status": "initiated",
  "workflow_run_id": 123,
  "workflow_run_name": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Agents & Calls

Place Call

Place an outbound phone call with this agent.

The agent calls phone_number from its own number. Same checks and errors as the API trigger: 402 no credits, 403 outbound calling blocked for the organization or the number on its do-not-call list (do_not_call: ...), 409 outside calling hours (08:00-21:00 the recipient’s local time; Retry-After and detail.retry_at say when), 429 all outbound channels busy (Retry-After in seconds), 400 telephony not configured.

POST

api

agents

{agent_id}

calls

Place Call

curl --request POST \
  --url https://api.example.com/api/v1/agents/{agent_id}/calls \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "phone_number": "+48123456789",
  "initial_context": {
    "first_name": "Anna"
  }
}
'

import requests

url = "https://api.example.com/api/v1/agents/{agent_id}/calls"

payload = {
    "phone_number": "+48123456789",
    "initial_context": { "first_name": "Anna" }
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({phone_number: '+48123456789', initial_context: {first_name: 'Anna'}})
};

fetch('https://api.example.com/api/v1/agents/{agent_id}/calls', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/agents/{agent_id}/calls",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'phone_number' => '+48123456789',
    'initial_context' => [
        'first_name' => 'Anna'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/agents/{agent_id}/calls"

	payload := strings.NewReader("{\n  \"phone_number\": \"+48123456789\",\n  \"initial_context\": {\n    \"first_name\": \"Anna\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/agents/{agent_id}/calls")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"phone_number\": \"+48123456789\",\n  \"initial_context\": {\n    \"first_name\": \"Anna\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/agents/{agent_id}/calls")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"phone_number\": \"+48123456789\",\n  \"initial_context\": {\n    \"first_name\": \"Anna\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "status": "initiated",
  "workflow_run_id": 123,
  "workflow_run_name": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Your organization's API key (account in the bottom-left of the dashboard → Brosbots API).

Headers

authorization

string | null

X-API-Key

string | null

Path Parameters

agent_id

required

The agent's ID: the public agent_ + 20 characters identifier shown in the dashboard (recommended), or the legacy number. Both address the same agent.

Pattern: ^agent_[A-Za-z0-9]{20}$

Example:

"agent_7fK2mQ9xLp3RtV8wYb1N"

Body

application/json

phone_number

string

required

Number to call, in E.164 format.

Example:

"+48123456789"

initial_context

object | null

Variables the agent can use as {{initial_context.}} in its prompts. A sibling of phone_number, not a wrapper around it.

Example:

{ "first_name": "Anna" }

Response

Successful Response

status

string

required

Allowed value: "initiated"

workflow_run_id

integer

required

The conversation to read afterwards: GET /agents/{agent_id}/conversations/{conversation_id}.

workflow_run_name

string

required

Start

Endpoints

Place Call

Authorizations

Headers

Path Parameters

Body

Response