[asterisk-commits] dlee: branch dlee/stasis-http r385263 - /team/dlee/stasis-http/rest-api/api-d...

[SVN commits to the Asterisk project]

Author: dlee
Date: Wed Apr 10 13:57:07 2013
New Revision: 385263

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=385263
Log:
Added docs for DTMF event. Sorted event types.

Modified:
    team/dlee/stasis-http/rest-api/api-docs/events.json

Modified: team/dlee/stasis-http/rest-api/api-docs/events.json
URL: http://svnview.digium.com/svn/asterisk/team/dlee/stasis-http/rest-api/api-docs/events.json?view=diff&rev=385263&r1=385262&r2=385263
==============================================================================
--- team/dlee/stasis-http/rest-api/api-docs/events.json (original)
+++ team/dlee/stasis-http/rest-api/api-docs/events.json Wed Apr 10 13:57:07 2013
@@ -53,45 +53,15 @@
 					"description": "Name of the application receiving the event.",
 					"required": true
 				},
-				"stasis_start": { "type": "StasisStart" },
-				"stasis_end": { "type": "StasisEnd" },
-				"channel_state_change": { "type": "ChannelStateChange" },
 				"application_replaced": { "type": "ApplicationReplaced" },
 				"bridge_created": { "type": "BridgeCreated" },
 				"bridge_destroyed": { "type": "BridgeDestroyed" },
 				"channel_entered_bridge": { "type": "ChannelEnteredBridge" },
-				"channel_left_bridge": { "type": "ChannelLeftBridge" }
-			}
-		},
-		"StasisStart": {
-			"id": "StasisStart",
-			"description": "Notification that a channel has entered a Stasis appliction.",
-			"properties": {
-				"args": {
-					"type": "List[string]",
-					"description": "Arguments to the application"
-				},
-				"channel_info": {
-					"type": "Channel"
-				}
-			}
-		},
-		"StasisEnd": {
-			"id": "StasisEnd",
-			"description": "Notification that a channel has left a Stasis appliction.",
-			"properties": {
-				"channel_info": {
-					"type": "Channel"
-				}
-			}
-		},
-		"ChannelStateChange": {
-			"id": "ChannelStateChange",
-			"description": "Notification of a channel's state change.",
-			"properties": {
-				"channel_info": {
-					"type": "Channel"
-				}
+				"channel_left_bridge": { "type": "ChannelLeftBridge" },
+				"channel_state_change": { "type": "ChannelStateChange" },
+				"dtmf_received": { "type": "DtmfReceived" },
+				"stasis_end": { "type": "StasisEnd" },
+				"stasis_start": { "type": "StasisStart" }
 			}
 		},
 		"ApplicationReplaced": {
@@ -145,6 +115,52 @@
 					"type": "Channel"
 				}
 			}
+		},
+		"ChannelStateChange": {
+			"id": "ChannelStateChange",
+			"description": "Notification of a channel's state change.",
+			"properties": {
+				"channel_info": {
+					"type": "Channel"
+				}
+			}
+		},
+		"DtmfReceived": {
+			"id": "DtmfReceived",
+			"description": "DTMF received on a channel.",
+			"notes": "This event is sent when the DTMF ends. There is no notification about the start of DTMF",
+			"properties": {
+				"digit": {
+					"type": "string",
+					"description": "DTMF digit received (0-9, A-E, # or *)"
+				},
+				"channel": {
+					"type": "Channel",
+					"description": "The channel on which DTMF was received"
+				}
+			}
+		},
+		"StasisEnd": {
+			"id": "StasisEnd",
+			"description": "Notification that a channel has left a Stasis appliction.",
+			"properties": {
+				"channel_info": {
+					"type": "Channel"
+				}
+			}
+		},
+		"StasisStart": {
+			"id": "StasisStart",
+			"description": "Notification that a channel has entered a Stasis appliction.",
+			"properties": {
+				"args": {
+					"type": "List[string]",
+					"description": "Arguments to the application"
+				},
+				"channel_info": {
+					"type": "Channel"
+				}
+			}
 		}
 	}
 }