v64

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01176310978.7 KB

bridge_phrases

List Bridge Phrases

Fetch bridge phrases configs.

get/api/v1/bridge_phrases/

Query parameters

pageinteger nullable

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

limitinteger

The maximum number of items to return

Example:25

The maximum number of items to return

search_fieldsBridgePhrasesProperties[]

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

search_field_valuesstring[]

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

order_by'name' | 'description' | 'updated_at' | 'last_updated_by'

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

The field whose value should be used to order the results

order_by_direction'asc' | 'desc'

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

The direction in which to order the results

fieldsBridgePhrasesProperties[] nullable

The fields to include in the response

start_datetimestring nullable

The start datetime for filtering results

Example:2023-01-01T00:00:00Z

The start datetime for filtering results

end_datetimestring nullable

The end datetime for filtering results

Example:2024-01-01T00:00:00Z

The end datetime for filtering results

Response

Successful Response

pageinteger required

The page number of the results (0-based)

page_sizeinteger required

The number of items returned per page

total_pagesinteger nullable

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

total_countinteger nullable

The total number of items returned from the query

Example response

{
  "items": [
    {
      "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": [
          {
            "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."
                  ]
                }
              }
            }
          }
        ],
        "randomize_bridge_phrases": true
      },
      "id": 1,
      "edit_comments": "Added Spanish overrides for the transfer tool.",
      "agents_info": [
        {
          "id": 1,
          "name": "Test Agent"
        }
      ],
      "updated_at": "2026-07-02T00:00:00Z",
      "last_updated_by": "user@mail.com"
    }
  ],
  "page_size": 25,
  "total_pages": 4,
  "total_count": 100
}