123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155 |
- {
- "_copyright": "Copyright (C) 2012 - 2013, Digium, Inc.",
- "_author": "David M. Lee, II <dlee@digium.com>",
- "_svn_revision": "$Revision$",
- "apiVersion": "1.10.0",
- "swaggerVersion": "1.1",
- "basePath": "http://localhost:8088/ari",
- "resourcePath": "/api-docs/playbacks.{format}",
- "apis": [
- {
- "path": "/playbacks/{playbackId}",
- "description": "Control object for a playback operation.",
- "operations": [
- {
- "httpMethod": "GET",
- "summary": "Get a playback's details.",
- "nickname": "get",
- "responseClass": "Playback",
- "parameters": [
- {
- "name": "playbackId",
- "description": "Playback's id",
- "paramType": "path",
- "required": true,
- "allowMultiple": false,
- "dataType": "string"
- }
- ],
- "errorResponses": [
- {
- "code": 404,
- "reason": "The playback cannot be found"
- }
- ]
- },
- {
- "httpMethod": "DELETE",
- "summary": "Stop a playback.",
- "nickname": "stop",
- "responseClass": "void",
- "parameters": [
- {
- "name": "playbackId",
- "description": "Playback's id",
- "paramType": "path",
- "required": true,
- "allowMultiple": false,
- "dataType": "string"
- }
- ],
- "errorResponses": [
- {
- "code": 404,
- "reason": "The playback cannot be found"
- }
- ]
- }
- ]
- },
- {
- "path": "/playbacks/{playbackId}/control",
- "description": "Control object for a playback operation.",
- "operations": [
- {
- "httpMethod": "POST",
- "summary": "Control a playback.",
- "nickname": "control",
- "responseClass": "void",
- "parameters": [
- {
- "name": "playbackId",
- "description": "Playback's id",
- "paramType": "path",
- "required": true,
- "allowMultiple": false,
- "dataType": "string"
- },
- {
- "name": "operation",
- "description": "Operation to perform on the playback.",
- "paramType": "query",
- "required": true,
- "allowMultiple": false,
- "dataType": "string",
- "allowableValues": {
- "valueType": "LIST",
- "values": [
- "restart",
- "pause",
- "unpause",
- "reverse",
- "forward"
- ]
- }
- }
- ],
- "errorResponses": [
- {
- "code": 400,
- "reason": "The provided operation parameter was invalid"
- },
- {
- "code": 404,
- "reason": "The playback cannot be found"
- },
- {
- "code": 409,
- "reason": "The operation cannot be performed in the playback's current state"
- }
- ]
- }
- ]
- }
- ],
- "models": {
- "Playback": {
- "id": "Playback",
- "description": "Object representing the playback of media to a channel",
- "properties": {
- "id": {
- "type": "string",
- "description": "ID for this playback operation",
- "required": true
- },
- "media_uri": {
- "type": "string",
- "description": "URI for the media to play back.",
- "required": true
- },
- "target_uri": {
- "type": "string",
- "description": "URI for the channel or bridge to play the media on",
- "required": true
- },
- "language": {
- "type": "string",
- "description": "For media types that support multiple languages, the language requested for playback."
- },
- "state": {
- "type": "string",
- "description": "Current state of the playback operation.",
- "required": true,
- "allowableValues": {
- "valueType": "LIST",
- "values": [
- "queued",
- "playing",
- "complete"
- ]
- }
- }
- }
- }
- }
- }
|