{"_id":"543bf3f25e7c871600f19170","__v":4,"project":"542dbe0ecb19820800c1f4d7","version":{"_id":"542ecc0a6b0eb6080066ca77","forked_from":"542dbe0fcb19820800c1f4da","project":"542dbe0ecb19820800c1f4d7","__v":31,"createdAt":"2014-10-03T16:17:14.165Z","releaseDate":"2014-10-03T16:17:14.165Z","categories":["542ecc0a6b0eb6080066ca78","542ef44f6b0eb6080066cb24","543bf3e22a30961a00b66eb3","5446952b82bd7e08002768a0","544821ae8d7af31a00dd41ce","544a7885f1aefa08006efc69","544c758e11845f0e001ed8de","544e5565b80812080035be55","544e558dbd51b9080037f8ca","5450b045a66f020800dba73d","5450eb6aa66f020800dba945","5450f39ea66f020800dba989","5450f877a66f020800dba9cf","54510356a66f020800dbaa17","5451274514af501a00b50c99","54513345a66f020800dbab24","54513cc014af501a00b50d24","54515eec14af501a00b50db9","54519b1d14af501a00b50ea9","54519b2aa66f020800dbacb4","54524f9704160008005b1d27","54538d2308d1800800473d95","54538d420c09721000a06a03","54538e5608d1800800473d9a","5453ea9547c30114004fb375","5453eb12b077c31c00067bcb","5453eb27b077c31c00067bcd","5453ed5db077c31c00067bde","548075cbe291c51a00e7e096","5922fa475c48c70f00f21453","59244fd41e32eb190028ad8d"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"editedParams":true,"is_link":false,"parentDoc":null,"category":{"_id":"54538e5608d1800800473d9a","project":"542dbe0ecb19820800c1f4d7","__v":0,"pages":["542ef4fd1161420800d8370c","544a9f7c4688c708001866a2","544ab18abb58010800710b86","543acbefe14e09080000a0ac","544c5f7236475e0e005014c7","543bd73c5e7c871600f190da","543bf3f25e7c871600f19170","544577290a8dbc1a00ff6a23"],"version":"542ecc0a6b0eb6080066ca77","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-31T13:27:50.899Z","from_sync":false,"order":2,"slug":"calls","title":"Calls"},"editedParams2":true,"user":"542dc547cb19820800c1f4f1","updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-13T15:46:58.069Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"post","results":{"codes":[{"language":"json","code":"{\n    \"sid\": \"{CallSid}\",\n    \"date_created\": \"Tue, 24 Jul 2012 14:56:32 +0000\",\n    \"date_updated\": \"Tue, 24 Jul 2012 14:56:35 +0000\",\n    \"parent_call_sid\": \"\",\n    \"account_sid\": \"{AccountSid}\",\n    \"to\": \"+14245555526\",\n    \"from\": \"+17325551300\",\n    \"phone_number_sid\": \"{phone_number_sid}\",\n    \"status\": \"completed\",\n    \"start_time\": \"Tue, 24 Jul 2012 14:56:32 +0000\",\n    \"end_time\": \"Tue, 24 Jul 2012 14:56:35 +0000\",\n    \"duration\": \"3\",\n    \"price\": \"0.020000\",\n    \"direction\": \"outbound-api\",\n    \"answered_by\": \"None\",\n    \"api_version\": \"v2\",\n    \"forwarded_from\": \"\",\n    \"p_asserted_identity\": \"\",\n    \"sip_privacy\": \"\",\n    \"privacy_hide_number\": \"False\",\n    \"uri\": \"/v2/Accounts/{AccountSid}/Calls/{CallSid}.json\",\n    \"subresource_uris\": {\n        \"notifications\": \"/v2/Accounts/{AccountSid}/Calls/{CallSid}/Notifications.json\",\n        \"recordings\": \"/v2/Accounts/{AccountSid}/Calls/{CallSid}/Recordings.json\"\n    }\n}        ","name":"Success"},{"name":"Failure","status":404,"language":"json","code":"{\n    \"status\": 404,\n    \"message\": \"The requested resource was not found: /v2/Accounts/bad/bad_response.json\"\n}"}]},"try":true,"basic_auth":true,"auth":"required","params":[{"_id":"543bf3f25e7c871600f19171","ref":"","in":"path","required":true,"desc":"Account SID.","default":"","type":"string","name":"AccountSid"},{"_id":"543ed13c55bb100800095583","ref":"","in":"path","required":true,"desc":"Call SID.","default":"","type":"string","name":"CallSid"},{"_id":"543ed13c55bb100800095582","ref":"","in":"body","required":true,"desc":"A URL returning the sound file to play. [Progressive downloads](http://en.wikipedia.org/wiki/Progressive_download) and [SHOUTCAST streaming](http://en.wikipedia.org/wiki/SHOUTcast) are also supported.","default":"","type":"string","name":"AudioUrl"},{"_id":"54455a200a8dbc1a00ff6995","ref":"","in":"body","required":false,"desc":"Specifies which caller will hear the played audio. Allowed values are \"in\" to play audio to the incoming caller, \"out\" to play to the outgoing caller, and \"both\" to play the audio to both callers.","default":"both","type":"string","name":"Direction"},{"_id":"54456467a21e4d140055dc23","ref":"","in":"body","required":false,"desc":"Specifies whether the audio will loop. Allowed values are \"true\" and \"false\".","default":"false","type":"string","name":"Loop"}],"url":"/v2/Accounts/:AccountSid/Calls/:CallSid/Play.json"},"isReference":false,"order":6,"body":"# **Response Parameters**\n\nResponse parameters are equal to those on [\"View Call\" API call](/v2/docs/view-call).\n\n# **Example cURL**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -X POST 'https://api.telapi.com/v2/Accounts/{AccountSid}/Calls/{CallSid}/Play.json' -u '{AccountSid}:{AuthToken}' -d 'AudioUrl=http://valid-url-here.com/audio.mp3'\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]","excerpt":"options include restricting to one caller and looping","slug":"play-audio","type":"endpoint","title":"Play Audio to Live Call"}

postPlay Audio to Live Call

options include restricting to one caller and looping

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

AccountSid:
required
string
Account SID.
CallSid:
required
string
Call SID.

Body Params

AudioUrl:
required
string
A URL returning the sound file to play. [Progressive downloads](http://en.wikipedia.org/wiki/Progressive_download) and [SHOUTCAST streaming](http://en.wikipedia.org/wiki/SHOUTcast) are also supported.
Direction:
stringboth
Specifies which caller will hear the played audio. Allowed values are "in" to play audio to the incoming caller, "out" to play to the outgoing caller, and "both" to play the audio to both callers.
Loop:
stringfalse
Specifies whether the audio will loop. Allowed values are "true" and "false".

Result Format


Documentation

# **Response Parameters** Response parameters are equal to those on ["View Call" API call](/v2/docs/view-call). # **Example cURL** [block:code] { "codes": [ { "code": "curl -X POST 'https://api.telapi.com/v2/Accounts/{AccountSid}/Calls/{CallSid}/Play.json' -u '{AccountSid}:{AuthToken}' -d 'AudioUrl=http://valid-url-here.com/audio.mp3'", "language": "shell" } ] } [/block]