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

Playback url into a channel call

POST/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/playback

Authorization

useraccessKey

Path parameters

workspaceId*string (uuid)

The ID of the workspace

callId*string (uuid)

The ID for a call

channelId*string (uuid)

The ID for a channel

Body

application/json

media*nullable array of string

loopinteger

timeoutinteger

pauseMillisecondsinteger

Response

202400404422

Call Command Play was accepted for processing

Body

application/json

idId-2 (string (uuid))

callIdId-2 (string (uuid))

callFlowIdId-2 (string (uuid))

statusstring

commandstring

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/playback', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "media": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

202400404422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "callId": "123e4567-e89b-12d3-a456-426614174000",
  "callFlowId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "text",
  "command": "text"
}

Example 1: Play a media file in a call

Request Headers

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}'

Request Body

{​
  "media": [​
    "string"​
  ],​
  "loop": 0,​
  "timeout": 0​
​}

Response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "callId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "callFlowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "string",
  "command": "string"
}