Chilkat Online Tools

VBScript / Plivo REST API / Start recording a call

Back to Collection Items

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

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

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.Http")
set http = CreateObject("Chilkat.Http")

http.BasicAuth = 1
http.Login = "{{auth_id}}"
http.Password = "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.

' {
'   "time_limit": "60",
'   "file_format": "mp3",
'   "transcription_type": "auto",
'   "transcription_url": "https://transcription.url",
'   "transcription_method": "POST",
'   "callback_url": "https://callback.url",
'   "callback_method": "POST"
' }

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set json = CreateObject("Chilkat.JsonObject")
success = json.UpdateString("time_limit","60")
success = json.UpdateString("file_format","mp3")
success = json.UpdateString("transcription_type","auto")
success = json.UpdateString("transcription_url","https://transcription.url")
success = json.UpdateString("transcription_method","POST")
success = json.UpdateString("callback_url","https://callback.url")
success = json.UpdateString("callback_method","POST")

' resp is a Chilkat.HttpResponse
Set resp = http.PostJson3("https://api.plivo.com/v1/Account/<auth_id>/Call/{call_uuid}/Record/","application/json",json)
If (http.LastMethodSuccess = 0) Then
    outFile.WriteLine(http.LastErrorText)
    WScript.Quit
End If

outFile.WriteLine(resp.StatusCode)
outFile.WriteLine(resp.BodyStr)


outFile.Close

Curl Command

curl -X POST
	-u '{{auth_id}}:password'
	-d '{
    "time_limit":"60",
    "file_format":"mp3",
    "transcription_type":"auto",
    "transcription_url":"https://transcription.url",
    "transcription_method":"POST",
    "callback_url":"https://callback.url",
    "callback_method":"POST"
}'
https://api.plivo.com/v1/Account/<auth_id>/Call/{call_uuid}/Record/

Postman Collection Item JSON

{
  "name": "Start recording a call",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"time_limit\":\"60\",\n    \"file_format\":\"mp3\",\n    \"transcription_type\":\"auto\",\n    \"transcription_url\":\"https://transcription.url\",\n    \"transcription_method\":\"POST\",\n    \"callback_url\":\"https://callback.url\",\n    \"callback_method\":\"POST\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Call/{call_uuid}/Record/",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        "Call",
        "{call_uuid}",
        "Record",
        ""
      ]
    },
    "description": "This endpoint allows you to start recording a call.\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/record-calls#start-recording-a-call)\n\n| Arguments   | Description | Required/Conditional/Optional     |\n| :---        |    :----:   |          ---: |\n| time_limit      | Sets the maximum duration post which the recording will be stopped automatically. The default value is 60 seconds. | Optional  |\n| file_format      | This allows you to specify the format in which you want the recording in. The formats supported are mp3 and wav. By default recordings are in mp3 format. | Optional  |\n| transcription_type| auto: Transcription is completely automated; turnaround time is about 30 minutes.Transcriptions are charged and details are available in [pricing page](https://www.plivo.com/pricing/#transcription). | Optional  |"
  },
  "response": [
    {
      "name": "Start recording a call",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"time_limit\":\"60\",\n    \"file_format\":\"mp3\",\n    \"transcription_type\":\"auto\",\n    \"transcription_url\":\"https://transcription.url\",\n    \"transcription_method\":\"POST\",\n    \"callback_url\":\"https://callback.url\",\n    \"callback_method\":\"POST\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Call/{call_uuid}/Record/",
          "protocol": "https",
          "host": [
            "api",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Account",
            "{{auth_id}}",
            "Call",
            "{call_uuid}",
            "Record",
            ""
          ]
        }
      },
      "code": 202,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n  \"url\": \"http://s3.amazonaws.com/recordings_2013/48dfaf60-3b2a-11e3.mp3\",\n  \"message\": \"call recording started\",\n  \"recording_id\": \"48dfaf60-3b2a-11e3\",\n  \"api_id\": \"c7b69074-58be-11e1-86da-adf28403fe48\"\n}"
    }
  ]
}