Legs API
Bridge APIs - Introduction
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
Have a question?
Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.
To ask a question or participate in discussions, you'll need to authenticate first.
