Sign in

v1

latestOpenAPI 3.0.02026-07-13316378.3 KB
Call

/v0.1/SchedulePlay/

Schedules media playback for a specific call

post/v0.1/SchedulePlay/

Response

Response

Message'Play Executed' | 'CallUUID Parameter Missing' | 'Sounds Parameter Missing' | 'Time Parameter Missing' | 'Time Parameter must be > 0' | 'Legs Parameter is Invalid' | 'Length Parameter must be a positive integer' | 'Sounds Parameter is Invalid' | 'Play Failed -- Call not found' | 'Play Failed' required

Response message

Successboolean required

Whether the request was successful or not

SchedPlayIdstring required

Unique identifier of the scheduled playback request (UUIDv4)

Example response

{
  "Message": "Play Executed",
  "Success": true,
  "SchedPlayId": "b2d1da90-c364-42e4-818a-2eb90a474729"
}