Get Bridge Phrases - Syllable SDK

Typescript (SDK)

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.bridgePhrases.getById({
    bridgePhrasesId: 627472,
  });

  console.log(result);
}

run();

import os
from syllable_sdk import SyllableSDK


with SyllableSDK(
    api_key_header=os.getenv("SYLLABLESDK_API_KEY_HEADER", ""),
) as ss_client:

    res = ss_client.bridge_phrases.get_by_id(bridge_phrases_id=627472)

    # Handle response
    print(res)

const options = {method: 'GET', headers: {'Syllable-API-Key': '<api-key>'}};

fetch('https://api.syllable.cloud/api/v1/bridge_phrases/{bridge_phrases_id}', 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.syllable.cloud/api/v1/bridge_phrases/{bridge_phrases_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Syllable-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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.syllable.cloud/api/v1/bridge_phrases/{bridge_phrases_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Syllable-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.syllable.cloud/api/v1/bridge_phrases/{bridge_phrases_id}")

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

request = Net::HTTP::Get.new(url)
request["Syllable-API-Key"] = '<api-key>'

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

{
  "name": "Default Bridge Phrases",
  "id": 1,
  "updated_at": "2026-07-02T00:00:00Z",
  "last_updated_by": "user@mail.com",
  "description": "Standard hold phrases for inbound line.",
  "config": {
    "phrases": {
      "messages": [
        "One moment, please.",
        "Let me check on that for you."
      ],
      "localized": {
        "es-US": {
          "messages": [
            "Un momento, por favor."
          ]
        },
        "fr-FR": {
          "messages": [
            "Un instant, je vous en prie."
          ]
        }
      }
    },
    "tools": [
      {
        "tool_name": "<string>",
        "phrases": {
          "messages": [
            "One moment, please.",
            "Let me check on that for you."
          ],
          "localized": {
            "es-US": {
              "messages": [
                "Un momento, por favor."
              ]
            },
            "fr-FR": {
              "messages": [
                "Un instant, je vous en prie."
              ]
            }
          }
        }
      }
    ],
    "smart_turn_timeout_seconds": 2.75,
    "randomize_bridge_phrases": true
  },
  "is_default": false,
  "edit_comments": "Added Spanish overrides for the transfer tool.",
  "agents_info": [
    {
      "id": 1,
      "name": "Test Agent"
    }
  ]
}

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

GET

api

bridge_phrases

{bridge_phrases_id}

Typescript (SDK)

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.bridgePhrases.getById({
    bridgePhrasesId: 627472,
  });

  console.log(result);
}

run();

import os
from syllable_sdk import SyllableSDK


with SyllableSDK(
    api_key_header=os.getenv("SYLLABLESDK_API_KEY_HEADER", ""),
) as ss_client:

    res = ss_client.bridge_phrases.get_by_id(bridge_phrases_id=627472)

    # Handle response
    print(res)

const options = {method: 'GET', headers: {'Syllable-API-Key': '<api-key>'}};

fetch('https://api.syllable.cloud/api/v1/bridge_phrases/{bridge_phrases_id}', 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.syllable.cloud/api/v1/bridge_phrases/{bridge_phrases_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Syllable-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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.syllable.cloud/api/v1/bridge_phrases/{bridge_phrases_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Syllable-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.syllable.cloud/api/v1/bridge_phrases/{bridge_phrases_id}")

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

request = Net::HTTP::Get.new(url)
request["Syllable-API-Key"] = '<api-key>'

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

{
  "name": "Default Bridge Phrases",
  "id": 1,
  "updated_at": "2026-07-02T00:00:00Z",
  "last_updated_by": "user@mail.com",
  "description": "Standard hold phrases for inbound line.",
  "config": {
    "phrases": {
      "messages": [
        "One moment, please.",
        "Let me check on that for you."
      ],
      "localized": {
        "es-US": {
          "messages": [
            "Un momento, por favor."
          ]
        },
        "fr-FR": {
          "messages": [
            "Un instant, je vous en prie."
          ]
        }
      }
    },
    "tools": [
      {
        "tool_name": "<string>",
        "phrases": {
          "messages": [
            "One moment, please.",
            "Let me check on that for you."
          ],
          "localized": {
            "es-US": {
              "messages": [
                "Un momento, por favor."
              ]
            },
            "fr-FR": {
              "messages": [
                "Un instant, je vous en prie."
              ]
            }
          }
        }
      }
    ],
    "smart_turn_timeout_seconds": 2.75,
    "randomize_bridge_phrases": true
  },
  "is_default": false,
  "edit_comments": "Added Spanish overrides for the transfer tool.",
  "agents_info": [
    {
      "id": 1,
      "name": "Test Agent"
    }
  ]
}

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

Authorizations

Syllable-API-Key

string

header

required

Path Parameters

bridge_phrases_id

integer

required

Response

Successful Response

Response model for bridge phrases operations.

A bridge phrases config is a named, sub-org-scoped collection of default bridge phrases plus optional per-tool and per-language overrides that can be linked to an agent. For more information, see Console docs.

name

string

required

The name of the bridge phrases config.

Example:

"Default Bridge Phrases"

integer

required

The ID of the bridge phrases config to update.

Example:

1

updated_at

string<date-time>

required

Timestamp of the last update.

Example:

"2026-07-02T00:00:00Z"

last_updated_by

string

required

Email of the user who last updated this config.

Example:

"user@mail.com"

description

string | null

Description of the bridge phrases config.

Example:

"Standard hold phrases for inbound line."

config

BridgePhrasesConfigPayload · object

Default phrases plus per-tool overrides.

Show child attributes

is_default

boolean

default:false

Whether this config is currently marked as the default for its suborg.

Example:

false

edit_comments

string | null

Comments for the most recent edit.

Example:

"Added Spanish overrides for the transfer tool."

agents_info

BridgePhrasesAgentInfo · object[] | null

IDs and names of the agents linked to this bridge phrases config.

Show child attributes

Example:

[{ "id": 1, "name": "Test Agent" }]