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.
Playback url into a channel call
Authorizations
Path parameters
workspaceIdstring · uuidRequired
The ID of the workspace
callIdstring · uuidRequired
The ID for a call
channelIdstring · uuidRequired
The ID for a channel
Body
mediastring[] | nullableRequired
loopintegerOptional
timeoutintegerOptional
pauseMillisecondsinteger · max: 30000Optional
Responses
202
Call Command Play was accepted for processing
application/json
400
The request did not pass validation
application/json
404
The request did not pass validation
application/json
422
The request did not pass validation
application/json
post
POST /workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/playback HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 61
{
"media": [
"text"
],
"loop": 1,
"timeout": 1,
"pauseMilliseconds": 1
}
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"callId": "123e4567-e89b-12d3-a456-426614174000",
"callFlowId": "123e4567-e89b-12d3-a456-426614174000",
"status": "text",
"command": "text",
"conditions": [
{
"variable": "keys",
"operator": "eq",
"value": "text"
}
]
}
Example 1: Play a media file in a call
curl -X POST "https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/playback" \
-H "Authorization: AccessKey YOUR_SECRET_TOKEN"
Last updated
Was this helpful?