Document the 400 error response for originate
[asterisk/asterisk.git] / rest-api / api-docs / channels.json
1 {
2         "_copyright": "Copyright (C) 2012 - 2013, Digium, Inc.",
3         "_author": "David M. Lee, II <dlee@digium.com>",
4         "_svn_revision": "$Revision$",
5         "apiVersion": "0.0.1",
6         "swaggerVersion": "1.1",
7         "basePath": "http://localhost:8088/stasis",
8         "resourcePath": "/api-docs/channels.{format}",
9         "apis": [
10                 {
11                         "path": "/channels",
12                         "description": "Active channels",
13                         "operations": [
14                                 {
15                                         "httpMethod": "GET",
16                                         "summary": "List active channels.",
17                                         "nickname": "getChannels",
18                                         "responseClass": "List[Channel]"
19                                 },
20                                 {
21                                         "httpMethod": "POST",
22                                         "summary": "Create a new channel (originate).",
23                                         "nickname": "originate",
24                                         "responseClass": "void",
25                                         "parameters": [
26                                                 {
27                                                         "name": "endpoint",
28                                                         "description": "Endpoint to call.",
29                                                         "paramType": "query",
30                                                         "required": true,
31                                                         "allowMultiple": false,
32                                                         "dataType": "string"
33                                                 },
34                                                 {
35                                                         "name": "extension",
36                                                         "description": "The extension to dial after the endpoint answers",
37                                                         "paramType": "query",
38                                                         "required": false,
39                                                         "allowMultiple": false,
40                                                         "dataType": "string"
41                                                 },
42                                                 {
43                                                         "name": "context",
44                                                         "description": "The context to dial after the endpoint answers. If omitted, uses 'default'",
45                                                         "paramType": "query",
46                                                         "required": false,
47                                                         "allowMultiple": false,
48                                                         "dataType": "string"
49                                                 },
50                                                 {
51                                                         "name": "priority",
52                                                         "description": "The priority to dial after the endpoint answers. If omitted, uses 1",
53                                                         "paramType": "query",
54                                                         "required": false,
55                                                         "allowMultiple": false,
56                                                         "dataType": "long"
57                                                 },
58                                                 {
59                                                         "name": "app",
60                                                         "description": "The application name to pass to the Stasis application.",
61                                                         "paramType": "query",
62                                                         "required": false,
63                                                         "allowMultiple": false,
64                                                         "dataType": "string"
65                                                 },
66                                                 {
67                                                         "name": "appArgs",
68                                                         "description": "The application arguments to pass to the Stasis application.",
69                                                         "paramType": "query",
70                                                         "required": false,
71                                                         "allowMultiple": false,
72                                                         "dataType": "string"
73                                                 },
74                                                 {
75                                                         "name": "callerId",
76                                                         "description": "CallerID to use when dialing the endpoint or extension.",
77                                                         "paramType": "query",
78                                                         "required": false,
79                                                         "allowMultiple": false,
80                                                         "dataType": "string"
81                                                 },
82                                                 {
83                                                         "name": "timeout",
84                                                         "description": "Timeout (in seconds) before giving up dialing, or -1 for no timeout.",
85                                                         "paramType": "query",
86                                                         "required": false,
87                                                         "allowMultiple": false,
88                                                         "dataType": "int",
89                                                         "defaultValue": 30
90                                                 }
91                                         ],
92                                         "errorResponses": [
93                                                 {
94                                                         "code": 400,
95                                                         "reason": "Invalid parameters for originating a channel."
96                                                 }
97                                         ]
98                                 }
99                         ]
100                 },
101                 {
102                         "path": "/channels/{channelId}",
103                         "description": "Active channel",
104                         "operations": [
105                                 {
106                                         "httpMethod": "GET",
107                                         "summary": "Channel details.",
108                                         "nickname": "getChannel",
109                                         "responseClass": "Channel",
110                                         "parameters": [
111                                                 {
112                                                         "name": "channelId",
113                                                         "description": "Channel's id",
114                                                         "paramType": "path",
115                                                         "required": true,
116                                                         "allowMultiple": false,
117                                                         "dataType": "string"
118                                                 }
119                                         ],
120                                         "errorResponses": [
121                                                 {
122                                                         "code": 404,
123                                                         "reason": "Channel not found"
124                                                 }
125                                         ]
126                                 },
127                                 {
128                                         "httpMethod": "DELETE",
129                                         "summary": "Delete (i.e. hangup) a channel.",
130                                         "nickname": "deleteChannel",
131                                         "responseClass": "void",
132                                         "parameters": [
133                                                 {
134                                                         "name": "channelId",
135                                                         "description": "Channel's id",
136                                                         "paramType": "path",
137                                                         "required": true,
138                                                         "allowMultiple": false,
139                                                         "dataType": "string"
140                                                 }
141                                         ],
142                                         "errorResponses": [
143                                                 {
144                                                         "code": 404,
145                                                         "reason": "Channel not found"
146                                                 }
147                                         ]
148                                 }
149                         ]
150                 },
151                 {
152                         "path": "/channels/{channelId}/dial",
153                         "description": "Create a new channel (originate) and bridge to this channel",
154                         "operations": [
155                                 {
156                                         "httpMethod": "POST",
157                                         "summary": "Create a new channel (originate) and bridge to this channel.",
158                                         "nickname": "dial",
159                                         "responseClass": "Dialed",
160                                         "parameters": [
161                                                 {
162                                                         "name": "channelId",
163                                                         "description": "Channel's id",
164                                                         "paramType": "path",
165                                                         "required": true,
166                                                         "allowMultiple": false,
167                                                         "dataType": "string"
168                                                 },
169                                                 {
170                                                         "name": "endpoint",
171                                                         "description": "Endpoint to call. If not specified, dial is routed via dialplan",
172                                                         "paramType": "query",
173                                                         "required": false,
174                                                         "allowMultiple": false,
175                                                         "dataType": "string"
176                                                 },
177                                                 {
178                                                         "name": "extension",
179                                                         "description": "Extension to dial",
180                                                         "paramType": "query",
181                                                         "required": false,
182                                                         "allowMultiple": false,
183                                                         "dataType": "string"
184                                                 },
185                                                 {
186                                                         "name": "context",
187                                                         "description": "When routing via dialplan, the context use. If omitted, uses 'default'",
188                                                         "paramType": "query",
189                                                         "required": false,
190                                                         "allowMultiple": false,
191                                                         "dataType": "string"
192                                                 },
193                                                 {
194                                                         "name": "timeout",
195                                                         "description": "Timeout (in seconds) before giving up dialing, or -1 for no timeout.",
196                                                         "paramType": "query",
197                                                         "required": false,
198                                                         "allowMultiple": false,
199                                                         "dataType": "int",
200                                                         "defaultValue": 30
201                                                 }
202                                         ],
203                                         "errorResponses": [
204                                                 {
205                                                         "code": 404,
206                                                         "reason": "Channel not found"
207                                                 },
208                                                 {
209                                                         "code": 409,
210                                                         "reason": "Channel not in a Stasis application"
211                                                 }
212                                         ]
213                                 }
214                         ]
215                 },
216                 {
217                         "path": "/channels/{channelId}/continue",
218                         "description": "Exit application; continue execution in the dialplan",
219                         "operations": [
220                                 {
221                                         "httpMethod": "POST",
222                                         "summary": "Exit application; continue execution in the dialplan.",
223                                         "nickname": "continueInDialplan",
224                                         "responseClass": "void",
225                                         "parameters": [
226                                                 {
227                                                         "name": "channelId",
228                                                         "description": "Channel's id",
229                                                         "paramType": "path",
230                                                         "required": true,
231                                                         "allowMultiple": false,
232                                                         "dataType": "string"
233                                                 },
234                                                 {
235                                                         "name": "context",
236                                                         "description": "The context to continue to.",
237                                                         "paramType": "query",
238                                                         "required": false,
239                                                         "allowMultiple": false,
240                                                         "dataType": "string"
241                                                 },
242                                                 {
243                                                         "name": "extension",
244                                                         "description": "The extension to continue to.",
245                                                         "paramType": "query",
246                                                         "required": false,
247                                                         "allowMultiple": false,
248                                                         "dataType": "string"
249                                                 },
250                                                 {
251                                                         "name": "priority",
252                                                         "description": "The priority to continue to.",
253                                                         "paramType": "query",
254                                                         "required": false,
255                                                         "allowMultiple": false,
256                                                         "dataType": "int"
257                                                 }
258                                         ],
259                                         "errorResponses": [
260                                                 {
261                                                         "code": 404,
262                                                         "reason": "Channel not found"
263                                                 },
264                                                 {
265                                                         "code": 409,
266                                                         "reason": "Channel not in a Stasis application"
267                                                 }
268                                         ]
269                                 }
270                         ]
271                 },
272                 {
273                         "path": "/channels/{channelId}/answer",
274                         "description": "Answer a channel",
275                         "operations": [
276                                 {
277                                         "httpMethod": "POST",
278                                         "summary": "Answer a channel.",
279                                         "nickname": "answerChannel",
280                                         "responseClass": "void",
281                                         "parameters": [
282                                                 {
283                                                         "name": "channelId",
284                                                         "description": "Channel's id",
285                                                         "paramType": "path",
286                                                         "required": true,
287                                                         "allowMultiple": false,
288                                                         "dataType": "string"
289                                                 }
290                                         ],
291                                         "errorResponses": [
292                                                 {
293                                                         "code": 404,
294                                                         "reason": "Channel not found"
295                                                 },
296                                                 {
297                                                         "code": 409,
298                                                         "reason": "Channel not in a Stasis application"
299                                                 }
300                                         ]
301                                 }
302                         ]
303                 },
304                 {
305                         "path": "/channels/{channelId}/mute",
306                         "description": "Mute a channel",
307                         "operations": [
308                                 {
309                                         "httpMethod": "POST",
310                                         "summary": "Mute a channel.",
311                                         "nickname": "muteChannel",
312                                         "responseClass": "void",
313                                         "parameters": [
314                                                 {
315                                                         "name": "channelId",
316                                                         "description": "Channel's id",
317                                                         "paramType": "path",
318                                                         "required": true,
319                                                         "allowMultiple": false,
320                                                         "dataType": "string"
321                                                 },
322                                                 {
323                                                         "name": "direction",
324                                                         "description": "Direction in which to mute audio",
325                                                         "paramType": "query",
326                                                         "required": false,
327                                                         "allowMultiple": false,
328                                                         "dataType": "string",
329                                                         "defaultValue": "both",
330                                                         "allowableValues": {
331                                                                 "valueType": "LIST",
332                                                                 "values": [
333                                                                         "both",
334                                                                         "in",
335                                                                         "out"
336                                                                 ]
337                                                         }
338                                                 }
339                                         ],
340                                         "errorResponses": [
341                                                 {
342                                                         "code": 404,
343                                                         "reason": "Channel not found"
344                                                 },
345                                                 {
346                                                         "code": 409,
347                                                         "reason": "Channel not in a Stasis application"
348                                                 }
349                                         ]
350                                 }
351                         ]
352                 },
353                 {
354                         "path": "/channels/{channelId}/unmute",
355                         "description": "Unmute a channel",
356                         "operations": [
357                                 {
358                                         "httpMethod": "POST",
359                                         "summary": "Unmute a channel.",
360                                         "nickname": "unmuteChannel",
361                                         "responseClass": "void",
362                                         "parameters": [
363                                                 {
364                                                         "name": "channelId",
365                                                         "description": "Channel's id",
366                                                         "paramType": "path",
367                                                         "required": true,
368                                                         "allowMultiple": false,
369                                                         "dataType": "string"
370                                                 },
371                                                 {
372                                                         "name": "direction",
373                                                         "description": "Direction in which to unmute audio",
374                                                         "paramType": "query",
375                                                         "required": false,
376                                                         "allowMultiple": false,
377                                                         "dataType": "string",
378                                                         "defaultValue": "both",
379                                                         "allowableValues": {
380                                                                 "valueType": "LIST",
381                                                                 "values": [
382                                                                         "both",
383                                                                         "in",
384                                                                         "out"
385                                                                 ]
386                                                         }
387                                                 }
388                                         ],
389                                         "errorResponses": [
390                                                 {
391                                                         "code": 404,
392                                                         "reason": "Channel not found"
393                                                 },
394                                                 {
395                                                         "code": 409,
396                                                         "reason": "Channel not in a Stasis application"
397                                                 }
398                                         ]
399                                 }
400                         ]
401                 },
402                 {
403                         "path": "/channels/{channelId}/hold",
404                         "description": "Put a channel on hold",
405                         "operations": [
406                                 {
407                                         "httpMethod": "POST",
408                                         "summary": "Hold a channel.",
409                                         "nickname": "holdChannel",
410                                         "responseClass": "void",
411                                         "parameters": [
412                                                 {
413                                                         "name": "channelId",
414                                                         "description": "Channel's id",
415                                                         "paramType": "path",
416                                                         "required": true,
417                                                         "allowMultiple": false,
418                                                         "dataType": "string"
419                                                 }
420                                         ],
421                                         "errorResponses": [
422                                                 {
423                                                         "code": 404,
424                                                         "reason": "Channel not found"
425                                                 },
426                                                 {
427                                                         "code": 409,
428                                                         "reason": "Channel not in a Stasis application"
429                                                 }
430                                         ]
431                                 }
432                         ]
433                 },
434                 {
435                         "path": "/channels/{channelId}/unhold",
436                         "description": "Remove a channel from hold",
437                         "operations": [
438                                 {
439                                         "httpMethod": "POST",
440                                         "summary": "Remove a channel from hold.",
441                                         "nickname": "unholdChannel",
442                                         "responseClass": "void",
443                                         "parameters": [
444                                                 {
445                                                         "name": "channelId",
446                                                         "description": "Channel's id",
447                                                         "paramType": "path",
448                                                         "required": true,
449                                                         "allowMultiple": false,
450                                                         "dataType": "string"
451                                                 }
452                                         ],
453                                         "errorResponses": [
454                                                 {
455                                                         "code": 404,
456                                                         "reason": "Channel not found"
457                                                 },
458                                                 {
459                                                         "code": 409,
460                                                         "reason": "Channel not in a Stasis application"
461                                                 }
462                                         ]
463                                 }
464                         ]
465                 },
466                 {
467                         "path": "/channels/{channelId}/play",
468                         "description": "Play media to a channel",
469                         "operations": [
470                                 {
471                                         "httpMethod": "POST",
472                                         "summary": "Start playback of media.",
473                                         "notes": "The media URI may be any of a number of URI's. You may use http: and https: URI's, as well as sound: and recording: URI's. This operation creates a playback resource that can be used to control the playback of media (pause, rewind, fast forward, etc.)",
474                                         "nickname": "playOnChannel",
475                                         "responseClass": "Playback",
476                                         "parameters": [
477                                                 {
478                                                         "name": "channelId",
479                                                         "description": "Channel's id",
480                                                         "paramType": "path",
481                                                         "required": true,
482                                                         "allowMultiple": false,
483                                                         "dataType": "string"
484                                                 },
485                                                 {
486                                                         "name": "media",
487                                                         "description": "Media's URI to play.",
488                                                         "paramType": "query",
489                                                         "required": true,
490                                                         "allowMultiple": false,
491                                                         "dataType": "string"
492                                                 },
493                                                 {
494                                                         "name": "lang",
495                                                         "description": "For sounds, selects language for sound.",
496                                                         "paramType": "query",
497                                                         "required": false,
498                                                         "allowMultiple": false,
499                                                         "dataType": "string"
500                                                 },
501                                                 {
502                                                         "name": "offsetms",
503                                                         "description": "Number of media to skip before playing.",
504                                                         "paramType": "query",
505                                                         "required": false,
506                                                         "allowMultiple": false,
507                                                         "dataType": "int"
508                                                 },
509                                                 {
510                                                         "name": "skipms",
511                                                         "description": "Number of milliseconds to skip for forward/reverse operations.",
512                                                         "paramType": "query",
513                                                         "required": false,
514                                                         "allowMultiple": false,
515                                                         "dataType": "int",
516                                                         "defaultValue": 3000
517                                                 }
518                                         ],
519                                         "errorResponses": [
520                                                 {
521                                                         "code": 404,
522                                                         "reason": "Channel not found"
523                                                 },
524                                                 {
525                                                         "code": 409,
526                                                         "reason": "Channel not in a Stasis application"
527                                                 }
528                                         ]
529                                 }
530                         ]
531                 },
532                 {
533                         "path": "/channels/{channelId}/record",
534                         "description": "Record audio from a channel",
535                         "operations": [
536                                 {
537                                         "httpMethod": "POST",
538                                         "summary": "Start a recording.",
539                                         "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.",
540                                         "nickname": "recordChannel",
541                                         "responseClass": "void",
542                                         "parameters": [
543                                                 {
544                                                         "name": "channelId",
545                                                         "description": "Channel's id",
546                                                         "paramType": "path",
547                                                         "required": true,
548                                                         "allowMultiple": false,
549                                                         "dataType": "string"
550                                                 },
551                                                 {
552                                                         "name": "name",
553                                                         "description": "Recording's filename",
554                                                         "paramType": "query",
555                                                         "required": true,
556                                                         "allowMultiple": false,
557                                                         "dataType": "string"
558                                                 },
559                                                 {
560                                                         "name": "format",
561                                                         "description": "Format to encode audio in",
562                                                         "paramType": "query",
563                                                         "required": true,
564                                                         "allowMultiple": true,
565                                                         "dataType": "string"
566                                                 },
567                                                 {
568                                                         "name": "maxDurationSeconds",
569                                                         "description": "Maximum duration of the recording, in seconds. 0 for no limit",
570                                                         "paramType": "query",
571                                                         "required": false,
572                                                         "allowMultiple": false,
573                                                         "dataType": "int",
574                                                         "defaultValue": 0,
575                                                         "allowableValues": {
576                                                                 "valueType": "RANGE",
577                                                                 "min": 0
578                                                         }
579                                                 },
580                                                 {
581                                                         "name": "maxSilenceSeconds",
582                                                         "description": "Maximum duration of silence, in seconds. 0 for no limit",
583                                                         "paramType": "query",
584                                                         "required": false,
585                                                         "allowMultiple": false,
586                                                         "dataType": "int",
587                                                         "defaultValue": 0,
588                                                         "allowableValues": {
589                                                                 "valueType": "RANGE",
590                                                                 "min": 0
591                                                         }
592                                                 },
593                                                 {
594                                                         "name": "ifExists",
595                                                         "description": "Action to take if a recording with the same name already exists.",
596                                                         "paramType": "query",
597                                                         "required": false,
598                                                         "allowMultiple": false,
599                                                         "dataType": "string",
600                                                         "defaultValue": "fail",
601                                                         "allowableValues": {
602                                                                 "valueType": "LIST",
603                                                                 "values": [
604                                                                         "fail",
605                                                                         "overwrite",
606                                                                         "append"
607                                                                 ]
608                                                         }
609                                                 },
610                                                 {
611                                                         "name": "beep",
612                                                         "description": "Play beep when recording begins",
613                                                         "paramType": "query",
614                                                         "required": false,
615                                                         "allowMultiple": false,
616                                                         "dataType": "boolean",
617                                                         "defaultValue": false
618                                                 },
619                                                 {
620                                                         "name": "terminateOn",
621                                                         "description": "DTMF input to terminate recording",
622                                                         "paramType": "query",
623                                                         "required": false,
624                                                         "allowMultiple": false,
625                                                         "dataType": "string",
626                                                         "defaultValue": "none",
627                                                         "allowableValues": {
628                                                                 "valueType": "LIST",
629                                                                 "values": [
630                                                                         "none",
631                                                                         "any",
632                                                                         "*",
633                                                                         "#"
634                                                                 ]
635                                                         }
636                                                 }
637                                         ],
638                                         "errorResponses": [
639                                                 {
640                                                         "code": 400,
641                                                         "reason": "Invalid parameters"
642                                                 },
643                                                 {
644                                                         "code": 404,
645                                                         "reason": "Channel not found"
646                                                 },
647                                                 {
648                                                         "code": 409,
649                                                         "reason": "Channel is not in a Stasis application; the channel is currently bridged with other channels; A recording with the same name is currently in progress."
650                                                 }
651                                         ]
652                                 }
653                         ]
654                 },
655                 {
656                         "path": "/channels/{channelId}/variable",
657                         "description": "Variables on a channel",
658                         "operations": [
659                                 {
660                                         "httpMethod": "GET",
661                                         "summary": "Get the value of a channel variable or function.",
662                                         "nickname": "getChannelVar",
663                                         "responseClass": "Variable",
664                                         "parameters": [
665                                                 {
666                                                         "name": "channelId",
667                                                         "description": "Channel's id",
668                                                         "paramType": "path",
669                                                         "required": true,
670                                                         "allowMultiple": false,
671                                                         "dataType": "string"
672                                                 },
673                                                 {
674                                                         "name": "variable",
675                                                         "description": "The channel variable or function to get",
676                                                         "paramType": "query",
677                                                         "required": true,
678                                                         "allowMultiple": false,
679                                                         "dataType": "string"
680                                                 }
681                                         ],
682                                         "errorResponses": [
683                                                 {
684                                                         "code": 404,
685                                                         "reason": "Channel not found"
686                                                 },
687                                                 {
688                                                         "code": 409,
689                                                         "reason": "Channel not in a Stasis application"
690                                                 }
691                                         ]
692                                 },
693                                 {
694                                         "httpMethod": "POST",
695                                         "summary": "Set the value of a channel variable or function.",
696                                         "nickname": "setChannelVar",
697                                         "responseClass": "void",
698                                         "parameters": [
699                                                 {
700                                                         "name": "channelId",
701                                                         "description": "Channel's id",
702                                                         "paramType": "path",
703                                                         "required": true,
704                                                         "allowMultiple": false,
705                                                         "dataType": "string"
706                                                 },
707                                                 {
708                                                         "name": "variable",
709                                                         "description": "The channel variable or function to set",
710                                                         "paramType": "query",
711                                                         "required": true,
712                                                         "allowMultiple": false,
713                                                         "dataType": "string"
714                                                 },
715                                                 {
716                                                         "name": "value",
717                                                         "description": "The value to set the variable to",
718                                                         "paramType": "query",
719                                                         "required": false,
720                                                         "allowMultiple": false,
721                                                         "dataType": "string"
722                                                 }
723                                         ],
724                                         "errorResponses": [
725                                                 {
726                                                         "code": 404,
727                                                         "reason": "Channel not found"
728                                                 },
729                                                 {
730                                                         "code": 409,
731                                                         "reason": "Channel not in a Stasis application"
732                                                 }
733                                         ]
734                                 }
735                         ]
736                 }
737         ],
738         "models": {
739                 "Dialed": {
740                         "id": "Dialed",
741                         "description": "Dialed channel information.",
742                         "properties": {}
743                 },
744                 "DialplanCEP": {
745                         "id": "DialplanCEP",
746                         "description": "Dialplan location (context/extension/priority)",
747                         "properties": {
748                                 "context": {
749                                         "required": true,
750                                         "type": "string",
751                                         "description": "Context in the dialplan"
752                                 },
753                                 "exten": {
754                                         "required": true,
755                                         "type": "string",
756                                         "description": "Extension in the dialplan"
757                                 },
758                                 "priority": {
759                                         "required": true,
760                                         "type": "long",
761                                         "description": "Priority in the dialplan"
762                                 }
763                         }
764                 },
765                 "CallerID": {
766                         "id": "CallerID",
767                         "description": "Caller identification",
768                         "properties": {
769                                 "name": {
770                                         "required": true,
771                                         "type": "string"
772                                 },
773                                 "number": {
774                                         "required": true,
775                                         "type": "string"
776                                 }
777                         }
778                 },
779                 "Channel": {
780                         "id": "Channel",
781                         "description": "A specific communication connection between Asterisk and an Endpoint.",
782                         "properties": {
783                                 "id": {
784                                         "required": true,
785                                         "type": "string",
786                                         "description": "Unique identifier of the channel.\n\nThis is the same as the Uniqueid field in AMI."
787                                 },
788                                 "name": {
789                                         "required": true,
790                                         "type": "string",
791                                         "description": "Name of the channel (i.e. SIP/foo-0000a7e3)"
792                                 },
793                                 "state": {
794                                         "required": true,
795                                         "type": "string",
796                                         "allowableValues": {
797                                                 "valueType": "LIST",
798                                                 "values": [
799                                                         "Down",
800                                                         "Rsrved",
801                                                         "OffHook",
802                                                         "Dialing",
803                                                         "Ring",
804                                                         "Ringing",
805                                                         "Up",
806                                                         "Busy",
807                                                         "Dialing Offhook",
808                                                         "Pre-ring",
809                                                         "Unknown"
810                                                 ]
811                                         }
812                                 },
813                                 "caller": {
814                                         "required": true,
815                                         "type": "CallerID"
816                                 },
817                                 "connected": {
818                                         "required": true,
819                                         "type": "CallerID"
820                                 },
821                                 "accountcode": {
822                                         "required": true,
823                                         "type": "string"
824                                 },
825                                 "dialplan": {
826                                         "required": true,
827                                         "type": "DialplanCEP",
828                                         "description": "Current location in the dialplan"
829                                 },
830                                 "creationtime": {
831                                         "required": true,
832                                         "type": "Date",
833                                         "description": "Timestamp when channel was created"
834                                 }
835                         }
836                 }
837         }
838 }