Bridge Actions

13 min

Description

Bridge Actions allow you to control an existing bridge after it has been created. Using these actions, you can play audio announcements, perform text-to-speech, start or stop recordings, and route bridge-level events to external systems.

Bridge Actions apply to all legs currently joined to the bridge, making them ideal for conferencing, announcements, and supervisory use cases.

All Bridge Actions are executed via a single Actions API using an EXOML payload.

Authentication

Type: HTTP Basic Authentication

Username: API Key

Password: API Token

Request Headers

Content-Type: application/json Authorization: Basic <base64(API_KEY:API_TOKEN)>

Request Body Structure

Field	Type	Required	Description
exoml	string	Yes	XML describing the bridge action
action_custom_param	string	No	Custom value echoed back in external events

Base URL

https://cpaas-api.in.exotel.com/v2/accounts/{account_sid}

Example

https://cpaas-api.in.exotel.com/v2/accounts/ameyo5m

Common Endpoint

All Bridge Actions are executed using:

POST

/v2/accounts/{account_sid}/bridges/{bridge_sid}/actions

Full URL

https://cpaas-api.in.exotel.com/v2/accounts/{account_sid}/bridges/{bridge_sid}/actions

Common Request Body

Parameter	Type	Required	Description
action_custom_param	string	No	Custom value echoed back in external events
exoml	string	Yes	EXOML XML defining the bridge action

Common Response

HTTP 202 – Accepted

{ "request_id": "abc123", "http_code": 202, "response": { "data": { "bridge_sid": "BRIDGE_SID" } } }

Bridge Actions are asynchronous. Final success or failure is communicated via external events.

Common Error Responses (applies to all bridge actions)

HTTP Code	Description
400	Invalid EXOML or parameters
401	Authentication failed
403	Not authorized
404	Bridge not found
429	Rate limit exceeded
500	Internal server error

External Events (General)

Events are delivered asynchronously to the configured bridge_event_endpoint (gRPC)

Each bridge action emits one or more action-specific events

Event details are documented in individual Bridge Action pages

Supported Bridge Actions

Refer

StartPlay

StopPlay

StartSay

StopSay

StartRecording

StopRecording

Notes for Developers

Bridge Actions affect all participants in the bridge

Media actions apply to current and future legs

Use Leg Actions (JoinBridge / LeaveBridge) to manage bridge membership

Prefer Bridge Actions for announcements and conferencing, not individual control