{"__v":1,"_id":"5450ec0a7abbbc0800a5eaa4","category":{"__v":4,"_id":"5450eb6aa66f020800dba945","pages":["54511ed6a66f020800dbaadc","5450f398a66f020800dba987"],"project":"542dbe0ecb19820800c1f4d7","version":"542ecc0a6b0eb6080066ca77","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-29T13:28:10.811Z","from_sync":false,"order":14,"slug":"recordings","title":"Recordings"},"editedParams":true,"editedParams2":true,"is_link":false,"parentDoc":null,"project":"542dbe0ecb19820800c1f4d7","user":"542dc547cb19820800c1f4f1","version":{"__v":29,"_id":"542ecc0a6b0eb6080066ca77","forked_from":"542dbe0fcb19820800c1f4da","project":"542dbe0ecb19820800c1f4d7","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"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-29T13:30:50.400Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"basic_auth":true,"method":"post","results":{"codes":[{"name":"","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}        ","language":"json","status":200},{"name":"","code":"{\n    \"status\": 404,\n    \"message\": \"The requested resource was not found: /v2/Accounts/bad/bad_response.json\"\n}","language":"json","status":404}]},"try":true,"auth":"required","params":[{"_id":"5450ec0a7abbbc0800a5eaa6","ref":"","in":"path","required":true,"desc":"Account SID.","default":"","type":"string","name":"AccountSid"},{"_id":"5450ec0a7abbbc0800a5eaa5","ref":"","in":"path","required":true,"desc":"Call SID.","default":"","type":"string","name":"CallSid"},{"_id":"5450ed807abbbc0800a5eabb","ref":"","in":"body","required":true,"desc":"Specifies if a call recording should start or end. Allowed values are \"true\" to start recording and \"false\" to end recording. Any number of simultaneous, separate recordings can be initiated.","default":"","type":"string","name":"Record"},{"_id":"5450ed807abbbc0800a5eaba","ref":"","in":"body","required":false,"desc":"Specifies which audio stream to record. Allowed values are \"in\" to record the incoming caller's audio, \"out\" to record the outgoing caller's audio, and \"both\" to record both.","default":"both","type":"string","name":"Direction"},{"_id":"5450ed807abbbc0800a5eab9","ref":"","in":"body","required":false,"desc":"The maximum duration of the recording. Allowed value is an integer greater than 0.","default":"","type":"string","name":"TimeLimit"},{"_id":"5450ed807abbbc0800a5eab8","ref":"","in":"body","required":false,"desc":"A URL that will be requested when the recording ends, sending information about the recording. The longer the recording, the longer the delay in processing the recording and requesting the CallbackUrl. Url length is limited to 200 characters.","default":"","type":"string","name":"CallbackUrl"},{"_id":"5450ed807abbbc0800a5eab7","ref":"","in":"body","required":false,"desc":"Specifies the file format of the recording. Allowed values are \"mp3\" or \"wav\" - any other value will default to \"mp3\".","default":"mp3","type":"string","name":"FileFormat"},{"_id":"5450ed807abbbc0800a5eab6","ref":"","in":"body","required":false,"desc":"Trims all silence from the beginning of the recording. Allowed values are \"true\" or \"false\" - any other value will default to \"false\".","default":"false","type":"string","name":"TrimSilence"},{"_id":"5450ed807abbbc0800a5eab5","ref":"","in":"body","required":false,"desc":"Specifies if this recording should be transcribed. Allowed values are \"true\" and \"false\" - all other values will default to \"false\".","default":"false","type":"string","name":"Transcribe"},{"_id":"5450ed807abbbc0800a5eab4","ref":"","in":"body","required":false,"desc":"Specifies the quality of the transcription. Allowed values are \"auto\" for automated transcriptions and \"hybrid\" for human-reviewed transcriptions - all other values will default to \"auto\".","default":"auto","type":"string","name":"TranscribeQuality"},{"_id":"5450ed807abbbc0800a5eab3","ref":"","in":"body","required":false,"desc":"A URL that will be requested when the call ends, sending information about the transcription. The longer the recording, the longer the delay in processing the transcription and requesting the TranscribeCallback. URL length is limited to 200 characters.","default":"","type":"string","name":"TranscribeCallback"}],"url":"/v2/Accounts/:AccountSid/Calls/:CallSid/Recordings.json"},"isReference":false,"order":2,"body":"# **Response Parameters**\n\nResponse parameters are equal to those on [\"View Recording\" API call](/v2/docs/view-recording).\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}/Recordings.json' -u '{AccountSid}:{AuthToken}' -d 'Record=true'\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]","excerpt":"records a TelAPI call","slug":"record-call-1","type":"endpoint","title":"Record Call"}

postRecord Call

records a TelAPI call

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

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

Body Params

Record:
required
string
Specifies if a call recording should start or end. Allowed values are "true" to start recording and "false" to end recording. Any number of simultaneous, separate recordings can be initiated.
Direction:
stringboth
Specifies which audio stream to record. Allowed values are "in" to record the incoming caller's audio, "out" to record the outgoing caller's audio, and "both" to record both.
TimeLimit:
string
The maximum duration of the recording. Allowed value is an integer greater than 0.
CallbackUrl:
string
A URL that will be requested when the recording ends, sending information about the recording. The longer the recording, the longer the delay in processing the recording and requesting the CallbackUrl. Url length is limited to 200 characters.
FileFormat:
stringmp3
Specifies the file format of the recording. Allowed values are "mp3" or "wav" - any other value will default to "mp3".
TrimSilence:
stringfalse
Trims all silence from the beginning of the recording. Allowed values are "true" or "false" - any other value will default to "false".
Transcribe:
stringfalse
Specifies if this recording should be transcribed. Allowed values are "true" and "false" - all other values will default to "false".
TranscribeQuality:
stringauto
Specifies the quality of the transcription. Allowed values are "auto" for automated transcriptions and "hybrid" for human-reviewed transcriptions - all other values will default to "auto".
TranscribeCallback:
string
A URL that will be requested when the call ends, sending information about the transcription. The longer the recording, the longer the delay in processing the transcription and requesting the TranscribeCallback. URL length is limited to 200 characters.

Result Format


Documentation

# **Response Parameters** Response parameters are equal to those on ["View Recording" API call](/v2/docs/view-recording). # **Example cURL** [block:code] { "codes": [ { "code": "curl -X POST 'https://api.telapi.com/v2/Accounts/{AccountSid}/Calls/{CallSid}/Recordings.json' -u '{AccountSid}:{AuthToken}' -d 'Record=true'", "language": "shell" } ] } [/block]