* Dump a git blame of each file in rest-api/api-docs.
* Get the commit for each "resourcePath" and "httpMethod" entry.
* Find the tags for each commit (same as other processes).
* Insert a "since" array after each "resourcePath" and "httpMethod" entry.
"summary":"Subscribe an application to a event source.",
"notes":"Returns the state of the application after the subscriptions have changed",
"nickname":"subscribe",
@ -92,6 +104,9 @@
},
{
"httpMethod":"DELETE",
"since":[
"13.0.0"
],
"summary":"Unsubscribe an application from an event source.",
"notes":"Returns the state of the application after the subscriptions have changed",
"nickname":"unsubscribe",
@ -141,6 +156,10 @@
"operations":[
{
"httpMethod":"PUT",
"since":[
"13.26.0",
"16.3.0"
],
"summary":"Filter application events types.",
"notes":"Allowed and/or disallowed event type filtering can be done. The body (parameter) should specify a JSON key/value object that describes the type of event filtering needed. One, or both of the following keys can be designated:<br /><br />\"allowed\" - Specifies an allowed list of event types<br />\"disallowed\" - Specifies a disallowed list of event types<br /><br />Further, each of those key's value should be a JSON array that holds zero, or more JSON key/value objects. Each of these objects must contain the following key with an associated value:<br /><br />\"type\" - The type name of the event to filter<br /><br />The value must be the string name (case sensitive) of the event type that needs filtering. For example:<br /><br />{ \"allowed\": [ { \"type\": \"StasisStart\" }, { \"type\": \"StasisEnd\" } ] }<br /><br />As this specifies only an allowed list, then only those two event type messages are sent to the application. No other event messages are sent.<br /><br />The following rules apply:<br /><br />* If the body is empty, both the allowed and disallowed filters are set empty.<br />* If both list types are given then both are set to their respective values (note, specifying an empty array for a given type sets that type to empty).<br />* If only one list type is given then only that type is set. The other type is not updated.<br />* An empty \"allowed\" list means all events are allowed.<br />* An empty \"disallowed\" list means no events are disallowed.<br />* Disallowed events take precedence over allowed events if the event type is specified in both lists.",
"notes":"This bridge persists until it has been shut down, or Asterisk has been shut down.",
"nickname":"create",
@ -62,6 +71,9 @@
"operations":[
{
"httpMethod":"POST",
"since":[
"12.2.0"
],
"summary":"Create a new bridge or updates an existing one.",
"notes":"This bridge persists until it has been shut down, or Asterisk has been shut down.",
"nickname":"createWithId",
@ -95,6 +107,9 @@
},
{
"httpMethod":"GET",
"since":[
"12.0.0"
],
"summary":"Get bridge details.",
"nickname":"get",
"responseClass":"Bridge",
@ -117,6 +132,9 @@
},
{
"httpMethod":"DELETE",
"since":[
"12.0.0"
],
"summary":"Shut down a bridge.",
"notes":"If any channels are in this bridge, they will be removed and resume whatever they were doing beforehand.",
"nickname":"destroy",
@ -146,6 +164,9 @@
"operations":[
{
"httpMethod":"POST",
"since":[
"12.0.0"
],
"summary":"Add a channel to a bridge.",
"nickname":"addChannel",
"responseClass":"void",
@ -229,6 +250,9 @@
"operations":[
{
"httpMethod":"POST",
"since":[
"12.0.0"
],
"summary":"Remove a channel from a bridge.",
"nickname":"removeChannel",
"responseClass":"void",
@ -277,6 +301,10 @@
"operations":[
{
"httpMethod":"POST",
"since":[
"13.13.0",
"14.2.0"
],
"summary":"Set a channel as the video source in a multi-party mixing bridge. This operation has no effect on bridges with two or fewer participants.",
"nickname":"setVideoSource",
"responseClass":"void",
@ -321,6 +349,10 @@
"operations":[
{
"httpMethod":"DELETE",
"since":[
"13.13.0",
"14.2.0"
],
"summary":"Removes any explicit video source in a multi-party mixing bridge. This operation has no effect on bridges with two or fewer participants. When no explicit video source is set, talk detection will be used to determine the active video stream.",
"nickname":"clearVideoSource",
"responseClass":"void",
@ -349,6 +381,9 @@
"operations":[
{
"httpMethod":"POST",
"since":[
"12.0.0"
],
"summary":"Play music on hold to a bridge or change the MOH class that is playing.",
"nickname":"startMoh",
"responseClass":"void",
@ -383,6 +418,9 @@
},
{
"httpMethod":"DELETE",
"since":[
"12.0.0"
],
"summary":"Stop playing music on hold to a bridge.",
"notes":"This will only stop music on hold being played via POST bridges/{bridgeId}/moh.",
"nickname":"stopMoh",
@ -416,6 +454,9 @@
"operations":[
{
"httpMethod":"POST",
"since":[
"12.0.0"
],
"summary":"Start playback of media on a bridge.",
"notes":"The media URI may be any of a number of URI's. Currently sound:, recording:, number:, digits:, characters:, and tone: URI's are supported. This operation creates a playback resource that can be used to control the playback of media (pause, rewind, fast forward, etc.)",
"nickname":"play",
@ -500,6 +541,9 @@
"operations":[
{
"httpMethod":"POST",
"since":[
"12.3.0"
],
"summary":"Start playback of media on a bridge.",
"notes":"The media URI may be any of a number of URI's. Currently sound:, recording:, number:, digits:, characters:, and tone: URI's are supported. This operation creates a playback resource that can be used to control the playback of media (pause, rewind, fast forward, etc.)",
"nickname":"playWithId",
@ -584,6 +628,9 @@
"operations":[
{
"httpMethod":"POST",
"since":[
"12.0.0"
],
"summary":"Start a recording.",
"notes":"This records the mixed audio from all channels participating in this bridge.",
"summary":"List all active channels in Asterisk.",
"nickname":"list",
"responseClass":"List[Channel]"
},
{
"httpMethod":"POST",
"since":[
"12.0.0"
],
"summary":"Create a new channel (originate).",
"notes":"The new channel is created immediately and a snapshot of it returned. If a Stasis application is provided it will be automatically subscribed to the originated channel for further events and updates.",
"nickname":"originate",
@ -163,6 +172,9 @@
"operations":[
{
"httpMethod":"POST",
"since":[
"14.0.0"
],
"summary":"Create channel.",
"nickname":"create",
"responseClass":"Channel",
@ -247,6 +259,9 @@
"operations":[
{
"httpMethod":"GET",
"since":[
"12.0.0"
],
"summary":"Channel details.",
"nickname":"get",
"responseClass":"Channel",
@ -269,6 +284,9 @@
},
{
"httpMethod":"POST",
"since":[
"12.2.0"
],
"summary":"Create a new channel (originate with id).",
"notes":"The new channel is created immediately and a snapshot of it returned. If a Stasis application is provided it will be automatically subscribed to the originated channel for further events and updates.",
"nickname":"originateWithId",
@ -402,6 +420,9 @@
},
{
"httpMethod":"DELETE",
"since":[
"12.0.0"
],
"summary":"Delete (i.e. hangup) a channel.",
"nickname":"hangup",
"responseClass":"void",
@ -468,6 +489,9 @@
"operations":[
{
"httpMethod":"POST",
"since":[
"12.0.0"
],
"summary":"Exit application; continue execution in the dialplan.",
"nickname":"continueInDialplan",
"responseClass":"void",
@ -536,6 +560,10 @@
"operations":[
{
"httpMethod":"POST",
"since":[
"13.26.0",
"16.3.0"
],
"summary":"Move the channel from one Stasis application to another.",
"nickname":"move",
"responseClass":"void",
@ -584,6 +612,9 @@
"operations":[
{
"httpMethod":"POST",
"since":[
"13.3.0"
],
"summary":"Redirect the channel to a different location.",
"nickname":"redirect",
"responseClass":"void",
@ -636,6 +667,9 @@
"operations":[
{
"httpMethod":"POST",
"since":[
"12.0.0"
],
"summary":"Answer a channel.",
"nickname":"answer",
"responseClass":"void",
@ -672,6 +706,9 @@
"operations":[
{
"httpMethod":"POST",
"since":[
"12.0.0"
],
"summary":"Indicate ringing to a channel.",
"nickname":"ring",
"responseClass":"void",
@ -702,6 +739,9 @@
},
{
"httpMethod":"DELETE",
"since":[
"12.0.0"
],
"summary":"Stop ringing indication on a channel if locally generated.",
"nickname":"ringStop",
"responseClass":"void",
@ -738,6 +778,9 @@
"operations":[
{
"httpMethod":"POST",
"since":[
"12.0.0"
],
"summary":"Send provided DTMF to a given channel.",
"nickname":"sendDTMF",
"responseClass":"void",
@ -822,6 +865,9 @@
"operations":[
{
"httpMethod":"POST",
"since":[
"12.0.0"
],
"summary":"Mute a channel.",
"nickname":"mute",
"responseClass":"void",
@ -869,6 +915,9 @@
},
{
"httpMethod":"DELETE",
"since":[
"12.0.0"
],
"summary":"Unmute a channel.",
"nickname":"unmute",
"responseClass":"void",
@ -922,6 +971,9 @@
"operations":[
{
"httpMethod":"POST",
"since":[
"12.0.0"
],
"summary":"Hold a channel.",
"nickname":"hold",
"responseClass":"void",
@ -952,6 +1004,9 @@
},
{
"httpMethod":"DELETE",
"since":[
"12.0.0"
],
"summary":"Remove a channel from hold.",
"nickname":"unhold",
"responseClass":"void",
@ -988,6 +1043,9 @@
"operations":[
{
"httpMethod":"POST",
"since":[
"12.0.0"
],
"summary":"Play music on hold to a channel.",
"notes":"Using media operations such as /play on a channel playing MOH in this manner will suspend MOH without resuming automatically. If continuing music on hold is desired, the stasis application must reinitiate music on hold.",
"nickname":"startMoh",
@ -1027,6 +1085,9 @@
},
{
"httpMethod":"DELETE",
"since":[
"12.0.0"
],
"summary":"Stop playing music on hold to a channel.",
"nickname":"stopMoh",
"responseClass":"void",
@ -1063,6 +1124,9 @@
"operations":[
{
"httpMethod":"POST",
"since":[
"12.0.0"
],
"summary":"Play silence to a channel.",
"notes":"Using media operations such as /play on a channel playing silence in this manner will suspend silence without resuming automatically.",
"nickname":"startSilence",
@ -1094,6 +1158,9 @@
},
{
"httpMethod":"DELETE",
"since":[
"12.0.0"
],
"summary":"Stop playing silence to a channel.",
"nickname":"stopSilence",
"responseClass":"void",
@ -1130,6 +1197,9 @@
"operations":[
{
"httpMethod":"POST",
"since":[
"12.0.0"
],
"summary":"Start playback of media.",
"notes":"The media URI may be any of a number of URI's. Currently sound:, recording:, number:, digits:, characters:, and tone: URI's are supported. This operation creates a playback resource that can be used to control the playback of media (pause, rewind, fast forward, etc.)",
"nickname":"play",
@ -1208,6 +1278,9 @@
"operations":[
{
"httpMethod":"POST",
"since":[
"12.2.0"
],
"summary":"Start playback of media and specify the playbackId.",
"notes":"The media URI may be any of a number of URI's. Currently sound:, recording:, number:, digits:, characters:, and tone: URI's are supported. This operation creates a playback resource that can be used to control the playback of media (pause, rewind, fast forward, etc.)",
"nickname":"playWithId",
@ -1286,6 +1359,9 @@
"operations":[
{
"httpMethod":"POST",
"since":[
"12.0.0"
],
"summary":"Start a recording.",
"notes":"Record audio from a channel. Note that this will not capture audio sent to the channel. The bridge itself has a record feature if that's what you want.",
"nickname":"record",
@ -1413,6 +1489,9 @@
"operations":[
{
"httpMethod":"GET",
"since":[
"12.0.0"
],
"summary":"Get the value of a channel variable or function.",
"nickname":"getChannelVar",
"responseClass":"Variable",
@ -1451,6 +1530,9 @@
},
{
"httpMethod":"POST",
"since":[
"12.0.0"
],
"summary":"Set the value of a channel variable or function.",
"nickname":"setChannelVar",
"responseClass":"void",
@ -1503,6 +1585,9 @@
"operations":[
{
"httpMethod":"POST",
"since":[
"12.0.0"
],
"summary":"Start snooping.",
"notes":"Snoop (spy/whisper) on a specific channel.",
"nickname":"snoopChannel",
@ -1596,6 +1681,9 @@
"operations":[
{
"httpMethod":"POST",
"since":[
"12.2.0"
],
"summary":"Start snooping.",
"notes":"Snoop (spy/whisper) on a specific channel.",
"nickname":"snoopChannelWithId",
@ -1689,6 +1777,9 @@
"operations":[
{
"httpMethod":"POST",
"since":[
"14.0.0"
],
"summary":"Dial a created channel.",
"nickname":"dial",
"responseClass":"void",
@ -1742,6 +1833,10 @@
"operations":[
{
"httpMethod":"GET",
"since":[
"13.27.0",
"16.4.0"
],
"summary":"RTP stats on a channel.",
"nickname":"rtpstatistics",
"responseClass":"RTPstat",
@ -1770,6 +1865,10 @@
"operations":[
{
"httpMethod":"POST",
"since":[
"16.6.0",
"17.1.0"
],
"summary":"Start an External Media session.",
"notes":"Create a channel to an External Media source/sink.",
"summary":"Get the file associated with the stored recording.",
"nickname":"getStoredFile",
"responseClass":"binary",
@ -110,6 +125,9 @@
"operations":[
{
"httpMethod":"POST",
"since":[
"12.5.0"
],
"summary":"Copy a stored recording.",
"nickname":"copyStored",
"responseClass":"StoredRecording",
@ -150,6 +168,9 @@
"operations":[
{
"httpMethod":"GET",
"since":[
"12.0.0"
],
"summary":"List live recordings.",
"nickname":"getLive",
"responseClass":"LiveRecording",
@ -172,6 +193,9 @@
},
{
"httpMethod":"DELETE",
"since":[
"12.0.0"
],
"summary":"Stop a live recording and discard it.",
"nickname":"cancel",
"responseClass":"void",
@ -199,6 +223,9 @@
"operations":[
{
"httpMethod":"POST",
"since":[
"12.0.0"
],
"summary":"Stop a live recording and store it.",
"nickname":"stop",
"responseClass":"void",
@ -226,6 +253,9 @@
"operations":[
{
"httpMethod":"POST",
"since":[
"12.0.0"
],
"summary":"Pause a live recording.",
"notes":"Pausing a recording suspends silence detection, which will be restarted when the recording is unpaused. Paused time is not included in the accounting for maxDurationSeconds.",
"nickname":"pause",
@ -253,6 +283,9 @@
},
{
"httpMethod":"DELETE",
"since":[
"12.0.0"
],
"summary":"Unpause a live recording.",
"nickname":"unpause",
"responseClass":"void",
@ -284,6 +317,9 @@
"operations":[
{
"httpMethod":"POST",
"since":[
"12.0.0"
],
"summary":"Mute a live recording.",
"notes":"Muting a recording suspends silence detection, which will be restarted when the recording is unmuted.",
George Joseph
3 months ago