Outbound - Feather

POST

voice

outbound

Outbound

curl --request POST \
  --url https://api-sandbox.featherhq.com/v1/voice/outbound \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "from_phone_number_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "to_phone_number": "<string>",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "context_variables": {},
  "idempotency_key": "<string>",
  "instant": false,
  "expires_in_seconds": 1296000,
  "override_pause": false
}
'

import requests

url = "https://api-sandbox.featherhq.com/v1/voice/outbound"

payload = {
    "from_phone_number_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "to_phone_number": "<string>",
    "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "agent_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "context_variables": {},
    "idempotency_key": "<string>",
    "instant": False,
    "expires_in_seconds": 1296000,
    "override_pause": False
}
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({
    from_phone_number_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    to_phone_number: '<string>',
    agent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    team_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    agent_revision_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    context_variables: {},
    idempotency_key: '<string>',
    instant: false,
    expires_in_seconds: 1296000,
    override_pause: false
  })
};

fetch('https://api-sandbox.featherhq.com/v1/voice/outbound', 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-sandbox.featherhq.com/v1/voice/outbound",
  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([
    'from_phone_number_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'to_phone_number' => '<string>',
    'agent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'team_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'agent_revision_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'context_variables' => [
        
    ],
    'idempotency_key' => '<string>',
    'instant' => false,
    'expires_in_seconds' => 1296000,
    'override_pause' => false
  ]),
  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-sandbox.featherhq.com/v1/voice/outbound"

	payload := strings.NewReader("{\n  \"from_phone_number_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"to_phone_number\": \"<string>\",\n  \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"team_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"agent_revision_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"context_variables\": {},\n  \"idempotency_key\": \"<string>\",\n  \"instant\": false,\n  \"expires_in_seconds\": 1296000,\n  \"override_pause\": false\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-sandbox.featherhq.com/v1/voice/outbound")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"from_phone_number_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"to_phone_number\": \"<string>\",\n  \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"team_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"agent_revision_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"context_variables\": {},\n  \"idempotency_key\": \"<string>\",\n  \"instant\": false,\n  \"expires_in_seconds\": 1296000,\n  \"override_pause\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.featherhq.com/v1/voice/outbound")

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  \"from_phone_number_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"to_phone_number\": \"<string>\",\n  \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"team_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"agent_revision_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"context_variables\": {},\n  \"idempotency_key\": \"<string>\",\n  \"instant\": false,\n  \"expires_in_seconds\": 1296000,\n  \"override_pause\": false\n}"

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

{
  "agent_name": "<string>",
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "queued": false,
  "room_name": "<string>",
  "dispatch_id": "<string>",
  "agent_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_revision_name": "<string>",
  "revision_source": "override"
}

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

Authorizations

x-api-key

string

header

required

Body

application/json

from_phone_number_id

string<uuid>

required

Org-scoped phone number id to dial FROM. Must have an outbound_call agent attached so a SIP outbound trunk has been provisioned.

to_phone_number

string

required

E.164 phone number to dial, e.g. +15555550123

Pattern: ^\+[1-9]\d{6,14}$

agent_id

string<uuid> | null

Optional: dial AS this specific agent. Must already be attached to the from-number as an outbound_call binding. Provide this XOR team_id; omit both to let the backend pick a bound dialer at random (load-balanced across the fleet).

team_id

string<uuid> | null

Optional: dial AS this specific team (its default member answers). Must already be attached to the from-number as an outbound_call binding. Provide this XOR agent_id; omit both for random pick.

agent_revision_id

string<uuid> | null

Optional: run THIS call on a specific published revision of agent_id instead of the revision pinned on the number's binding (pin-at-bind). Use to canary a newly published revision on live traffic before re-binding the number. Only valid alongside agent_id; the revision must belong to that agent and be published — drafts stay undialerable on live numbers (use /web-call for draft testing). Omitted → the binding's pinned revision, exactly as before. The call's context_variables are validated against the SAME revision that runs.

context_variables

Context Variables · object | null

