DocumentatieEngagement Platform API
Sign inGet started
Guides
API

Play a message in a call

Play an audio message from a link (URL) of your choice, this command can be used to play one or more audio messages in sequence on a voice call.
POST
/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/playback
Playback url into a channel call
Verzoek-payload
media
array of string
verplicht
loop
integer
timeout
integer
pauseMilliseconds
integer
Antwoord-payload
id
string
callId
string
callFlowId
string
status
string
command
string
conditions
array of object
Onderliggende attributen tonen
conditions.variable
string
Possible values: keys, speech
conditions.operator
string
Possible values: eq, ne, ==, !=, contains
conditions.value
string
Codevoorbeeld
curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/playback' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

Example 1: Play a media file in a call

Codevoorbeeld
curl -X POST "https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/playback" \
     -H "Authorization: AccessKey YOUR_SECRET_TOKEN"