aboutsummaryrefslogtreecommitdiffstats
path: root/doc/tex/ast_manager_actiondocs.tex
blob: 4c08c2055a85649d9b8a7b431a05937c054a9543 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
% This file is automatically generated by the "manager dump actiondocs" CLI command.  Any manual edits will be lost.
\section{AbsoluteTimeout}
\subsection{Synopsis}
\begin{verbatim}
Set Absolute Timeout
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
call,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: Hangup a channel after a certain time.
Variables: (Names marked with * are required)
	*Channel: Channel name to hangup
	*Timeout: Maximum duration of the call (sec)
Acknowledges set time with 'Timeout Set' message

\end{verbatim}


\section{AgentLogoff}
\subsection{Synopsis}
\begin{verbatim}
Sets an agent as no longer logged in
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
agent,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: Sets an agent as no longer logged in.
Variables: (Names marked with * are required)
	*Agent: Agent ID of the agent to log off
	Soft: Set to 'true' to not hangup existing calls

\end{verbatim}


\section{Agents}
\subsection{Synopsis}
\begin{verbatim}
Lists agents and their status
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
agent,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: Will list info about all possible agents.
Variables: NONE

\end{verbatim}


\section{Bridge}
\subsection{Synopsis}
\begin{verbatim}
Bridge two channels already in the PBX
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
command,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: Bridge together two channels already in the PBX
Variables: ( Headers marked with * are required )
   *Channel1: Channel to Bridge to Channel2
   *Channel2: Channel to Bridge to Channel1
        Tone: (Yes|No) Play courtesy tone to Channel 2


\end{verbatim}


\section{Challenge}
\subsection{Synopsis}
\begin{verbatim}
Generate Challenge for MD5 Auth
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
<none>
\end{verbatim}
\subsection{Description}
\begin{verbatim}
(null)
\end{verbatim}


\section{ChangeMonitor}
\subsection{Synopsis}
\begin{verbatim}
Change monitoring filename of a channel
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
call,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: The 'ChangeMonitor' action may be used to change the file
  started by a previous 'Monitor' action.  The following parameters may
  be used to control this:
  Channel     - Required.  Used to specify the channel to record.
  File        - Required.  Is the new name of the file created in the
                monitor spool directory.

\end{verbatim}


\section{Command}
\subsection{Synopsis}
\begin{verbatim}
Execute Asterisk CLI Command
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
command,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: Run a CLI command.
Variables: (Names marked with * are required)
	*Command: Asterisk CLI command to run
	ActionID: Optional Action id for message matching.

\end{verbatim}


\section{CoreSettings}
\subsection{Synopsis}
\begin{verbatim}
Show PBX core settings (version etc)
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
system,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: Query for Core PBX settings.
Variables: (Names marked with * are optional)
       *ActionID: ActionID of this transaction

\end{verbatim}


\section{CoreStatus}
\subsection{Synopsis}
\begin{verbatim}
Show PBX core status variables
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
system,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: Query for Core PBX status.
Variables: (Names marked with * are optional)
       *ActionID: ActionID of this transaction

\end{verbatim}


\section{DBDel}
\subsection{Synopsis}
\begin{verbatim}
Delete DB Entry
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
system,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
(null)
\end{verbatim}


\section{DBDelTree}
\subsection{Synopsis}
\begin{verbatim}
Delete DB Tree
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
system,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
(null)
\end{verbatim}


\section{DBGet}
\subsection{Synopsis}
\begin{verbatim}
Get DB Entry
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
system,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
(null)
\end{verbatim}


\section{DBPut}
\subsection{Synopsis}
\begin{verbatim}
Put DB Entry
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
system,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
(null)
\end{verbatim}


\section{Events}
\subsection{Synopsis}
\begin{verbatim}
Control Event Flow
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
<none>
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: Enable/Disable sending of events to this manager
  client.
Variables:
	EventMask: 'on' if all events should be sent,
		'off' if no events should be sent,
		'system,call,log' to select which flags events should have to be sent.

\end{verbatim}


\section{ExtensionState}
\subsection{Synopsis}
\begin{verbatim}
Check Extension Status
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
call,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: Report the extension state for given extension.
  If the extension has a hint, will use devicestate to check
  the status of the device connected to the extension.
Variables: (Names marked with * are required)
	*Exten: Extension to check state on
	*Context: Context for extension
	ActionId: Optional ID for this transaction
Will return an "Extension Status" message.
The response will include the hint for the extension and the status.

\end{verbatim}


\section{GetConfig}
\subsection{Synopsis}
\begin{verbatim}
Retrieve configuration
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
config,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: A 'GetConfig' action will dump the contents of a configuration
file by category and contents.
Variables:
   Filename: Configuration filename (e.g. foo.conf)

