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.

Play URL

post

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
post
POST /workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/playback HTTP/1.1
Host: 
Authorization: Bearer jwt
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://nest.messagebird.one/workspaces/8bc02f53-87ac-48d2-b4fd-c2cf856a305f/channels/880d8171-cbab-47bb-81b6-b1a0902da136/calls/4fc2edf7-68f5-437a-89eb-3ce0095409d6
/playback" \
     -H 'Authorization: Bearer {Token}'

Last updated

Was this helpful?