SchedulePlay allows you to schedule playing something to a Call or bridged leg or both legs.

Schedule Play Request URL

To schedule playing something to a call, make an HTTP POST to the below URL with the required parameters:

http://{BASEURL}/{ApiVersion}/SchedulePlay/

POST Parameters

Required Parameters

You must POST any of the following parameters:

Parameter Description
CallUUID A unique identifier of the call earlier returned by Plivo to which the action should be applied.
Sounds Comma separated list of sound files to play.
Time When playing sounds in seconds.
Optional Parameters

You may POST the following parameters:

Parameter Description
Legs ‘aleg’, ‘bleg’ or ‘both’. On which leg(s) to play something.
‘aleg’ means only play on the Call.
‘bleg’ means only play on the bridged leg of the Call.
‘both’ means play on the Call and the bridged leg of the Call.
Default is ‘aleg’ .
Length Max number of seconds to play sounds.
Mix ‘true’ or ‘false’. Mix with current audio stream (default ‘true’)

Response Parameters

When you initiate a RESTAPI, Plivo responds with the standard parameters as mentioned here. Along with that the following additional parameters are sent:

  • SchedPlayId: A unique identifier for this schedule play request. This is useful to cancel the schedule, if required.

Leave a Reply