\end{verbatim}


\section{GetConfigJSON}
\subsection{Synopsis}
\begin{verbatim}
Retrieve configuration (JSON format)
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
config,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: A 'GetConfigJSON' action will dump the contents of a configuration
file by category and contents in JSON format.  This only makes sense to be used
using rawman over the HTTP interface.
Variables:
   Filename: Configuration filename (e.g. foo.conf)

\end{verbatim}


\section{Getvar}
\subsection{Synopsis}
\begin{verbatim}
Gets a Channel Variable
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
call,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: Get the value of a global or local channel variable.
Variables: (Names marked with * are required)
	Channel: Channel to read variable from
	*Variable: Variable name
	ActionID: Optional Action id for message matching.

\end{verbatim}


\section{Hangup}
\subsection{Synopsis}
\begin{verbatim}
Hangup Channel
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
call,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: Hangup a channel
Variables: 
	Channel: The channel name to be hungup

\end{verbatim}


\section{IAXnetstats}
\subsection{Synopsis}
\begin{verbatim}
Show IAX Netstats
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
<none>
\end{verbatim}
\subsection{Description}
\begin{verbatim}
(null)
\end{verbatim}


\section{IAXpeers}
\subsection{Synopsis}
\begin{verbatim}
List IAX Peers
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
<none>
\end{verbatim}
\subsection{Description}
\begin{verbatim}
(null)
\end{verbatim}


\section{JabberSend}
\subsection{Synopsis}
\begin{verbatim}
Sends a message to a Jabber Client
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
system,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: Sends a message to a Jabber Client.
Variables: 
  Jabber:	Client or transport Asterisk uses to connect to JABBER.
  ScreenName:	User Name to message.
  Message:	Message to be sent to the buddy

\end{verbatim}


\section{ListCommands}
\subsection{Synopsis}
\begin{verbatim}
List available manager commands
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
<none>
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: Returns the action name and synopsis for every
  action that is available to the user
Variables: NONE

\end{verbatim}


\section{Login}
\subsection{Synopsis}
\begin{verbatim}
Login Manager
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
<none>
\end{verbatim}
\subsection{Description}
\begin{verbatim}
(null)
\end{verbatim}


\section{Logoff}
\subsection{Synopsis}
\begin{verbatim}
Logoff Manager
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
<none>
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: Logoff this manager session
Variables: NONE

\end{verbatim}


\section{MailboxCount}
\subsection{Synopsis}
\begin{verbatim}
Check Mailbox Message Count
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
call,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: Checks a voicemail account for new messages.
Variables: (Names marked with * are required)
	*Mailbox: Full mailbox ID <mailbox>@<vm-context>
	ActionID: Optional ActionID for message matching.
Returns number of new and old messages.
	Message: Mailbox Message Count
	Mailbox: <mailboxid>
	NewMessages: <count>
	OldMessages: <count>


\end{verbatim}


\section{MailboxStatus}
\subsection{Synopsis}
\begin{verbatim}
Check Mailbox
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
call,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: Checks a voicemail account for status.
Variables: (Names marked with * are required)
	*Mailbox: Full mailbox ID <mailbox>@<vm-context>
	ActionID: Optional ActionID for message matching.
Returns number of messages.
	Message: Mailbox Status
	Mailbox: <mailboxid>
	Waiting: <count>


\end{verbatim}


\section{MeetmeMute}
\subsection{Synopsis}
\begin{verbatim}
Mute a Meetme user
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
call,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
(null)
\end{verbatim}


\section{MeetmeUnmute}
\subsection{Synopsis}
\begin{verbatim}
Unmute a Meetme user
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
call,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
(null)
\end{verbatim}


\section{Monitor}
\subsection{Synopsis}
\begin{verbatim}
Monitor a channel
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
call,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: The 'Monitor' action may be used to record the audio on a
  specified channel.  The following parameters may be used to control
  this:
  Channel     - Required.  Used to specify the channel to record.
  File        - Optional.  Is the name of the file created in the
                monitor spool directory.  Defaults to the same name
                as the channel (with slashes replaced with dashes).
  Format      - Optional.  Is the audio recording format.  Defaults
                to "wav".
  Mix         - Optional.  Boolean parameter as to whether to mix
                the input and output channels together after the
                recording is finished.

\end{verbatim}


\section{Originate}
\subsection{Synopsis}
\begin{verbatim}
Originate Call
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
call,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: Generates an outgoing call to a Extension/Context/Priority or
  Application/Data
Variables: (Names marked with * are required)
	*Channel: Channel name to call
	Exten: Extension to use (requires 'Context' and 'Priority')
	Context: Context to use (requires 'Exten' and 'Priority')
	Priority: Priority to use (requires 'Exten' and 'Context')
	Application: Application to use
	Data: Data to use (requires 'Application')
	Timeout: How long to wait for call to be answered (in ms)
	CallerID: Caller ID to be set on the outgoing channel
	Variable: Channel variable to set, multiple Variable: headers are allowed
	Account: Account code
	Async: Set to 'true' for fast origination

