Create Bridge Phrases

Create a new bridge phrases config.

POST /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.create({
    name: "Default Bridge Phrases",
    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: [
        {
          toolName: "<value>",
          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.",
                ],
              },
            },
          },
        },
      ],
      randomizeBridgePhrases: true,
    },
  });

  console.log(result);
}

run();

200

{
  "name": "<string>",
  "id": 123,
  "updated_at": "2023-11-07T05:31:56Z",
  "last_updated_by": "<string>",
  "description": "Standard hold phrases for inbound line.",
  "config": {
    "phrases": {
      "messages": [
        "<string>"
      ],
      "localized": {
        "es-US": {
          "messages": [
            "Un momento, por favor."
          ]
        },
        "fr-FR": {
          "messages": [
            "Un instant, je vous en prie."
          ]
        }
      }
    },
    "tools": [
      {
        "tool_name": "<string>",
        "phrases": {
          "messages": [
            "<string>"
          ],
          "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": false
  },
  "is_default": false,
  "edit_comments": "Added Spanish overrides for the transfer tool.",
  "agents_info": [
    {
      "id": 1,
      "name": "Test Agent"
    }
  ]
}

Authorizations

Syllable-API-Key · string · header · required

Body

application/json

Request model to create a bridge phrases config.

name · string · required

The name of the bridge phrases config.

Example:

"Default Bridge Phrases"

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 should be marked as the default for its suborg. At most one non-deleted config per suborg may be the default; the API returns a 400 if a second default is requested while another is already set.

Example:

false

Response

200

application/json

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"

id · 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:

"[e-mail]"

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" }]