Chilkat Online Tools

PowerBuilder / Plivo REST API / Start recording a call

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_Resp

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

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

loo_Http.BasicAuth = 1
loo_Http.Login = "{{auth_id}}"
loo_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"
// }

loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

loo_Json.UpdateString("time_limit","60")
loo_Json.UpdateString("file_format","mp3")
loo_Json.UpdateString("transcription_type","auto")
loo_Json.UpdateString("transcription_url","https://transcription.url")
loo_Json.UpdateString("transcription_method","POST")
loo_Json.UpdateString("callback_url","https://callback.url")
loo_Json.UpdateString("callback_method","POST")

loo_Resp = loo_Http.PostJson3("https://api.plivo.com/v1/Account/<auth_id>/Call/{call_uuid}/Record/","application/json",loo_Json)
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_Json
    return
end if

Write-Debug string(loo_Resp.StatusCode)
Write-Debug loo_Resp.BodyStr
destroy loo_Resp


destroy loo_Http
destroy loo_Json

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