\end{verbatim}


\section{Park}
\subsection{Synopsis}
\begin{verbatim}
Park a channel
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
call,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: Park a channel.
Variables: (Names marked with * are required)
	*Channel: Channel name to park
	*Channel2: Channel to announce park info to (and return to if timeout)
	Timeout: Number of milliseconds to wait before callback.

\end{verbatim}


\section{ParkedCalls}
\subsection{Synopsis}
\begin{verbatim}
List parked calls
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
<none>
\end{verbatim}
\subsection{Description}
\begin{verbatim}
(null)
\end{verbatim}


\section{PauseMonitor}
\subsection{Synopsis}
\begin{verbatim}
Pause monitoring of a channel
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
call,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: The 'PauseMonitor' action may be used to temporarily stop the
 recording of a channel.  The following parameters may
 be used to control this:
  Channel     - Required.  Used to specify the channel to record.

\end{verbatim}


\section{Ping}
\subsection{Synopsis}
\begin{verbatim}
Keepalive command
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
<none>
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: A 'Ping' action will ellicit a 'Pong' response.  Used to keep the
  manager connection open.
Variables: NONE

\end{verbatim}


\section{PlayDTMF}
\subsection{Synopsis}
\begin{verbatim}
Play DTMF signal on a specific channel.
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
call,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: Plays a dtmf digit on the specified channel.
Variables: (all are required)
	Channel: Channel name to send digit to
	Digit: The dtmf digit to play

\end{verbatim}


\section{QueueAdd}
\subsection{Synopsis}
\begin{verbatim}
Add interface to queue.
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
agent,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
(null)
\end{verbatim}


\section{QueueLog}
\subsection{Synopsis}
\begin{verbatim}
Adds custom entry in queue_log
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
agent,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
(null)
\end{verbatim}


\section{QueuePause}
\subsection{Synopsis}
\begin{verbatim}
Makes a queue member temporarily unavailable
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
agent,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
(null)
\end{verbatim}


\section{QueueRemove}
\subsection{Synopsis}
\begin{verbatim}
Remove interface from queue.
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
agent,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
(null)
\end{verbatim}


\section{Queues}
\subsection{Synopsis}
\begin{verbatim}
Queues
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
<none>
\end{verbatim}
\subsection{Description}
\begin{verbatim}
(null)
\end{verbatim}


\section{QueueStatus}
\subsection{Synopsis}
\begin{verbatim}
Queue Status
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
<none>
\end{verbatim}
\subsection{Description}
\begin{verbatim}
(null)
\end{verbatim}


\section{QueueSummary}
\subsection{Synopsis}
\begin{verbatim}
Queue Summary
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
<none>
\end{verbatim}
\subsection{Description}
\begin{verbatim}
(null)
\end{verbatim}


\section{Redirect}
\subsection{Synopsis}
\begin{verbatim}
Redirect (transfer) a call
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
call,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: Redirect (transfer) a call.
Variables: (Names marked with * are required)
	*Channel: Channel to redirect
	ExtraChannel: Second call leg to transfer (optional)
	*Exten: Extension to transfer to
	*Context: Context to transfer to
	*Priority: Priority to transfer to
	ActionID: Optional Action id for message matching.

\end{verbatim}


\section{SendText}
\subsection{Synopsis}
\begin{verbatim}
Send text message to channel
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
call,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: Sends A Text Message while in a call.
Variables: (Names marked with * are required)
       *Channel: Channel to send message to
       *Message: Message to send
       ActionID: Optional Action id for message matching.

\end{verbatim}


\section{Setvar}
\subsection{Synopsis}
\begin{verbatim}
Set Channel Variable
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
call,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: Set a global or local channel variable.
Variables: (Names marked with * are required)
	Channel: Channel to set variable for
	*Variable: Variable name
	*Value: Value

\end{verbatim}


\section{ShowDialPlan}
\subsection{Synopsis}
\begin{verbatim}
List dialplan
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
config,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: Show dialplan contexts and extensions.
Be aware that showing the full dialplan may take a lot of capacity
Variables: 
 ActionID: <id>		Action ID for this AMI transaction (optional)
 Extension: <extension>	Extension (Optional)
 Context: <context>		Context (Optional)


\end{verbatim}


\section{SIPpeers}
\subsection{Synopsis}
\begin{verbatim}
List SIP peers (text format)
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
system,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: Lists SIP peers in text format with details on current status.
Peerlist will follow as separate events, followed by a final event called
PeerlistComplete.
Variables: 
  ActionID: <id>	Action ID for this transaction. Will be returned.

