asterisk/rest-api/api-docs/recordings.json

{
	"_copyright": "Copyright (C) 2012 - 2013, Digium, Inc.",
	"_author": "David M. Lee, II <dlee@digium.com>",
	"_svn_revision": "$Revision$",
	"apiVersion": "0.0.1",
	"swaggerVersion": "1.1",
	"basePath": "http://localhost:8088/stasis",
	"resourcePath": "/api-docs/recordings.{format}",
	"apis": [
		{
			"path": "/recordings/stored",
			"description": "Recordings",
			"operations": [
				{
					"httpMethod": "GET",
					"summary": "List recordings that are complete.",
					"nickname": "getStoredRecordings",
					"responseClass": "List[StoredRecording]"
				}
			]
		},
		{
			"path": "/recordings/stored/{recordingName}",
			"description": "Individual recording",
			"operations": [
				{
					"httpMethod": "GET",
					"summary": "Get a stored recording's details.",
					"nickname": "getStoredRecording",
					"responseClass": "StoredRecording",
					"parameters": [
						{
							"name": "recordingName",
							"description": "The name of the recording",
							"paramType": "path",
							"required": true,
							"allowMultiple": false,
							"dataType": "string"
						}
					]
				},
				{
					"httpMethod": "DELETE",
					"summary": "Delete a stored recording.",
					"nickname": "deleteStoredRecording",
					"responseClass": "void",
					"parameters": [
						{
							"name": "recordingName",
							"description": "The name of the recording",
							"paramType": "path",
							"required": true,
							"allowMultiple": false,
							"dataType": "string"
						}
					]
				}
			]
		},
		{
			"path": "/recordings/live",
			"description": "Recordings that are in progress",
			"operations": [
				{
					"httpMethod": "GET",
					"summary": "List libe recordings.",
					"nickname": "getLiveRecordings",
					"responseClass": "List[LiveRecording]"
				}
			]
		},
		{
			"path": "/recordings/live/{recordingName}",
			"description": "A recording that is in progress",
			"operations": [
				{
					"httpMethod": "GET",
					"summary": "List live recordings.",
					"nickname": "getLiveRecording",
					"responseClass": "LiveRecording",
					"parameters": [
						{
							"name": "recordingName",
							"description": "The name of the recording",
							"paramType": "path",
							"required": true,
							"allowMultiple": false,
							"dataType": "string"
						}
					]
				},
				{
					"httpMethod": "DELETE",
					"summary": "Stop a live recording and discard it.",
					"nickname": "cancelRecording",
					"responseClass": "void",
					"parameters": [
						{
							"name": "recordingName",
							"description": "The name of the recording",
							"paramType": "path",
							"required": true,
							"allowMultiple": false,
							"dataType": "string"
						}
					]
				}
			]
		},
		{
			"path": "/recordings/live/{recordingName}/stop",
			"operations": [
				{
					"httpMethod": "POST",
					"summary": "Stop a live recording and store it.",
					"nickname": "stopRecording",
					"responseClass": "void",
					"parameters": [
						{
							"name": "recordingName",
							"description": "The name of the recording",
							"paramType": "path",
							"required": true,
							"allowMultiple": false,
							"dataType": "string"
						}
					]
				}
			]
		},
		{
			"path": "/recordings/live/{recordingName}/pause",
			"operations": [
				{
					"httpMethod": "POST",
					"summary": "Pause a live recording.",
					"notes": "Pausing a recording suspends silence detection, which will be restarted when the recording is unpaused.",
					"nickname": "pauseRecording",
					"responseClass": "void",
					"parameters": [
						{
							"name": "recordingName",
							"description": "The name of the recording",
							"paramType": "path",
							"required": true,
							"allowMultiple": false,
							"dataType": "string"
						}
					]
				}
			]
		},
		{
			"path": "/recordings/live/{recordingName}/unpause",
			"operations": [
				{
					"httpMethod": "POST",
					"summary": "Unpause a live recording.",
					"nickname": "unpauseRecording",
					"responseClass": "void",
					"parameters": [
						{
							"name": "recordingName",
							"description": "The name of the recording",
							"paramType": "path",
							"required": true,
							"allowMultiple": false,
							"dataType": "string"
						}
					]
				}
			]
		},
		{
			"path": "/recordings/live/{recordingName}/mute",
			"operations": [
				{
					"httpMethod": "POST",
					"summary": "Mute a live recording.",
					"notes": "Muting a recording suspends silence detection, which will be restarted when the recording is unmuted.",
					"nickname": "muteRecording",
					"responseClass": "void",
					"parameters": [
						{
							"name": "recordingName",
							"description": "The name of the recording",
							"paramType": "path",
							"required": true,
							"allowMultiple": false,
							"dataType": "string"
						}
					]
				}
			]
		},
		{
			"path": "/recordings/live/{recordingName}/unmute",
			"operations": [
				{
					"httpMethod": "POST",
					"summary": "Unmute a live recording.",
					"nickname": "unmuteRecording",
					"responseClass": "void",
					"parameters": [
						{
							"name": "recordingName",
							"description": "The name of the recording",
							"paramType": "path",
							"required": true,
							"allowMultiple": false,
							"dataType": "string"
						}
					]
				}
			]
		}
	],
	"models": {
		"StoredRecording": {
			"id": "StoredRecording",
			"description": "A past recording that may be played back.",
			"properties": {
				"id": {
					"required": true,
					"type": "string"
				},
				"formats": {
					"required": true,
					"type": "List[string]"
				},
				"duration_seconds": {
					"required": false,
					"type": "int"
				},
				"time": {
					"description": "Time recording was started",
					"required": false,
					"type": "Date"
				}
			}
		},
		"LiveRecording": {
			"id": "LiveRecording",
			"description": "A recording that is in progress",
			"properties": {
				"id": {
					"required": true,
					"type": "string"
				}
			}
		}
	}
}