Optional seed values for the bound agent's typed context variables, applied once at session bootstrap. Each key must be a variable declared on the agent or one of its bound workflows; values are coerced against the variable's type/enum. An unknown key or an uncoercible value is rejected (422). System vars are frozen on-file; derived seeds satisfy the collection gate. Only honored for single-agent bindings in v1 (ignored for team-bound dialers).

idempotency_key

string | null

Client-supplied dedup key; a retry of a still-queued call returns the same queued envelope (no second dial). Alphanumeric + dash/underscore, 1-120 chars.

Pattern: ^[A-Za-z0-9_\-]{1,120}$

instant

boolean

default:false

Test/instant dispatch: bypass the calling-hours window and dispatch immediately. Rate-limited separately; concurrency limits still apply.

expires_in_seconds

integer | null

Override the org's queued-call expiry for THIS call. Seconds from enqueue after which the call is expired if still waiting in the queue (never dialed). 0 disables expiry for this call even if the org has a default; omit (null) to use the org's call_expiry setting. Max 30 days.

Required range: 0 <= x <= 2592000

override_pause

boolean

default:false

Bypass the outbound pause gate and dispatch inline. Valid ONLY with instant=True (enforced by the schema validator). Requires the communication:manage permission — enforced in the router, not here. No effect on the queued (non-instant) path.

Response

Successful Response

agent_name

string

required

session_id

string<uuid>

required

queued

boolean

default:false

room_name

string | null

dispatch_id

string | null

agent_revision_id

string<uuid> | null

agent_revision_name

string | null

revision_source

enum<string> | null

Available options:

override,

pin,

active_fallback

Outbound

curl --request POST \
  --url https://api-sandbox.featherhq.com/v1/voice/outbound \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "from_phone_number_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "to_phone_number": "<string>",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "context_variables": {},
  "idempotency_key": "<string>",
  "instant": false,
  "expires_in_seconds": 1296000,
  "override_pause": false
}
'

import requests

url = "https://api-sandbox.featherhq.com/v1/voice/outbound"

payload = {
    "from_phone_number_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "to_phone_number": "<string>",
    "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "agent_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "context_variables": {},
    "idempotency_key": "<string>",
    "instant": False,
    "expires_in_seconds": 1296000,
    "override_pause": False
}
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({
    from_phone_number_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    to_phone_number: '<string>',
    agent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    team_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    agent_revision_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    context_variables: {},
    idempotency_key: '<string>',
    instant: false,
    expires_in_seconds: 1296000,
    override_pause: false
  })
};

fetch('https://api-sandbox.featherhq.com/v1/voice/outbound', 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-sandbox.featherhq.com/v1/voice/outbound",
  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([
    'from_phone_number_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'to_phone_number' => '<string>',
    'agent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'team_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'agent_revision_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'context_variables' => [
        
    ],
    'idempotency_key' => '<string>',
    'instant' => false,
    'expires_in_seconds' => 1296000,
    'override_pause' => false
  ]),
  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-sandbox.featherhq.com/v1/voice/outbound"

	payload := strings.NewReader("{\n  \"from_phone_number_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"to_phone_number\": \"<string>\",\n  \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"team_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"agent_revision_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"context_variables\": {},\n  \"idempotency_key\": \"<string>\",\n  \"instant\": false,\n  \"expires_in_seconds\": 1296000,\n  \"override_pause\": false\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-sandbox.featherhq.com/v1/voice/outbound")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"from_phone_number_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"to_phone_number\": \"<string>\",\n  \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"team_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"agent_revision_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"context_variables\": {},\n  \"idempotency_key\": \"<string>\",\n  \"instant\": false,\n  \"expires_in_seconds\": 1296000,\n  \"override_pause\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.featherhq.com/v1/voice/outbound")

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  \"from_phone_number_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"to_phone_number\": \"<string>\",\n  \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"team_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"agent_revision_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"context_variables\": {},\n  \"idempotency_key\": \"<string>\",\n  \"instant\": false,\n  \"expires_in_seconds\": 1296000,\n  \"override_pause\": false\n}"

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

{
  "agent_name": "<string>",
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "queued": false,
  "room_name": "<string>",
  "dispatch_id": "<string>",
  "agent_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_revision_name": "<string>",
  "revision_source": "override"
}

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