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