github.com/CyCoreSystems/ari@v4.8.4+incompatible/internal/eventgen/json/events-1.7.0.json (about)

     1  {
     2     "_author" : "David M. Lee, II <dlee@digium.com>",
     3     "_copyright" : "Copyright (C) 2012 - 2013, Digium, Inc.",
     4     "basePath" : "http://localhost:8088/ari",
     5     "apiVersion" : "1.7.0",
     6     "models" : {
     7        "StasisEnd" : {
     8           "description" : "Notification that a channel has left a Stasis application.",
     9           "properties" : {
    10              "channel" : {
    11                 "required" : true,
    12                 "type" : "Channel"
    13              }
    14           },
    15           "id" : "StasisEnd"
    16        },
    17        "BridgeAttendedTransfer" : {
    18           "id" : "BridgeAttendedTransfer",
    19           "description" : "Notification that an attended transfer has occurred.",
    20           "properties" : {
    21              "destination_link_first_leg" : {
    22                 "description" : "First leg of a link transfer result",
    23                 "type" : "Channel"
    24              },
    25              "destination_threeway_bridge" : {
    26                 "description" : "Bridge that survived the threeway result",
    27                 "type" : "Bridge"
    28              },
    29              "destination_link_second_leg" : {
    30                 "type" : "Channel",
    31                 "description" : "Second leg of a link transfer result"
    32              },
    33              "transferee" : {
    34                 "required" : false,
    35                 "description" : "The channel that is being transferred",
    36                 "type" : "Channel"
    37              },
    38              "transferer_first_leg_bridge" : {
    39                 "type" : "Bridge",
    40                 "description" : "Bridge the transferer first leg is in"
    41              },
    42              "is_external" : {
    43                 "required" : true,
    44                 "type" : "boolean",
    45                 "description" : "Whether the transfer was externally initiated or not"
    46              },
    47              "transfer_target" : {
    48                 "required" : false,
    49                 "description" : "The channel that is being transferred to",
    50                 "type" : "Channel"
    51              },
    52              "result" : {
    53                 "required" : true,
    54                 "type" : "string",
    55                 "description" : "The result of the transfer attempt"
    56              },
    57              "transferer_second_leg_bridge" : {
    58                 "type" : "Bridge",
    59                 "description" : "Bridge the transferer second leg is in"
    60              },
    61              "transferer_second_leg" : {
    62                 "description" : "Second leg of the transferer",
    63                 "type" : "Channel",
    64                 "required" : true
    65              },
    66              "destination_application" : {
    67                 "type" : "string",
    68                 "description" : "Application that has been transferred into"
    69              },
    70              "destination_type" : {
    71                 "required" : true,
    72                 "description" : "How the transfer was accomplished",
    73                 "type" : "string"
    74              },
    75              "transferer_first_leg" : {
    76                 "description" : "First leg of the transferer",
    77                 "type" : "Channel",
    78                 "required" : true
    79              },
    80              "replace_channel" : {
    81                 "description" : "The channel that is replacing transferer_first_leg in the swap",
    82                 "type" : "Channel",
    83                 "required" : false
    84              },
    85              "destination_bridge" : {
    86                 "type" : "string",
    87                 "description" : "Bridge that survived the merge result"
    88              },
    89              "destination_threeway_channel" : {
    90                 "description" : "Transferer channel that survived the threeway result",
    91                 "type" : "Channel"
    92              }
    93           }
    94        },
    95        "Peer" : {
    96           "properties" : {
    97              "time" : {
    98                 "required" : false,
    99                 "type" : "string",
   100                 "description" : "The last known time the peer was contacted."
   101              },
   102              "address" : {
   103                 "description" : "The IP address of the peer.",
   104                 "type" : "string",
   105                 "required" : false
   106              },
   107              "cause" : {
   108                 "description" : "An optional reason associated with the change in peer_status.",
   109                 "type" : "string",
   110                 "required" : false
   111              },
   112              "peer_status" : {
   113                 "type" : "string",
   114                 "description" : "The current state of the peer. Note that the values of the status are dependent on the underlying peer technology.",
   115                 "required" : true
   116              },
   117              "port" : {
   118                 "description" : "The port of the peer.",
   119                 "type" : "string",
   120                 "required" : false
   121              }
   122           },
   123           "description" : "Detailed information about a remote peer that communicates with Asterisk.",
   124           "id" : "Peer"
   125        },
   126        "ChannelVarset" : {
   127           "properties" : {
   128              "channel" : {
   129                 "type" : "Channel",
   130                 "description" : "The channel on which the variable was set.\n\nIf missing, the variable is a global variable.",
   131                 "required" : false
   132              },
   133              "variable" : {
   134                 "description" : "The variable that changed.",
   135                 "type" : "string",
   136                 "required" : true
   137              },
   138              "value" : {
   139                 "required" : true,
   140                 "description" : "The new value of the variable.",
   141                 "type" : "string"
   142              }
   143           },
   144           "description" : "Channel variable changed.",
   145           "id" : "ChannelVarset"
   146        },
   147        "Dial" : {
   148           "id" : "Dial",
   149           "properties" : {
   150              "peer" : {
   151                 "required" : true,
   152                 "type" : "Channel",
   153                 "description" : "The dialed channel."
   154              },
   155              "forwarded" : {
   156                 "required" : false,
   157                 "description" : "Channel that the caller has been forwarded to.",
   158                 "type" : "Channel"
   159              },
   160              "caller" : {
   161                 "required" : false,
   162                 "description" : "The calling channel.",
   163                 "type" : "Channel"
   164              },
   165              "forward" : {
   166                 "required" : false,
   167                 "type" : "string",
   168                 "description" : "Forwarding target requested by the original dialed channel."
   169              },
   170              "dialstring" : {
   171                 "type" : "string",
   172                 "description" : "The dial string for calling the peer channel.",
   173                 "required" : false
   174              },
   175              "dialstatus" : {
   176                 "type" : "string",
   177                 "description" : "Current status of the dialing attempt to the peer.",
   178                 "required" : true
   179              }
   180           },
   181           "description" : "Dialing state has changed."
   182        },
   183        "Message" : {
   184           "subTypes" : [
   185              "MissingParams",
   186              "Event"
   187           ],
   188           "description" : "Base type for errors and events",
   189           "properties" : {
   190              "type" : {
   191                 "type" : "string",
   192                 "description" : "Indicates the type of this message.",
   193                 "required" : true
   194              }
   195           },
   196           "discriminator" : "type",
   197           "id" : "Message"
   198        },
   199        "ChannelStateChange" : {
   200           "description" : "Notification of a channel's state change.",
   201           "properties" : {
   202              "channel" : {
   203                 "required" : true,
   204                 "type" : "Channel"
   205              }
   206           },
   207           "id" : "ChannelStateChange"
   208        },
   209        "DeviceStateChanged" : {
   210           "id" : "DeviceStateChanged",
   211           "properties" : {
   212              "device_state" : {
   213                 "type" : "DeviceState",
   214                 "description" : "Device state object",
   215                 "required" : true
   216              }
   217           },
   218           "description" : "Notification that a device state has changed."
   219        },
   220        "ChannelUnhold" : {
   221           "id" : "ChannelUnhold",
   222           "properties" : {
   223              "channel" : {
   224                 "type" : "Channel",
   225                 "description" : "The channel that initiated the unhold event.",
   226                 "required" : true
   227              }
   228           },
   229           "description" : "A channel initiated a media unhold."
   230        },
   231        "ChannelTalkingStarted" : {
   232           "id" : "ChannelTalkingStarted",
   233           "description" : "Talking was detected on the channel.",
   234           "properties" : {
   235              "channel" : {
   236                 "required" : true,
   237                 "description" : "The channel on which talking started.",
   238                 "type" : "Channel"
   239              }
   240           }
   241        },
   242        "StasisStart" : {
   243           "id" : "StasisStart",
   244           "properties" : {
   245              "channel" : {
   246                 "required" : true,
   247                 "type" : "Channel"
   248              },
   249              "args" : {
   250                 "type" : "List[string]",
   251                 "description" : "Arguments to the application",
   252                 "required" : true
   253              },
   254              "replace_channel" : {
   255                 "type" : "Channel",
   256                 "required" : false
   257              }
   258           },
   259           "description" : "Notification that a channel has entered a Stasis application."
   260        },
   261        "RecordingStarted" : {
   262           "id" : "RecordingStarted",
   263           "properties" : {
   264              "recording" : {
   265                 "description" : "Recording control object",
   266                 "type" : "LiveRecording",
   267                 "required" : true
   268              }
   269           },
   270           "description" : "Event showing the start of a recording operation."
   271        },
   272        "ChannelHangupRequest" : {
   273           "id" : "ChannelHangupRequest",
   274           "properties" : {
   275              "cause" : {
   276                 "type" : "int",
   277                 "description" : "Integer representation of the cause of the hangup."
   278              },
   279              "channel" : {
   280                 "required" : true,
   281                 "description" : "The channel on which the hangup was requested.",
   282                 "type" : "Channel"
   283              },
   284              "soft" : {
   285                 "type" : "boolean",
   286                 "description" : "Whether the hangup request was a soft hangup request."
   287              }
   288           },
   289           "description" : "A hangup was requested on the channel."
   290        },
   291        "ChannelUserevent" : {
   292           "id" : "ChannelUserevent",
   293           "properties" : {
   294              "channel" : {
   295                 "description" : "A channel that is signaled with the user event.",
   296                 "type" : "Channel",
   297                 "required" : false
   298              },
   299              "userevent" : {
   300                 "description" : "Custom Userevent data",
   301                 "type" : "object",
   302                 "required" : true
   303              },
   304              "eventname" : {
   305                 "type" : "string",
   306                 "description" : "The name of the user event.",
   307                 "required" : true
   308              },
   309              "endpoint" : {
   310                 "type" : "Endpoint",
   311                 "description" : "A endpoint that is signaled with the user event.",
   312                 "required" : false
   313              },
   314              "bridge" : {
   315                 "required" : false,
   316                 "description" : "A bridge that is signaled with the user event.",
   317                 "type" : "Bridge"
   318              }
   319           },
   320           "description" : "User-generated event with additional user-defined fields in the object."
   321        },
   322        "ContactStatusChange" : {
   323           "properties" : {
   324              "contact_info" : {
   325                 "required" : true,
   326                 "type" : "ContactInfo"
   327              },
   328              "endpoint" : {
   329                 "type" : "Endpoint",
   330                 "required" : true
   331              }
   332           },
   333           "description" : "The state of a contact on an endpoint has changed.",
   334           "id" : "ContactStatusChange"
   335        },
   336        "PeerStatusChange" : {
   337           "id" : "PeerStatusChange",
   338           "properties" : {
   339              "peer" : {
   340                 "required" : true,
   341                 "type" : "Peer"
   342              },
   343              "endpoint" : {
   344                 "required" : true,
   345                 "type" : "Endpoint"
   346              }
   347           },
   348           "description" : "The state of a peer associated with an endpoint has changed."
   349        },
   350        "PlaybackFinished" : {
   351           "description" : "Event showing the completion of a media playback operation.",
   352           "properties" : {
   353              "playback" : {
   354                 "type" : "Playback",
   355                 "description" : "Playback control object",
   356                 "required" : true
   357              }
   358           },
   359           "id" : "PlaybackFinished"
   360        },
   361        "BridgeMerged" : {
   362           "id" : "BridgeMerged",
   363           "properties" : {
   364              "bridge" : {
   365                 "required" : true,
   366                 "type" : "Bridge"
   367              },
   368              "bridge_from" : {
   369                 "required" : true,
   370                 "type" : "Bridge"
   371              }
   372           },
   373           "description" : "Notification that one bridge has merged into another."
   374        },
   375        "ChannelCallerId" : {
   376           "id" : "ChannelCallerId",
   377           "description" : "Channel changed Caller ID.",
   378           "properties" : {
   379              "caller_presentation" : {
   380                 "type" : "int",
   381                 "description" : "The integer representation of the Caller Presentation value.",
   382                 "required" : true
   383              },
   384              "caller_presentation_txt" : {
   385                 "type" : "string",
   386                 "description" : "The text representation of the Caller Presentation value.",
   387                 "required" : true
   388              },
   389              "channel" : {
   390                 "type" : "Channel",
   391                 "description" : "The channel that changed Caller ID.",
   392                 "required" : true
   393              }
   394           }
   395        },
   396        "ChannelCreated" : {
   397           "id" : "ChannelCreated",
   398           "properties" : {
   399              "channel" : {
   400                 "type" : "Channel",
   401                 "required" : true
   402              }
   403           },
   404           "description" : "Notification that a channel has been created."
   405        },
   406        "PlaybackStarted" : {
   407           "id" : "PlaybackStarted",
   408           "properties" : {
   409              "playback" : {
   410                 "description" : "Playback control object",
   411                 "type" : "Playback",
   412                 "required" : true
   413              }
   414           },
   415           "description" : "Event showing the start of a media playback operation."
   416        },
   417        "ChannelDialplan" : {
   418           "id" : "ChannelDialplan",
   419           "properties" : {
   420              "dialplan_app_data" : {
   421                 "description" : "The data to be passed to the application.",
   422                 "type" : "string",
   423                 "required" : true
   424              },
   425              "channel" : {
   426                 "required" : true,
   427                 "description" : "The channel that changed dialplan location.",
   428                 "type" : "Channel"
   429              },
   430              "dialplan_app" : {
   431                 "type" : "string",
   432                 "description" : "The application about to be executed.",
   433                 "required" : true
   434              }
   435           },
   436           "description" : "Channel changed location in the dialplan."
   437        },
   438        "EndpointStateChange" : {
   439           "properties" : {
   440              "endpoint" : {
   441                 "required" : true,
   442                 "type" : "Endpoint"
   443              }
   444           },
   445           "description" : "Endpoint state changed.",
   446           "id" : "EndpointStateChange"
   447        },
   448        "BridgeBlindTransfer" : {
   449           "id" : "BridgeBlindTransfer",
   450           "description" : "Notification that a blind transfer has occurred.",
   451           "properties" : {
   452              "context" : {
   453                 "required" : true,
   454                 "type" : "string",
   455                 "description" : "The context transferred to"
   456              },
   457              "is_external" : {
   458                 "required" : true,
   459                 "description" : "Whether the transfer was externally initiated or not",
   460                 "type" : "boolean"
   461              },
   462              "transferee" : {
   463                 "required" : false,
   464                 "type" : "Channel",
   465                 "description" : "The channel that is being transferred"
   466              },
   467              "replace_channel" : {
   468                 "required" : false,
   469                 "description" : "The channel that is replacing transferer when the transferee(s) can not be transferred directly",
   470                 "type" : "Channel"
   471              },
   472              "result" : {
   473                 "description" : "The result of the transfer attempt",
   474                 "type" : "string",
   475                 "required" : true
   476              },
   477              "channel" : {
   478                 "required" : true,
   479                 "type" : "Channel",
   480                 "description" : "The channel performing the blind transfer"
   481              },
   482              "bridge" : {
   483                 "type" : "Bridge",
   484                 "description" : "The bridge being transferred"
   485              },
   486              "exten" : {
   487                 "description" : "The extension transferred to",
   488                 "type" : "string",
   489                 "required" : true
   490              }
   491           }
   492        },
   493        "ChannelHold" : {
   494           "properties" : {
   495              "channel" : {
   496                 "required" : true,
   497                 "type" : "Channel",
   498                 "description" : "The channel that initiated the hold event."
   499              },
   500              "musicclass" : {
   501                 "required" : false,
   502                 "description" : "The music on hold class that the initiator requested.",
   503                 "type" : "string"
   504              }
   505           },
   506           "description" : "A channel initiated a media hold.",
   507           "id" : "ChannelHold"
   508        },
   509        "ChannelEnteredBridge" : {
   510           "description" : "Notification that a channel has entered a bridge.",
   511           "properties" : {
   512              "bridge" : {
   513                 "required" : true,
   514                 "type" : "Bridge"
   515              },
   516              "channel" : {
   517                 "type" : "Channel"
   518              }
   519           },
   520           "id" : "ChannelEnteredBridge"
   521        },
   522        "PlaybackContinuing" : {
   523           "properties" : {
   524              "playback" : {
   525                 "required" : true,
   526                 "type" : "Playback",
   527                 "description" : "Playback control object"
   528              }
   529           },
   530           "description" : "Event showing the continuation of a media playback operation from one media URI to the next in the list.",
   531           "id" : "PlaybackContinuing"
   532        },
   533        "ChannelDtmfReceived" : {
   534           "properties" : {
   535              "channel" : {
   536                 "type" : "Channel",
   537                 "description" : "The channel on which DTMF was received",
   538                 "required" : true
   539              },
   540              "digit" : {
   541                 "required" : true,
   542                 "type" : "string",
   543                 "description" : "DTMF digit received (0-9, A-E, # or *)"
   544              },
   545              "duration_ms" : {
   546                 "description" : "Number of milliseconds DTMF was received",
   547                 "type" : "int",
   548                 "required" : true
   549              }
   550           },
   551           "description" : "DTMF received on a channel.\n\nThis event is sent when the DTMF ends. There is no notification about the start of DTMF",
   552           "id" : "ChannelDtmfReceived"
   553        },
   554        "ChannelTalkingFinished" : {
   555           "properties" : {
   556              "duration" : {
   557                 "description" : "The length of time, in milliseconds, that talking was detected on the channel",
   558                 "type" : "int",
   559                 "required" : true
   560              },
   561              "channel" : {
   562                 "description" : "The channel on which talking completed.",
   563                 "type" : "Channel",
   564                 "required" : true
   565              }
   566           },
   567           "description" : "Talking is no longer detected on the channel.",
   568           "id" : "ChannelTalkingFinished"
   569        },
   570        "TextMessageReceived" : {
   571           "properties" : {
   572              "message" : {
   573                 "type" : "TextMessage",
   574                 "required" : true
   575              },
   576              "endpoint" : {
   577                 "type" : "Endpoint",
   578                 "required" : false
   579              }
   580           },
   581           "description" : "A text message was received from an endpoint.",
   582           "id" : "TextMessageReceived"
   583        },
   584        "ChannelDestroyed" : {
   585           "id" : "ChannelDestroyed",
   586           "properties" : {
   587              "cause_txt" : {
   588                 "required" : true,
   589                 "description" : "Text representation of the cause of the hangup",
   590                 "type" : "string"
   591              },
   592              "cause" : {
   593                 "description" : "Integer representation of the cause of the hangup",
   594                 "type" : "int",
   595                 "required" : true
   596              },
   597              "channel" : {
   598                 "required" : true,
   599                 "type" : "Channel"
   600              }
   601           },
   602           "description" : "Notification that a channel has been destroyed."
   603        },
   604        "RecordingFailed" : {
   605           "properties" : {
   606              "recording" : {
   607                 "type" : "LiveRecording",
   608                 "description" : "Recording control object",
   609                 "required" : true
   610              }
   611           },
   612           "description" : "Event showing failure of a recording operation.",
   613           "id" : "RecordingFailed"
   614        },
   615        "BridgeDestroyed" : {
   616           "id" : "BridgeDestroyed",
   617           "properties" : {
   618              "bridge" : {
   619                 "type" : "Bridge",
   620                 "required" : true
   621              }
   622           },
   623           "description" : "Notification that a bridge has been destroyed."
   624        },
   625        "Event" : {
   626           "id" : "Event",
   627           "description" : "Base type for asynchronous events from Asterisk.",
   628           "subTypes" : [
   629              "DeviceStateChanged",
   630              "PlaybackStarted",
   631              "PlaybackContinuing",
   632              "PlaybackFinished",
   633              "RecordingStarted",
   634              "RecordingFinished",
   635              "RecordingFailed",
   636              "ApplicationReplaced",
   637              "BridgeCreated",
   638              "BridgeDestroyed",
   639              "BridgeMerged",
   640              "BridgeBlindTransfer",
   641              "BridgeAttendedTransfer",
   642              "ChannelCreated",
   643              "ChannelDestroyed",
   644              "ChannelEnteredBridge",
   645              "ChannelLeftBridge",
   646              "ChannelStateChange",
   647              "ChannelDtmfReceived",
   648              "ChannelDialplan",
   649              "ChannelCallerId",
   650              "ChannelUserevent",
   651              "ChannelHangupRequest",
   652              "ChannelVarset",
   653              "ChannelTalkingStarted",
   654              "ChannelTalkingFinished",
   655              "ChannelHold",
   656              "ChannelUnhold",
   657              "ContactStatusChange",
   658              "EndpointStateChange",
   659              "Dial",
   660              "StasisEnd",
   661              "StasisStart",
   662              "TextMessageReceived",
   663              "ChannelConnectedLine",
   664              "PeerStatusChange"
   665           ],
   666           "properties" : {
   667              "timestamp" : {
   668                 "type" : "Date",
   669                 "description" : "Time at which this event was created.",
   670                 "required" : false
   671              },
   672              "application" : {
   673                 "required" : true,
   674                 "description" : "Name of the application receiving the event.",
   675                 "type" : "string"
   676              }
   677           }
   678        },
   679        "ChannelConnectedLine" : {
   680           "properties" : {
   681              "channel" : {
   682                 "type" : "Channel",
   683                 "description" : "The channel whose connected line has changed.",
   684                 "required" : true
   685              }
   686           },
   687           "description" : "Channel changed Connected Line.",
   688           "id" : "ChannelConnectedLine"
   689        },
   690        "RecordingFinished" : {
   691           "id" : "RecordingFinished",
   692           "description" : "Event showing the completion of a recording operation.",
   693           "properties" : {
   694              "recording" : {
   695                 "required" : true,
   696                 "type" : "LiveRecording",
   697                 "description" : "Recording control object"
   698              }
   699           }
   700        },
   701        "MissingParams" : {
   702           "properties" : {
   703              "params" : {
   704                 "required" : true,
   705                 "description" : "A list of the missing parameters",
   706                 "type" : "List[string]"
   707              }
   708           },
   709           "description" : "Error event sent when required params are missing.",
   710           "id" : "MissingParams"
   711        },
   712        "ApplicationReplaced" : {
   713           "description" : "Notification that another WebSocket has taken over for an application.\n\nAn application may only be subscribed to by a single WebSocket at a time. If multiple WebSockets attempt to subscribe to the same application, the newer WebSocket wins, and the older one receives this event.",
   714           "properties" : {},
   715           "id" : "ApplicationReplaced"
   716        },
   717        "ContactInfo" : {
   718           "id" : "ContactInfo",
   719           "properties" : {
   720              "uri" : {
   721                 "required" : true,
   722                 "type" : "string",
   723                 "description" : "The location of the contact."
   724              },
   725              "contact_status" : {
   726                 "required" : true,
   727                 "allowableValues" : {
   728                    "values" : [
   729                       "Unreachable",
   730                       "Reachable",
   731                       "Unknown",
   732                       "Created",
   733                       "Removed"
   734                    ],
   735                    "valueType" : "LIST"
   736                 },
   737                 "description" : "The current status of the contact.",
   738                 "type" : "string"
   739              },
   740              "roundtrip_usec" : {
   741                 "type" : "string",
   742                 "description" : "Current round trip time, in microseconds, for the contact.",
   743                 "required" : false
   744              },
   745              "aor" : {
   746                 "required" : true,
   747                 "type" : "string",
   748                 "description" : "The Address of Record this contact belongs to."
   749              }
   750           },
   751           "description" : "Detailed information about a contact on an endpoint."
   752        },
   753        "BridgeCreated" : {
   754           "id" : "BridgeCreated",
   755           "description" : "Notification that a bridge has been created.",
   756           "properties" : {
   757              "bridge" : {
   758                 "type" : "Bridge",
   759                 "required" : true
   760              }
   761           }
   762        },
   763        "ChannelLeftBridge" : {
   764           "id" : "ChannelLeftBridge",
   765           "properties" : {
   766              "channel" : {
   767                 "required" : true,
   768                 "type" : "Channel"
   769              },
   770              "bridge" : {
   771                 "required" : true,
   772                 "type" : "Bridge"
   773              }
   774           },
   775           "description" : "Notification that a channel has left a bridge."
   776        }
   777     },
   778     "apis" : [
   779        {
   780           "operations" : [
   781              {
   782                 "upgrade" : "websocket",
   783                 "nickname" : "eventWebsocket",
   784                 "parameters" : [
   785                    {
   786                       "required" : true,
   787                       "name" : "app",
   788                       "allowMultiple" : true,
   789                       "dataType" : "string",
   790                       "description" : "Applications to subscribe to.",
   791                       "paramType" : "query"
   792                    },
   793                    {
   794                       "allowMultiple" : false,
   795                       "required" : false,
   796                       "name" : "subscribeAll",
   797                       "description" : "Subscribe to all Asterisk events. If provided, the applications listed will be subscribed to all events, effectively disabling the application specific subscriptions. Default is 'false'.",
   798                       "paramType" : "query",
   799                       "dataType" : "boolean"
   800                    }
   801                 ],
   802                 "httpMethod" : "GET",
   803                 "summary" : "WebSocket connection for events.",
   804                 "websocketProtocol" : "ari",
   805                 "responseClass" : "Message"
   806              }
   807           ],
   808           "description" : "Events from Asterisk to applications",
   809           "path" : "/events"
   810        },
   811        {
   812           "operations" : [
   813              {
   814                 "nickname" : "userEvent",
   815                 "errorResponses" : [
   816                    {
   817                       "code" : 404,
   818                       "reason" : "Application does not exist."
   819                    },
   820                    {
   821                       "reason" : "Event source not found.",
   822                       "code" : 422
   823                    },
   824                    {
   825                       "reason" : "Invalid even tsource URI or userevent data.",
   826                       "code" : 400
   827                    }
   828                 ],
   829                 "httpMethod" : "POST",
   830                 "parameters" : [
   831                    {
   832                       "allowMultiple" : false,
   833                       "required" : true,
   834                       "name" : "eventName",
   835                       "description" : "Event name",
   836                       "paramType" : "path",
   837                       "dataType" : "string"
   838                    },
   839                    {
   840                       "allowMultiple" : false,
   841                       "required" : true,
   842                       "name" : "application",
   843                       "description" : "The name of the application that will receive this event",
   844                       "paramType" : "query",
   845                       "dataType" : "string"
   846                    },
   847                    {
   848                       "allowMultiple" : true,
   849                       "name" : "source",
   850                       "required" : false,
   851                       "paramType" : "query",
   852                       "description" : "URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}/{resource}, deviceState:{deviceName}",
   853                       "dataType" : "string"
   854                    },
   855                    {
   856                       "name" : "variables",
   857                       "required" : false,
   858                       "allowMultiple" : false,
   859                       "dataType" : "containers",
   860                       "paramType" : "body",
   861                       "description" : "The \"variables\" key in the body object holds custom key/value pairs to add to the user event. Ex. { \"variables\": { \"key\": \"value\" } }"
   862                    }
   863                 ],
   864                 "summary" : "Generate a user event.",
   865                 "responseClass" : "void"
   866              }
   867           ],
   868           "description" : "Stasis application user events",
   869           "path" : "/events/user/{eventName}"
   870        }
   871     ],
   872     "resourcePath" : "/api-docs/events.{format}",
   873     "_svn_revision" : "$Revision$",
   874     "swaggerVersion" : "1.2"
   875  }