Play Audio On Call
plivo.play_on_call
ActionVoice & SMSconnection required
Calls the Plivo API with the connection's credentials.
Play one or more audio files into a call that is already in progress.
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
6 fields, 2 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 |
urls Publicly reachable URLs of the audio files to play, in order, as a JSON array or a comma-separated list. | array | Yes | — | ≥ 1 characters; array of string | ["https://example.com/audio/hold.mp3"] |
length Maximum seconds to keep playing before moving on. | number | No | — | ≥ 1 | — |
legs Which side of the call this applies to: the caller (aleg), the callee (bleg), or both. | string | No | — | one of "aleg", "bleg", "both" | — |
loop How many times to repeat. Leave blank to play or speak once. | number | No | — | ≥ 1 | — |
mix True to mix this audio with the ongoing call audio, false to play it alone. | boolean | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"call_uuid": "4d04c52e-cea3-4458-bbdb-0bfc314ee7cd",
"urls": [
"https://example.com/audio/hold.mp3"
]
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
call_uuid The call played into. | 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": "",
"response": {}
}See Play Audio On Call 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.