* Move LaTeX docs into a tex/ subdirectory of the doc/ dir
[asterisk/asterisk.git] / doc / tex / ast_manager_actiondocs.tex
1 % This file is automatically generated by the "manager dump actiondocs" CLI command.  Any manual edits will be lost.
2 \section{AbsoluteTimeout}
3 \subsection{Synopsis}
4 \begin{verbatim}
5 Set Absolute Timeout
6 \end{verbatim}
7 \subsection{Authority}
8 \begin{verbatim}
9 call,all
10 \end{verbatim}
11 \subsection{Description}
12 \begin{verbatim}
13 Description: Hangup a channel after a certain time.
14 Variables: (Names marked with * are required)
15         *Channel: Channel name to hangup
16         *Timeout: Maximum duration of the call (sec)
17 Acknowledges set time with 'Timeout Set' message
18
19 \end{verbatim}
20
21
22 \section{AgentLogoff}
23 \subsection{Synopsis}
24 \begin{verbatim}
25 Sets an agent as no longer logged in
26 \end{verbatim}
27 \subsection{Authority}
28 \begin{verbatim}
29 agent,all
30 \end{verbatim}
31 \subsection{Description}
32 \begin{verbatim}
33 Description: Sets an agent as no longer logged in.
34 Variables: (Names marked with * are required)
35         *Agent: Agent ID of the agent to log off
36         Soft: Set to 'true' to not hangup existing calls
37
38 \end{verbatim}
39
40
41 \section{Agents}
42 \subsection{Synopsis}
43 \begin{verbatim}
44 Lists agents and their status
45 \end{verbatim}
46 \subsection{Authority}
47 \begin{verbatim}
48 agent,all
49 \end{verbatim}
50 \subsection{Description}
51 \begin{verbatim}
52 Description: Will list info about all possible agents.
53 Variables: NONE
54
55 \end{verbatim}
56
57
58 \section{Bridge}
59 \subsection{Synopsis}
60 \begin{verbatim}
61 Bridge two channels already in the PBX
62 \end{verbatim}
63 \subsection{Authority}
64 \begin{verbatim}
65 command,all
66 \end{verbatim}
67 \subsection{Description}
68 \begin{verbatim}
69 Description: Bridge together two channels already in the PBX
70 Variables: ( Headers marked with * are required )
71    *Channel1: Channel to Bridge to Channel2
72    *Channel2: Channel to Bridge to Channel1
73         Tone: (Yes|No) Play courtesy tone to Channel 2
74
75
76 \end{verbatim}
77
78
79 \section{Challenge}
80 \subsection{Synopsis}
81 \begin{verbatim}
82 Generate Challenge for MD5 Auth
83 \end{verbatim}
84 \subsection{Authority}
85 \begin{verbatim}
86 <none>
87 \end{verbatim}
88 \subsection{Description}
89 \begin{verbatim}
90 (null)
91 \end{verbatim}
92
93
94 \section{ChangeMonitor}
95 \subsection{Synopsis}
96 \begin{verbatim}
97 Change monitoring filename of a channel
98 \end{verbatim}
99 \subsection{Authority}
100 \begin{verbatim}
101 call,all
102 \end{verbatim}
103 \subsection{Description}
104 \begin{verbatim}
105 Description: The 'ChangeMonitor' action may be used to change the file
106   started by a previous 'Monitor' action.  The following parameters may
107   be used to control this:
108   Channel     - Required.  Used to specify the channel to record.
109   File        - Required.  Is the new name of the file created in the
110                 monitor spool directory.
111
112 \end{verbatim}
113
114
115 \section{Command}
116 \subsection{Synopsis}
117 \begin{verbatim}
118 Execute Asterisk CLI Command
119 \end{verbatim}
120 \subsection{Authority}
121 \begin{verbatim}
122 command,all
123 \end{verbatim}
124 \subsection{Description}
125 \begin{verbatim}
126 Description: Run a CLI command.
127 Variables: (Names marked with * are required)
128         *Command: Asterisk CLI command to run
129         ActionID: Optional Action id for message matching.
130
131 \end{verbatim}
132
133
134 \section{CoreSettings}
135 \subsection{Synopsis}
136 \begin{verbatim}
137 Show PBX core settings (version etc)
138 \end{verbatim}
139 \subsection{Authority}
140 \begin{verbatim}
141 system,all
142 \end{verbatim}
143 \subsection{Description}
144 \begin{verbatim}
145 Description: Query for Core PBX settings.
146 Variables: (Names marked with * are optional)
147        *ActionID: ActionID of this transaction
148
149 \end{verbatim}
150
151
152 \section{CoreStatus}
153 \subsection{Synopsis}
154 \begin{verbatim}
155 Show PBX core status variables
156 \end{verbatim}
157 \subsection{Authority}
158 \begin{verbatim}
159 system,all
160 \end{verbatim}
161 \subsection{Description}
162 \begin{verbatim}
163 Description: Query for Core PBX status.
164 Variables: (Names marked with * are optional)
165        *ActionID: ActionID of this transaction
166
167 \end{verbatim}
168
169
170 \section{DBDel}
171 \subsection{Synopsis}
172 \begin{verbatim}
173 Delete DB Entry
174 \end{verbatim}
175 \subsection{Authority}
176 \begin{verbatim}
177 system,all
178 \end{verbatim}
179 \subsection{Description}
180 \begin{verbatim}
181 (null)
182 \end{verbatim}
183
184
185 \section{DBDelTree}
186 \subsection{Synopsis}
187 \begin{verbatim}
188 Delete DB Tree
189 \end{verbatim}
190 \subsection{Authority}
191 \begin{verbatim}
192 system,all
193 \end{verbatim}
194 \subsection{Description}
195 \begin{verbatim}
196 (null)
197 \end{verbatim}
198
199
200 \section{DBGet}
201 \subsection{Synopsis}
202 \begin{verbatim}
203 Get DB Entry
204 \end{verbatim}
205 \subsection{Authority}
206 \begin{verbatim}
207 system,all
208 \end{verbatim}
209 \subsection{Description}
210 \begin{verbatim}
211 (null)
212 \end{verbatim}
213
214
215 \section{DBPut}
216 \subsection{Synopsis}
217 \begin{verbatim}
218 Put DB Entry
219 \end{verbatim}
220 \subsection{Authority}
221 \begin{verbatim}
222 system,all
223 \end{verbatim}
224 \subsection{Description}
225 \begin{verbatim}
226 (null)
227 \end{verbatim}
228
229
230 \section{Events}
231 \subsection{Synopsis}
232 \begin{verbatim}
233 Control Event Flow
234 \end{verbatim}
235 \subsection{Authority}
236 \begin{verbatim}
237 <none>
238 \end{verbatim}
239 \subsection{Description}
240 \begin{verbatim}
241 Description: Enable/Disable sending of events to this manager
242   client.
243 Variables:
244         EventMask: 'on' if all events should be sent,
245                 'off' if no events should be sent,
246                 'system,call,log' to select which flags events should have to be sent.
247
248 \end{verbatim}
249
250
251 \section{ExtensionState}
252 \subsection{Synopsis}
253 \begin{verbatim}
254 Check Extension Status
255 \end{verbatim}
256 \subsection{Authority}
257 \begin{verbatim}
258 call,all
259 \end{verbatim}
260 \subsection{Description}
261 \begin{verbatim}
262 Description: Report the extension state for given extension.
263   If the extension has a hint, will use devicestate to check
264   the status of the device connected to the extension.
265 Variables: (Names marked with * are required)
266         *Exten: Extension to check state on
267         *Context: Context for extension
268         ActionId: Optional ID for this transaction
269 Will return an "Extension Status" message.
270 The response will include the hint for the extension and the status.
271
272 \end{verbatim}
273
274
275 \section{GetConfig}
276 \subsection{Synopsis}
277 \begin{verbatim}
278 Retrieve configuration
279 \end{verbatim}
280 \subsection{Authority}
281 \begin{verbatim}
282 config,all
283 \end{verbatim}
284 \subsection{Description}
285 \begin{verbatim}
286 Description: A 'GetConfig' action will dump the contents of a configuration
287 file by category and contents.
288 Variables:
289    Filename: Configuration filename (e.g. foo.conf)
290
291 \end{verbatim}
292
293
294 \section{GetConfigJSON}
295 \subsection{Synopsis}
296 \begin{verbatim}
297 Retrieve configuration (JSON format)
298 \end{verbatim}
299 \subsection{Authority}
300 \begin{verbatim}
301 config,all
302 \end{verbatim}
303 \subsection{Description}
304 \begin{verbatim}
305 Description: A 'GetConfigJSON' action will dump the contents of a configuration
306 file by category and contents in JSON format.  This only makes sense to be used
307 using rawman over the HTTP interface.
308 Variables:
309    Filename: Configuration filename (e.g. foo.conf)
310
311 \end{verbatim}
312
313
314 \section{Getvar}
315 \subsection{Synopsis}
316 \begin{verbatim}
317 Gets a Channel Variable
318 \end{verbatim}
319 \subsection{Authority}
320 \begin{verbatim}
321 call,all
322 \end{verbatim}
323 \subsection{Description}
324 \begin{verbatim}
325 Description: Get the value of a global or local channel variable.
326 Variables: (Names marked with * are required)
327         Channel: Channel to read variable from
328         *Variable: Variable name
329         ActionID: Optional Action id for message matching.
330
331 \end{verbatim}
332
333
334 \section{Hangup}
335 \subsection{Synopsis}
336 \begin{verbatim}
337 Hangup Channel
338 \end{verbatim}
339 \subsection{Authority}
340 \begin{verbatim}
341 call,all
342 \end{verbatim}
343 \subsection{Description}
344 \begin{verbatim}
345 Description: Hangup a channel
346 Variables: 
347         Channel: The channel name to be hungup
348
349 \end{verbatim}
350
351
352 \section{IAXnetstats}
353 \subsection{Synopsis}
354 \begin{verbatim}
355 Show IAX Netstats
356 \end{verbatim}
357 \subsection{Authority}
358 \begin{verbatim}
359 <none>
360 \end{verbatim}
361 \subsection{Description}
362 \begin{verbatim}
363 (null)
364 \end{verbatim}
365
366
367 \section{IAXpeers}
368 \subsection{Synopsis}
369 \begin{verbatim}
370 List IAX Peers
371 \end{verbatim}
372 \subsection{Authority}
373 \begin{verbatim}
374 <none>
375 \end{verbatim}
376 \subsection{Description}
377 \begin{verbatim}
378 (null)
379 \end{verbatim}
380
381
382 \section{JabberSend}
383 \subsection{Synopsis}
384 \begin{verbatim}
385 Sends a message to a Jabber Client
386 \end{verbatim}
387 \subsection{Authority}
388 \begin{verbatim}
389 system,all
390 \end{verbatim}
391 \subsection{Description}
392 \begin{verbatim}
393 Description: Sends a message to a Jabber Client.
394 Variables: 
395   Jabber:       Client or transport Asterisk uses to connect to JABBER.
396   ScreenName:   User Name to message.
397   Message:      Message to be sent to the buddy
398
399 \end{verbatim}
400
401
402 \section{ListCommands}
403 \subsection{Synopsis}
404 \begin{verbatim}
405 List available manager commands
406 \end{verbatim}
407 \subsection{Authority}
408 \begin{verbatim}
409 <none>
410 \end{verbatim}
411 \subsection{Description}
412 \begin{verbatim}
413 Description: Returns the action name and synopsis for every
414   action that is available to the user
415 Variables: NONE
416
417 \end{verbatim}
418
419
420 \section{Login}
421 \subsection{Synopsis}
422 \begin{verbatim}
423 Login Manager
424 \end{verbatim}
425 \subsection{Authority}
426 \begin{verbatim}
427 <none>
428 \end{verbatim}
429 \subsection{Description}
430 \begin{verbatim}
431 (null)
432 \end{verbatim}
433
434
435 \section{Logoff}
436 \subsection{Synopsis}
437 \begin{verbatim}
438 Logoff Manager
439 \end{verbatim}
440 \subsection{Authority}
441 \begin{verbatim}
442 <none>
443 \end{verbatim}
444 \subsection{Description}
445 \begin{verbatim}
446 Description: Logoff this manager session
447 Variables: NONE
448
449 \end{verbatim}
450
451
452 \section{MailboxCount}
453 \subsection{Synopsis}
454 \begin{verbatim}
455 Check Mailbox Message Count
456 \end{verbatim}
457 \subsection{Authority}
458 \begin{verbatim}
459 call,all
460 \end{verbatim}
461 \subsection{Description}
462 \begin{verbatim}
463 Description: Checks a voicemail account for new messages.
464 Variables: (Names marked with * are required)
465         *Mailbox: Full mailbox ID <mailbox>@<vm-context>
466         ActionID: Optional ActionID for message matching.
467 Returns number of new and old messages.
468         Message: Mailbox Message Count
469         Mailbox: <mailboxid>
470         NewMessages: <count>
471         OldMessages: <count>
472
473
474 \end{verbatim}
475
476
477 \section{MailboxStatus}
478 \subsection{Synopsis}
479 \begin{verbatim}
480 Check Mailbox
481 \end{verbatim}
482 \subsection{Authority}
483 \begin{verbatim}
484 call,all
485 \end{verbatim}
486 \subsection{Description}
487 \begin{verbatim}
488 Description: Checks a voicemail account for status.
489 Variables: (Names marked with * are required)
490         *Mailbox: Full mailbox ID <mailbox>@<vm-context>
491         ActionID: Optional ActionID for message matching.
492 Returns number of messages.
493         Message: Mailbox Status
494         Mailbox: <mailboxid>
495         Waiting: <count>
496
497
498 \end{verbatim}
499
500
501 \section{MeetmeMute}
502 \subsection{Synopsis}
503 \begin{verbatim}
504 Mute a Meetme user
505 \end{verbatim}
506 \subsection{Authority}
507 \begin{verbatim}
508 call,all
509 \end{verbatim}
510 \subsection{Description}
511 \begin{verbatim}
512 (null)
513 \end{verbatim}
514
515
516 \section{MeetmeUnmute}
517 \subsection{Synopsis}
518 \begin{verbatim}
519 Unmute a Meetme user
520 \end{verbatim}
521 \subsection{Authority}
522 \begin{verbatim}
523 call,all
524 \end{verbatim}
525 \subsection{Description}
526 \begin{verbatim}
527 (null)
528 \end{verbatim}
529
530
531 \section{Monitor}
532 \subsection{Synopsis}
533 \begin{verbatim}
534 Monitor a channel
535 \end{verbatim}
536 \subsection{Authority}
537 \begin{verbatim}
538 call,all
539 \end{verbatim}
540 \subsection{Description}
541 \begin{verbatim}
542 Description: The 'Monitor' action may be used to record the audio on a
543   specified channel.  The following parameters may be used to control
544   this:
545   Channel     - Required.  Used to specify the channel to record.
546   File        - Optional.  Is the name of the file created in the
547                 monitor spool directory.  Defaults to the same name
548                 as the channel (with slashes replaced with dashes).
549   Format      - Optional.  Is the audio recording format.  Defaults
550                 to "wav".
551   Mix         - Optional.  Boolean parameter as to whether to mix
552                 the input and output channels together after the
553                 recording is finished.
554
555 \end{verbatim}
556
557
558 \section{Originate}
559 \subsection{Synopsis}
560 \begin{verbatim}
561 Originate Call
562 \end{verbatim}
563 \subsection{Authority}
564 \begin{verbatim}
565 call,all
566 \end{verbatim}
567 \subsection{Description}
568 \begin{verbatim}
569 Description: Generates an outgoing call to a Extension/Context/Priority or
570   Application/Data
571 Variables: (Names marked with * are required)
572         *Channel: Channel name to call
573         Exten: Extension to use (requires 'Context' and 'Priority')
574         Context: Context to use (requires 'Exten' and 'Priority')
575         Priority: Priority to use (requires 'Exten' and 'Context')
576         Application: Application to use
577         Data: Data to use (requires 'Application')
578         Timeout: How long to wait for call to be answered (in ms)
579         CallerID: Caller ID to be set on the outgoing channel
580         Variable: Channel variable to set, multiple Variable: headers are allowed
581         Account: Account code
582         Async: Set to 'true' for fast origination
583
584 \end{verbatim}
585
586
587 \section{Park}
588 \subsection{Synopsis}
589 \begin{verbatim}
590 Park a channel
591 \end{verbatim}
592 \subsection{Authority}
593 \begin{verbatim}
594 call,all
595 \end{verbatim}
596 \subsection{Description}
597 \begin{verbatim}
598 Description: Park a channel.
599 Variables: (Names marked with * are required)
600         *Channel: Channel name to park
601         *Channel2: Channel to announce park info to (and return to if timeout)
602         Timeout: Number of milliseconds to wait before callback.
603
604 \end{verbatim}
605
606
607 \section{ParkedCalls}
608 \subsection{Synopsis}
609 \begin{verbatim}
610 List parked calls
611 \end{verbatim}
612 \subsection{Authority}
613 \begin{verbatim}
614 <none>
615 \end{verbatim}
616 \subsection{Description}
617 \begin{verbatim}
618 (null)
619 \end{verbatim}
620
621
622 \section{PauseMonitor}
623 \subsection{Synopsis}
624 \begin{verbatim}
625 Pause monitoring of a channel
626 \end{verbatim}
627 \subsection{Authority}
628 \begin{verbatim}
629 call,all
630 \end{verbatim}
631 \subsection{Description}
632 \begin{verbatim}
633 Description: The 'PauseMonitor' action may be used to temporarily stop the
634  recording of a channel.  The following parameters may
635  be used to control this:
636   Channel     - Required.  Used to specify the channel to record.
637
638 \end{verbatim}
639
640
641 \section{Ping}
642 \subsection{Synopsis}
643 \begin{verbatim}
644 Keepalive command
645 \end{verbatim}
646 \subsection{Authority}
647 \begin{verbatim}
648 <none>
649 \end{verbatim}
650 \subsection{Description}
651 \begin{verbatim}
652 Description: A 'Ping' action will ellicit a 'Pong' response.  Used to keep the
653   manager connection open.
654 Variables: NONE
655
656 \end{verbatim}
657
658
659 \section{PlayDTMF}
660 \subsection{Synopsis}
661 \begin{verbatim}
662 Play DTMF signal on a specific channel.
663 \end{verbatim}
664 \subsection{Authority}
665 \begin{verbatim}
666 call,all
667 \end{verbatim}
668 \subsection{Description}
669 \begin{verbatim}
670 Description: Plays a dtmf digit on the specified channel.
671 Variables: (all are required)
672         Channel: Channel name to send digit to
673         Digit: The dtmf digit to play
674
675 \end{verbatim}
676
677
678 \section{QueueAdd}
679 \subsection{Synopsis}
680 \begin{verbatim}
681 Add interface to queue.
682 \end{verbatim}
683 \subsection{Authority}
684 \begin{verbatim}
685 agent,all
686 \end{verbatim}
687 \subsection{Description}
688 \begin{verbatim}
689 (null)
690 \end{verbatim}
691
692
693 \section{QueueLog}
694 \subsection{Synopsis}
695 \begin{verbatim}
696 Adds custom entry in queue_log
697 \end{verbatim}
698 \subsection{Authority}
699 \begin{verbatim}
700 agent,all
701 \end{verbatim}
702 \subsection{Description}
703 \begin{verbatim}
704 (null)
705 \end{verbatim}
706
707
708 \section{QueuePause}
709 \subsection{Synopsis}
710 \begin{verbatim}
711 Makes a queue member temporarily unavailable
712 \end{verbatim}
713 \subsection{Authority}
714 \begin{verbatim}
715 agent,all
716 \end{verbatim}
717 \subsection{Description}
718 \begin{verbatim}
719 (null)
720 \end{verbatim}
721
722
723 \section{QueueRemove}
724 \subsection{Synopsis}
725 \begin{verbatim}
726 Remove interface from queue.
727 \end{verbatim}
728 \subsection{Authority}
729 \begin{verbatim}
730 agent,all
731 \end{verbatim}
732 \subsection{Description}
733 \begin{verbatim}
734 (null)
735 \end{verbatim}
736
737
738 \section{Queues}
739 \subsection{Synopsis}
740 \begin{verbatim}
741 Queues
742 \end{verbatim}
743 \subsection{Authority}
744 \begin{verbatim}
745 <none>
746 \end{verbatim}
747 \subsection{Description}
748 \begin{verbatim}
749 (null)
750 \end{verbatim}
751
752
753 \section{QueueStatus}
754 \subsection{Synopsis}
755 \begin{verbatim}
756 Queue Status
757 \end{verbatim}
758 \subsection{Authority}
759 \begin{verbatim}
760 <none>
761 \end{verbatim}
762 \subsection{Description}
763 \begin{verbatim}
764 (null)
765 \end{verbatim}
766
767
768 \section{QueueSummary}
769 \subsection{Synopsis}
770 \begin{verbatim}
771 Queue Summary
772 \end{verbatim}
773 \subsection{Authority}
774 \begin{verbatim}
775 <none>
776 \end{verbatim}
777 \subsection{Description}
778 \begin{verbatim}
779 (null)
780 \end{verbatim}
781
782
783 \section{Redirect}
784 \subsection{Synopsis}
785 \begin{verbatim}
786 Redirect (transfer) a call
787 \end{verbatim}
788 \subsection{Authority}
789 \begin{verbatim}
790 call,all
791 \end{verbatim}
792 \subsection{Description}
793 \begin{verbatim}
794 Description: Redirect (transfer) a call.
795 Variables: (Names marked with * are required)
796         *Channel: Channel to redirect
797         ExtraChannel: Second call leg to transfer (optional)
798         *Exten: Extension to transfer to
799         *Context: Context to transfer to
800         *Priority: Priority to transfer to
801         ActionID: Optional Action id for message matching.
802
803 \end{verbatim}
804
805
806 \section{SendText}
807 \subsection{Synopsis}
808 \begin{verbatim}
809 Send text message to channel
810 \end{verbatim}
811 \subsection{Authority}
812 \begin{verbatim}
813 call,all
814 \end{verbatim}
815 \subsection{Description}
816 \begin{verbatim}
817 Description: Sends A Text Message while in a call.
818 Variables: (Names marked with * are required)
819        *Channel: Channel to send message to
820        *Message: Message to send
821        ActionID: Optional Action id for message matching.
822
823 \end{verbatim}
824
825
826 \section{Setvar}
827 \subsection{Synopsis}
828 \begin{verbatim}
829 Set Channel Variable
830 \end{verbatim}
831 \subsection{Authority}
832 \begin{verbatim}
833 call,all
834 \end{verbatim}
835 \subsection{Description}
836 \begin{verbatim}
837 Description: Set a global or local channel variable.
838 Variables: (Names marked with * are required)
839         Channel: Channel to set variable for
840         *Variable: Variable name
841         *Value: Value
842
843 \end{verbatim}
844
845
846 \section{ShowDialPlan}
847 \subsection{Synopsis}
848 \begin{verbatim}
849 List dialplan
850 \end{verbatim}
851 \subsection{Authority}
852 \begin{verbatim}
853 config,all
854 \end{verbatim}
855 \subsection{Description}
856 \begin{verbatim}
857 Description: Show dialplan contexts and extensions.
858 Be aware that showing the full dialplan may take a lot of capacity
859 Variables: 
860  ActionID: <id>         Action ID for this AMI transaction (optional)
861  Extension: <extension> Extension (Optional)
862  Context: <context>             Context (Optional)
863
864
865 \end{verbatim}
866
867
868 \section{SIPpeers}
869 \subsection{Synopsis}
870 \begin{verbatim}
871 List SIP peers (text format)
872 \end{verbatim}
873 \subsection{Authority}
874 \begin{verbatim}
875 system,all
876 \end{verbatim}
877 \subsection{Description}
878 \begin{verbatim}
879 Description: Lists SIP peers in text format with details on current status.
880 Peerlist will follow as separate events, followed by a final event called
881 PeerlistComplete.
882 Variables: 
883   ActionID: <id>        Action ID for this transaction. Will be returned.
884
885 \end{verbatim}
886
887
888 \section{SIPshowpeer}
889 \subsection{Synopsis}
890 \begin{verbatim}
891 Show SIP peer (text format)
892 \end{verbatim}
893 \subsection{Authority}
894 \begin{verbatim}
895 system,all
896 \end{verbatim}
897 \subsection{Description}
898 \begin{verbatim}
899 Description: Show one SIP peer with details on current status.
900 Variables: 
901   Peer: <name>           The peer name you want to check.
902   ActionID: <id>          Optional action ID for this AMI transaction.
903
904 \end{verbatim}
905
906
907 \section{Status}
908 \subsection{Synopsis}
909 \begin{verbatim}
910 Lists channel status
911 \end{verbatim}
912 \subsection{Authority}
913 \begin{verbatim}
914 call,all
915 \end{verbatim}
916 \subsection{Description}
917 \begin{verbatim}
918 (null)
919 \end{verbatim}
920
921
922 \section{StopMonitor}
923 \subsection{Synopsis}
924 \begin{verbatim}
925 Stop monitoring a channel
926 \end{verbatim}
927 \subsection{Authority}
928 \begin{verbatim}
929 call,all
930 \end{verbatim}
931 \subsection{Description}
932 \begin{verbatim}
933 Description: The 'StopMonitor' action may be used to end a previously
934   started 'Monitor' action.  The only parameter is 'Channel', the name
935   of the channel monitored.
936
937 \end{verbatim}
938
939
940 \section{UnpauseMonitor}
941 \subsection{Synopsis}
942 \begin{verbatim}
943 Unpause monitoring of a channel
944 \end{verbatim}
945 \subsection{Authority}
946 \begin{verbatim}
947 call,all
948 \end{verbatim}
949 \subsection{Description}
950 \begin{verbatim}
951 Description: The 'UnpauseMonitor' action may be used to re-enable recording
952   of a channel after calling PauseMonitor.  The following parameters may
953   be used to control this:
954   Channel     - Required.  Used to specify the channel to record.
955
956 \end{verbatim}
957
958
959 \section{UpdateConfig}
960 \subsection{Synopsis}
961 \begin{verbatim}
962 Update basic configuration
963 \end{verbatim}
964 \subsection{Authority}
965 \begin{verbatim}
966 config,all
967 \end{verbatim}
968 \subsection{Description}
969 \begin{verbatim}
970 Description: A 'UpdateConfig' action will dump the contents of a configuration
971 file by category and contents.
972 Variables (X's represent 6 digit number beginning with 000000):
973    SrcFilename:   Configuration filename to read(e.g. foo.conf)
974    DstFilename:   Configuration filename to write(e.g. foo.conf)
975    Reload:        Whether or not a reload should take place (or name of specific module)
976    Action-XXXXXX: Action to Take (NewCat,RenameCat,DelCat,Update,Delete,Append)
977    Cat-XXXXXX:    Category to operate on
978    Var-XXXXXX:    Variable to work on
979    Value-XXXXXX:  Value to work on
980    Match-XXXXXX:  Extra match required to match line
981
982 \end{verbatim}
983
984
985 \section{UserEvent}
986 \subsection{Synopsis}
987 \begin{verbatim}
988 Send an arbitrary event
989 \end{verbatim}
990 \subsection{Authority}
991 \begin{verbatim}
992 user,all
993 \end{verbatim}
994 \subsection{Description}
995 \begin{verbatim}
996 Description: Send an event to manager sessions.
997 Variables: (Names marked with * are required)
998        *UserEvent: EventStringToSend
999        Header1: Content1
1000        HeaderN: ContentN
1001
1002 \end{verbatim}
1003
1004
1005 \section{VoicemailUsersList}
1006 \subsection{Synopsis}
1007 \begin{verbatim}
1008 List All Voicemail User Information
1009 \end{verbatim}
1010 \subsection{Authority}
1011 \begin{verbatim}
1012 call,all
1013 \end{verbatim}
1014 \subsection{Description}
1015 \begin{verbatim}
1016 (null)
1017 \end{verbatim}
1018
1019
1020 \section{WaitEvent}
1021 \subsection{Synopsis}
1022 \begin{verbatim}
1023 Wait for an event to occur
1024 \end{verbatim}
1025 \subsection{Authority}
1026 \begin{verbatim}
1027 <none>
1028 \end{verbatim}
1029 \subsection{Description}
1030 \begin{verbatim}
1031 Description: A 'WaitEvent' action will ellicit a 'Success' response.  Whenever
1032 a manager event is queued.  Once WaitEvent has been called on an HTTP manager
1033 session, events will be generated and queued.
1034 Variables: 
1035    Timeout: Maximum time (in seconds) to wait for events, -1 means forever.
1036
1037 \end{verbatim}
1038
1039
1040 \section{ZapDialOffhook}
1041 \subsection{Synopsis}
1042 \begin{verbatim}
1043 Dial over Zap channel while offhook
1044 \end{verbatim}
1045 \subsection{Authority}
1046 \begin{verbatim}
1047 <none>
1048 \end{verbatim}
1049 \subsection{Description}
1050 \begin{verbatim}
1051 (null)
1052 \end{verbatim}
1053
1054
1055 \section{ZapDNDoff}
1056 \subsection{Synopsis}
1057 \begin{verbatim}
1058 Toggle Zap channel Do Not Disturb status OFF
1059 \end{verbatim}
1060 \subsection{Authority}
1061 \begin{verbatim}
1062 <none>
1063 \end{verbatim}
1064 \subsection{Description}
1065 \begin{verbatim}
1066 (null)
1067 \end{verbatim}
1068
1069
1070 \section{ZapDNDon}
1071 \subsection{Synopsis}
1072 \begin{verbatim}
1073 Toggle Zap channel Do Not Disturb status ON
1074 \end{verbatim}
1075 \subsection{Authority}
1076 \begin{verbatim}
1077 <none>
1078 \end{verbatim}
1079 \subsection{Description}
1080 \begin{verbatim}
1081 (null)
1082 \end{verbatim}
1083
1084
1085 \section{ZapHangup}
1086 \subsection{Synopsis}
1087 \begin{verbatim}
1088 Hangup Zap Channel
1089 \end{verbatim}
1090 \subsection{Authority}
1091 \begin{verbatim}
1092 <none>
1093 \end{verbatim}
1094 \subsection{Description}
1095 \begin{verbatim}
1096 (null)
1097 \end{verbatim}
1098
1099
1100 \section{ZapRestart}
1101 \subsection{Synopsis}
1102 \begin{verbatim}
1103 Fully Restart zaptel channels (terminates calls)
1104 \end{verbatim}
1105 \subsection{Authority}
1106 \begin{verbatim}
1107 <none>
1108 \end{verbatim}
1109 \subsection{Description}
1110 \begin{verbatim}
1111 (null)
1112 \end{verbatim}
1113
1114
1115 \section{ZapShowChannels}
1116 \subsection{Synopsis}
1117 \begin{verbatim}
1118 Show status zapata channels
1119 \end{verbatim}
1120 \subsection{Authority}
1121 \begin{verbatim}
1122 <none>
1123 \end{verbatim}
1124 \subsection{Description}
1125 \begin{verbatim}
1126 (null)
1127 \end{verbatim}
1128
1129
1130 \section{ZapTransfer}
1131 \subsection{Synopsis}
1132 \begin{verbatim}
1133 Transfer Zap Channel
1134 \end{verbatim}
1135 \subsection{Authority}
1136 \begin{verbatim}
1137 <none>
1138 \end{verbatim}
1139 \subsection{Description}
1140 \begin{verbatim}
1141 (null)
1142 \end{verbatim}
1143
1144