Skip to main content
POST
/
outbound
/
agents
/
{agent_id}
/
outbound-config
Configure Outbound Calling
curl --request POST \
  --url https://api.example.com/outbound/agents/{agent_id}/outbound-config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "phone_numbers": [
    {
      "phone_number": "<string>",
      "display_name": "<string>",
      "is_default": false,
      "enabled": true,
      "daily_limit": 5000,
      "metadata": {}
    }
  ],
  "schedules": [
    {
      "name": "<string>",
      "time_windows": [
        {
          "start_time": "<string>",
          "end_time": "<string>",
          "days_of_week": [
            123
          ],
          "timezone": "UTC"
        }
      ],
      "enabled": true,
      "max_concurrent_calls": 1,
      "call_interval_seconds": 0,
      "respect_dnc": true,
      "respect_timezone": true
    }
  ],
  "default_schedule_id": "<string>"
}
'
import requests

url = "https://api.example.com/outbound/agents/{agent_id}/outbound-config"

payload = {
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phone_numbers": [
{
"phone_number": "<string>",
"display_name": "<string>",
"is_default": False,
"enabled": True,
"daily_limit": 5000,
"metadata": {}
}
],
"schedules": [
{
"name": "<string>",
"time_windows": [
{
"start_time": "<string>",
"end_time": "<string>",
"days_of_week": [123],
"timezone": "UTC"
}
],
"enabled": True,
"max_concurrent_calls": 1,
"call_interval_seconds": 0,
"respect_dnc": True,
"respect_timezone": True
}
],
"default_schedule_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
agent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
phone_numbers: [
{
phone_number: '<string>',
display_name: '<string>',
is_default: false,
enabled: true,
daily_limit: 5000,
metadata: {}
}
],
schedules: [
{
name: '<string>',
time_windows: [
{
start_time: '<string>',
end_time: '<string>',
days_of_week: [123],
timezone: 'UTC'
}
],
enabled: true,
max_concurrent_calls: 1,
call_interval_seconds: 0,
respect_dnc: true,
respect_timezone: true
}
],
default_schedule_id: '<string>'
})
};

fetch('https://api.example.com/outbound/agents/{agent_id}/outbound-config', 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/outbound/agents/{agent_id}/outbound-config",
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([
'agent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'phone_numbers' => [
[
'phone_number' => '<string>',
'display_name' => '<string>',
'is_default' => false,
'enabled' => true,
'daily_limit' => 5000,
'metadata' => [

]
]
],
'schedules' => [
[
'name' => '<string>',
'time_windows' => [
[
'start_time' => '<string>',
'end_time' => '<string>',
'days_of_week' => [
123
],
'timezone' => 'UTC'
]
],
'enabled' => true,
'max_concurrent_calls' => 1,
'call_interval_seconds' => 0,
'respect_dnc' => true,
'respect_timezone' => true
]
],
'default_schedule_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$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/outbound/agents/{agent_id}/outbound-config"

payload := strings.NewReader("{\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"phone_numbers\": [\n {\n \"phone_number\": \"<string>\",\n \"display_name\": \"<string>\",\n \"is_default\": false,\n \"enabled\": true,\n \"daily_limit\": 5000,\n \"metadata\": {}\n }\n ],\n \"schedules\": [\n {\n \"name\": \"<string>\",\n \"time_windows\": [\n {\n \"start_time\": \"<string>\",\n \"end_time\": \"<string>\",\n \"days_of_week\": [\n 123\n ],\n \"timezone\": \"UTC\"\n }\n ],\n \"enabled\": true,\n \"max_concurrent_calls\": 1,\n \"call_interval_seconds\": 0,\n \"respect_dnc\": true,\n \"respect_timezone\": true\n }\n ],\n \"default_schedule_id\": \"<string>\"\n}")

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

req.Header.Add("Authorization", "Bearer <token>")
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/outbound/agents/{agent_id}/outbound-config")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"phone_numbers\": [\n {\n \"phone_number\": \"<string>\",\n \"display_name\": \"<string>\",\n \"is_default\": false,\n \"enabled\": true,\n \"daily_limit\": 5000,\n \"metadata\": {}\n }\n ],\n \"schedules\": [\n {\n \"name\": \"<string>\",\n \"time_windows\": [\n {\n \"start_time\": \"<string>\",\n \"end_time\": \"<string>\",\n \"days_of_week\": [\n 123\n ],\n \"timezone\": \"UTC\"\n }\n ],\n \"enabled\": true,\n \"max_concurrent_calls\": 1,\n \"call_interval_seconds\": 0,\n \"respect_dnc\": true,\n \"respect_timezone\": true\n }\n ],\n \"default_schedule_id\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/outbound/agents/{agent_id}/outbound-config")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"phone_numbers\": [\n {\n \"phone_number\": \"<string>\",\n \"display_name\": \"<string>\",\n \"is_default\": false,\n \"enabled\": true,\n \"daily_limit\": 5000,\n \"metadata\": {}\n }\n ],\n \"schedules\": [\n {\n \"name\": \"<string>\",\n \"time_windows\": [\n {\n \"start_time\": \"<string>\",\n \"end_time\": \"<string>\",\n \"days_of_week\": [\n 123\n ],\n \"timezone\": \"UTC\"\n }\n ],\n \"enabled\": true,\n \"max_concurrent_calls\": 1,\n \"call_interval_seconds\": 0,\n \"respect_dnc\": true,\n \"respect_timezone\": true\n }\n ],\n \"default_schedule_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "agent_id": "<string>",
  "phone_numbers": [
    {
      "phone_number": "<string>",
      "display_name": "<string>",
      "is_default": false,
      "enabled": true,
      "daily_limit": 5000,
      "metadata": {}
    }
  ],
  "schedules": [
    {}
  ],
  "default_schedule_id": "<string>",
  "total_calls_today": 123,
  "calls_remaining_today": 123,
  "can_call_now": true,
  "next_available_time": "<string>"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Authorizations

Authorization
string
header
required

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

Path Parameters

agent_id
string<uuid>
required

Body

application/json

Complete outbound calling configuration.

agent_id
string<uuid>
required
phone_numbers
OutboundPhoneNumber · object[]
required
Minimum array length: 1
schedules
CallingSchedule · object[]
required
Minimum array length: 1
default_schedule_id
string | null

Response

Successful Response

Outbound configuration response.

agent_id
string
required
phone_numbers
OutboundPhoneNumber · object[]
required
schedules
Schedules · object[]
required
default_schedule_id
string | null
required
total_calls_today
integer
required
calls_remaining_today
integer
required
can_call_now
boolean
required
next_available_time
string | null
required