List Bridge Phrases

Fetch bridge phrases configs.

GET /api/v1/bridge_phrases/

Typescript (SDK)

TypeScript

import { SyllableSDK } from "syllable-sdk";

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

async function run() {
  const result = await syllableSDK.bridgePhrases.list({
    page: 0,
    searchFields: [
      "name",
    ],
    searchFieldValues: [
      "Some Object Name",
    ],
    startDatetime: "2023-01-01T00:00:00Z",
    endDatetime: "2024-01-01T00:00:00Z",
  });

  console.log(result);
}

run();

200

{
  "items": [
    {
      "name": "Default Bridge Phrases",
      "id": 1,
      "updated_at": "2026-07-02T00:00:00Z",
      "last_updated_by": "[e-mail]",
      "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"
        }
      ]
    }
  ],
  "page": 0,
  "page_size": 25,
  "total_pages": 4,
  "total_count": 100
}

Authorizations

Syllable-API-Key · string · header · required

Query Parameters

page · integer | null · default: 0

The page number from which to start (0-based)

Required range: x >= 0

Example:

0

limit · integer · default: 25

The maximum number of items to return

Required range: x >= 0

Example:

25

search_fields · enum<string>[]

String names of fields to search. Correspond by index to search field values

Names of bridge phrases fields supported for filtering/sorting on list endpoint.

Available options: name, description, updated_at, last_updated_by

Example:

"name"

search_field_values · string[]

Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list

Example:

"Some Object Name"

order_by · enum<string> | null

The field whose value should be used to order the results Names of bridge phrases fields supported for filtering/sorting on list endpoint.

Available options: name, description, updated_at, last_updated_by

Example:

"name"

order_by_direction · enum<string> | null

The direction in which to order the results The direction in which to order list results, either ascending or descending.

Available options: asc, desc

fields · enum<string>[] | null

The fields to include in the response

Names of bridge phrases fields supported for filtering/sorting on list endpoint.

Available options: name, description, updated_at, last_updated_by

start_datetime · string | null

The start datetime for filtering results

Example:

"2023-01-01T00:00:00Z"

end_datetime · string | null

The end datetime for filtering results

Example:

"2024-01-01T00:00:00Z"

Response

200

application/json

Successful Response

items · BridgePhrasesResponse · object[] · required

List of items returned from the query

Show child attributes

page · integer · required

The page number of the results (0-based)

Example:

0

page_size · integer · required

The number of items returned per page

Example:

25

total_pages · integer | null

The total number of pages of results given the indicated page size

Example:

4

total_count · integer | null

The total number of items returned from the query

Example:

100