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.

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

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

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

Last updated 1 year ago

Was this helpful?

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

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/playback' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "media": [
      "text"
    ],
    "loop": 1,
    "timeout": 1,
    "pauseMilliseconds": 1
  }'

202

400

404

422

{
  "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"
    }
  ]
}

Call Command Play was accepted for processing