Chilkat Online Tools

PowerBuilder / Plivo REST API / Start Recording a Conference

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.

// {
//   "file_format": "mp3",
//   "transcription_type": "auto"
// }

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("file_format","mp3")
loo_Json.UpdateString("transcription_type","auto")

loo_Resp = loo_Http.PostJson3("https://api.plivo.com/v1/Account/<auth_id>/Conference/{conference_name}/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 '{
    "file_format":"mp3",
    "transcription_type":"auto"
}'
https://api.plivo.com/v1/Account/<auth_id>/Conference/{conference_name}/Record/

Postman Collection Item JSON

{
  "name": "Start Recording a Conference",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"file_format\":\"mp3\",\n    \"transcription_type\":\"auto\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Conference/{conference_name}/Record/",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        "Conference",
        "{conference_name}",
        "Record",
        ""
      ]
    },
    "description": "This API lets you start recording an ongoing conference. You can start recording the conference by using this API after the conference has been initiated. Alternatively you can also use the recording capabilities in [Conference XML](https://www.plivo.com/docs/voice/xml/conference/) to record the conference.\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/conference/record-conference#start-recording-a-conference)\n\n| Arguments   | Description | Required/Conditional/Optional     |\n| :---        |    :----:   |          ---: |\n|file_format|The file format in which the recording needs to be saved. This can either be mp3 or wav. Defaults to mp3 format|Optional|\n| transcription_type   | auto: Transcription is completely automated; turnaround time is about 30 minutes.<br />Transcriptions are charged and details are available in [pricing page](https://www.plivo.com/pricing/#transcription)        | Optional      |"
  },
  "response": [
    {
      "name": "Start Recording a Conference",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"file_format\":\"mp3\",\n    \"transcription_type\":\"auto\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Conference/{conference_name}/Record/",
          "protocol": "https",
          "host": [
            "api",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Account",
            "{{auth_id}}",
            "Conference",
            "{conference_name}",
            "Record",
            ""
          ]
        }
      },
      "code": 202,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n\t\"api_id\": \"2867b6e2-58c3-11e1-86da-adf28403fe48\",\n\t\"message\": \"conference recording started\",\n\t\"recording_id\": \"93bc7c6a-3b2b-11e3\",\n\t\"url\": \"http://s3.amazonaws.com/recordings_2013/93bc7c6a-3b2b-11e3.mp3\",\n}"
    }
  ]
}