\end{verbatim}


\section{SIPshowpeer}
\subsection{Synopsis}
\begin{verbatim}
Show SIP peer (text format)
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
system,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: Show one SIP peer with details on current status.
Variables: 
  Peer: <name>           The peer name you want to check.
  ActionID: <id>	  Optional action ID for this AMI transaction.

\end{verbatim}


\section{Status}
\subsection{Synopsis}
\begin{verbatim}
Lists channel status
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
call,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
(null)
\end{verbatim}


\section{StopMonitor}
\subsection{Synopsis}
\begin{verbatim}
Stop monitoring a channel
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
call,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: The 'StopMonitor' action may be used to end a previously
  started 'Monitor' action.  The only parameter is 'Channel', the name
  of the channel monitored.

\end{verbatim}


\section{UnpauseMonitor}
\subsection{Synopsis}
\begin{verbatim}
Unpause monitoring of a channel
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
call,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: The 'UnpauseMonitor' action may be used to re-enable recording
  of a channel after calling PauseMonitor.  The following parameters may
  be used to control this:
  Channel     - Required.  Used to specify the channel to record.

\end{verbatim}


\section{UpdateConfig}
\subsection{Synopsis}
\begin{verbatim}
Update basic configuration
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
config,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: A 'UpdateConfig' action will dump the contents of a configuration
file by category and contents.
Variables (X's represent 6 digit number beginning with 000000):
   SrcFilename:   Configuration filename to read(e.g. foo.conf)
   DstFilename:   Configuration filename to write(e.g. foo.conf)
   Reload:        Whether or not a reload should take place (or name of specific module)
   Action-XXXXXX: Action to Take (NewCat,RenameCat,DelCat,Update,Delete,Append)
   Cat-XXXXXX:    Category to operate on
   Var-XXXXXX:    Variable to work on
   Value-XXXXXX:  Value to work on
   Match-XXXXXX:  Extra match required to match line

\end{verbatim}


\section{UserEvent}
\subsection{Synopsis}
\begin{verbatim}
Send an arbitrary event
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
user,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: Send an event to manager sessions.
Variables: (Names marked with * are required)
       *UserEvent: EventStringToSend
       Header1: Content1
       HeaderN: ContentN

\end{verbatim}


\section{VoicemailUsersList}
\subsection{Synopsis}
\begin{verbatim}
List All Voicemail User Information
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
call,all
\end{verbatim}
\subsection{Description}
\begin{verbatim}
(null)
\end{verbatim}


\section{WaitEvent}
\subsection{Synopsis}
\begin{verbatim}
Wait for an event to occur
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
<none>
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Description: A 'WaitEvent' action will ellicit a 'Success' response.  Whenever
a manager event is queued.  Once WaitEvent has been called on an HTTP manager
session, events will be generated and queued.
Variables: 
   Timeout: Maximum time (in seconds) to wait for events, -1 means forever.

\end{verbatim}


\section{ZapDialOffhook}
\subsection{Synopsis}
\begin{verbatim}
Dial over Zap channel while offhook
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
<none>
\end{verbatim}
\subsection{Description}
\begin{verbatim}
(null)
\end{verbatim}


\section{ZapDNDoff}
\subsection{Synopsis}
\begin{verbatim}
Toggle Zap channel Do Not Disturb status OFF
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
<none>
\end{verbatim}
\subsection{Description}
\begin{verbatim}
(null)
\end{verbatim}


\section{ZapDNDon}
\subsection{Synopsis}
\begin{verbatim}
Toggle Zap channel Do Not Disturb status ON
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
<none>
\end{verbatim}
\subsection{Description}
\begin{verbatim}
(null)
\end{verbatim}


\section{ZapHangup}
\subsection{Synopsis}
\begin{verbatim}
Hangup Zap Channel
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
<none>
\end{verbatim}
\subsection{Description}
\begin{verbatim}
(null)
\end{verbatim}


\section{ZapRestart}
\subsection{Synopsis}
\begin{verbatim}
Fully Restart zaptel channels (terminates calls)
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
<none>
\end{verbatim}
\subsection{Description}
\begin{verbatim}
(null)
\end{verbatim}


\section{ZapShowChannels}
\subsection{Synopsis}
\begin{verbatim}
Show status zapata channels
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
<none>
\end{verbatim}
\subsection{Description}
\begin{verbatim}
(null)
\end{verbatim}


\section{ZapTransfer}
\subsection{Synopsis}
\begin{verbatim}
Transfer Zap Channel
\end{verbatim}
\subsection{Authority}
\begin{verbatim}
<none>
\end{verbatim}
\subsection{Description}
\begin{verbatim}
(null)
\end{verbatim}