Start Call Recording
plivo.record_call
ActionVoice & SMSconnection required
Calls the Plivo API with the connection's credentials.
Start recording a call that is already in progress; Plivo returns the recording id and the URL the finished file will be stored at.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Username & password
- Providers
- Plivo
- Secret shape
- {"username": "<Auth ID>", "password": "<Auth Token>"}
- Config it needs
- auth_id, src, answer_url, base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
7 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
call_uuid The identifier of the call to act on, as returned by a call lookup. | string | Yes | — | — | 4d04c52e-cea3-4458-bbdb-0bfc314ee7cd |
time_limit Maximum length of the recording in seconds. | number | No | — | ≥ 1 | — |
file_format The audio format Plivo stores the recording in. | string | No | — | one of "mp3", "wav" | — |
transcription_type The transcription type to request, written exactly as Plivo names it. Leave blank for no transcription. | string | No | — | — | — |
transcription_url URL Plivo posts the finished transcription to. | string | Conditional | — | url format; only with transcription_type | — |
callback_url URL Plivo posts the finished recording's details to. | string | No | — | url format | — |
callback_method The HTTP verb Plivo uses when it calls the callback URL. | string | Conditional | — | one of "GET", "POST"; only with callback_url | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"call_uuid": "4d04c52e-cea3-4458-bbdb-0bfc314ee7cd"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
recording_id Plivo's identifier for the new recording. | string | — |
url Where the finished recording file will be stored. | string | — |
call_uuid The call being recorded. | string | — |
message Plivo's acknowledgement text, such as 'call transfered'. | string | — |
api_id Plivo's identifier for this API request. | string | — |
response The acknowledgement exactly as Plivo returned it. | object | — |
{
"api_id": "",
"call_uuid": "",
"message": "",
"recording_id": "",
"response": {},
"url": ""
}See Start Call Recording run in a workflow.
In a technical demo we add the Plivo connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.