Chilkat Online Tools

TCL / Plivo REST API / Play audio on a call

Back to Collection Items

load ./chilkat.dll

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set http [new_CkHttp]

CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "{{auth_id}}"
CkHttp_put_Password $http "password"

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "urls": "https://s3.amazonaws.com/plivocloud/music.mp3",
#   "length": "10",
#   "legs": "aleg",
#   "loop": "false",
#   "mix": "true"
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "urls" "https://s3.amazonaws.com/plivocloud/music.mp3"
CkJsonObject_UpdateString $json "length" "10"
CkJsonObject_UpdateString $json "legs" "aleg"
CkJsonObject_UpdateString $json "loop" "false"
CkJsonObject_UpdateString $json "mix" "true"

# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://api.plivo.com/v1/Account/<auth_id>/Call/{call_uuid}/Play/" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkJsonObject $json

Curl Command

curl -X POST
	-u '{{auth_id}}:password'
	-d '{
    "urls":"https://s3.amazonaws.com/plivocloud/music.mp3",
    "length":"10",
    "legs":"aleg",
    "loop":"false",
    "mix":"true"
}'
https://api.plivo.com/v1/Account/<auth_id>/Call/{call_uuid}/Play/

Postman Collection Item JSON

{
  "name": "Play audio on a call",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"urls\":\"https://s3.amazonaws.com/plivocloud/music.mp3\",\n    \"length\":\"10\",\n    \"legs\":\"aleg\",\n    \"loop\":\"false\",\n    \"mix\":\"true\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Call/{call_uuid}/Play/",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        "Call",
        "{call_uuid}",
        "Play",
        ""
      ]
    },
    "description": "This endpoint allows you to play an audio file during an active call. The audio file formats supported are .mp3 and .wav\n\nBelow is the list of arguments that can be passed in this API request, more information can be found [here](https://www.plivo.com/docs/voice/api/call/play-audio-on-calls#play-audio-on-a-call)\n\n| Arguments   | Description | Required/Conditional/Optional     |\n| :---        |    :----:   |          ---: |\n| urls      | A single URL or a list of comma separated URLs linking to an .mp3 or .wav file.| Required  |\n| length      | This is the maximum length to which playing this audio file should be restricted to. Length is provided in seconds.| Optional  |\n| legs      | The call leg in which the audio has to be played. This can take three values aleg (first leg of the call), bleg(second leg of the call) or both. The default value is aleg.| Optional  |\n| loop      | This flag when set to true will play the audio file indefinitely. By default it is set to false.| Optional  |\n| mix      | This flag is used to determine the behaviour of current call audio when the file is being played. If this is set to false then participants of the call would not be able to hear anyone speaking in the call until the Play is stopped. If set to true both call audio and the Play audio will be mixed and played. Defaults to true.| Optional  |"
  },
  "response": [
    {
      "name": "Play audio on a call",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"urls\":\"https://s3.amazonaws.com/plivocloud/music.mp3\",\n    \"length\":\"10\",\n    \"legs\":\"aleg\",\n    \"loop\":\"false\",\n    \"mix\":\"true\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Call/{call_uuid}/Play/",
          "protocol": "https",
          "host": [
            "api",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Account",
            "{{auth_id}}",
            "Call",
            "{call_uuid}",
            "Play",
            ""
          ]
        }
      },
      "code": 202,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n    \"message\": \"play started\",\n    \"api_id\": \"07abfd94-58c0-11e1-86da-adf28403fe48\"\n}"
    }
  ]
}