Bridge ended notification

POST

internal

agentic-dial

bridge-ended

cURL

curl -X POST "https://api.us-1.platform.polyai.app/internal/v1/agentic-dial/bridge-ended" -H "Content-Type: application/json" -d '{"conversation_id":"conv_abc123xyz","bridge_duration_seconds":180,"call_duration_seconds":300}'

import requests

url = "https://api.us-1.platform.polyai.app/internal/v1/agentic-dial/bridge-ended"
headers = {"Content-Type": "application/json"}
payload = {
    "conversation_id": "conv_abc123xyz",
    "bridge_duration_seconds": 180,
    "call_duration_seconds": 300
}
resp = requests.post(url, headers=headers, json=payload)
print(resp.status_code)  # 200 on success

const options = {
  method: 'POST',
  headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    conversation_id: 'conv_abc123xyz',
    bridge_duration_seconds: 180,
    call_duration_seconds: 300
  })
};

fetch('https://api.us-1.platform.polyai.app/internal/v1/agentic-dial/bridge-ended', 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.us-1.platform.polyai.app/internal/v1/agentic-dial/bridge-ended",
  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([
    'conversation_id' => 'conv_abc123xyz',
    'bridge_duration_seconds' => 180,
    'call_duration_seconds' => 300
  ]),
  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.us-1.platform.polyai.app/internal/v1/agentic-dial/bridge-ended"

	payload := strings.NewReader("{\n  \"conversation_id\": \"conv_abc123xyz\",\n  \"bridge_duration_seconds\": 180,\n  \"call_duration_seconds\": 300\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.us-1.platform.polyai.app/internal/v1/agentic-dial/bridge-ended")
  .header("X-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"conversation_id\": \"conv_abc123xyz\",\n  \"bridge_duration_seconds\": 180,\n  \"call_duration_seconds\": 300\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.us-1.platform.polyai.app/internal/v1/agentic-dial/bridge-ended")

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  \"conversation_id\": \"conv_abc123xyz\",\n  \"bridge_duration_seconds\": 180,\n  \"call_duration_seconds\": 300\n}"

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

{
  "error_message": "<string>"
}

{
  "error_message": "<string>"
}

Overview

The bridge-ended endpoint receives notifications when a call bridge (transfer) completes. This endpoint is triggered automatically by the telephony system after a bridged call ends, allowing configured project functions to process bridge metadata and call duration information.

Use cases

Log bridge duration for analytics
Trigger post-transfer workflows
Update CRM systems with transfer outcomes
Calculate agent availability based on bridge time

Request body

The endpoint accepts the following parameters:

Parameter	Type	Required	Description
`conversation_id`	string	Yes	The unique identifier for the conversation
`bridge_duration_seconds`	number	Yes	Duration of the bridge/transfer in seconds
`call_duration_seconds`	number	Yes	Total call duration in seconds

Example request

{
  "conversation_id": "conv_abc123xyz",
  "bridge_duration_seconds": 180,
  "call_duration_seconds": 300
}

Behavior

When this endpoint receives a bridge-ended notification:

The system extracts the conversation ID and bridge metadata
Configured project functions are triggered with the bridge data
Functions can access bridge duration and call duration for processing
The conversation state is updated to reflect the bridge completion

Configuration

This endpoint is automatically configured when you set up call transfer/bridge functionality in your project. Contact your PolyAI representative to enable bridge-ended notifications for your project.

Authorizations

X-Api-Key

string

header

required

API key for the External Events webhook. Contact your PolyAI representative to obtain credentials.

Body

application/json

conversation_id

string

required

The unique identifier for the conversation

bridge_duration_seconds

number

required

Duration of the bridge/transfer in seconds

call_duration_seconds

number

required

Total call duration in seconds

Response

Bridge ended notification received and processed successfully.

Last modified on March 20, 2026

OverviewRetrieve conversation context and metadata when PolyAI agents hand off to live agents or external systems.

⌘I

cURL

curl -X POST "https://api.us-1.platform.polyai.app/internal/v1/agentic-dial/bridge-ended" -H "Content-Type: application/json" -d '{"conversation_id":"conv_abc123xyz","bridge_duration_seconds":180,"call_duration_seconds":300}'

import requests

url = "https://api.us-1.platform.polyai.app/internal/v1/agentic-dial/bridge-ended"
headers = {"Content-Type": "application/json"}
payload = {
    "conversation_id": "conv_abc123xyz",
    "bridge_duration_seconds": 180,
    "call_duration_seconds": 300
}
resp = requests.post(url, headers=headers, json=payload)
print(resp.status_code)  # 200 on success

const options = {
  method: 'POST',
  headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    conversation_id: 'conv_abc123xyz',
    bridge_duration_seconds: 180,
    call_duration_seconds: 300
  })
};

fetch('https://api.us-1.platform.polyai.app/internal/v1/agentic-dial/bridge-ended', 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.us-1.platform.polyai.app/internal/v1/agentic-dial/bridge-ended",
  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([
    'conversation_id' => 'conv_abc123xyz',
    'bridge_duration_seconds' => 180,
    'call_duration_seconds' => 300
  ]),
  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.us-1.platform.polyai.app/internal/v1/agentic-dial/bridge-ended"

	payload := strings.NewReader("{\n  \"conversation_id\": \"conv_abc123xyz\",\n  \"bridge_duration_seconds\": 180,\n  \"call_duration_seconds\": 300\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.us-1.platform.polyai.app/internal/v1/agentic-dial/bridge-ended")
  .header("X-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"conversation_id\": \"conv_abc123xyz\",\n  \"bridge_duration_seconds\": 180,\n  \"call_duration_seconds\": 300\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.us-1.platform.polyai.app/internal/v1/agentic-dial/bridge-ended")

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  \"conversation_id\": \"conv_abc123xyz\",\n  \"bridge_duration_seconds\": 180,\n  \"call_duration_seconds\": 300\n}"

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

{
  "error_message": "<string>"
}

{
  "error_message": "<string>"
}

API reference

Build & deploy

Runtime & data

Monitoring

Legacy

Overview

Use cases

Request body

Example request

Behavior

Configuration

Authorizations

Body

Response

​Overview

​Use cases

​Request body

​Example request

​Behavior

​Configuration

Authorizations

Body

Response

Overview

Use cases

Request body

Example request

Behavior

Configuration