documentation: Add missing AMI documentation
Adds missing documentation for some channel, bridge, and queue events. ASTERISK-24427 ASTERISK-29515 Change-Id: I92b06b88c8cadc0155f95ebe3e870b3e795a8c64
This commit is contained in:
parent
1ddaedeaf5
commit
70bc0ff9d0
|
@ -1058,6 +1058,85 @@
|
|||
</description>
|
||||
</manager>
|
||||
|
||||
<managerEvent language="en_US" name="QueueParams">
|
||||
<managerEventInstance class="EVENT_FLAG_AGENT">
|
||||
<synopsis>Raised in response to the QueueStatus action.</synopsis>
|
||||
<syntax>
|
||||
<parameter name="Max">
|
||||
<para>The name of the queue.</para>
|
||||
</parameter>
|
||||
<parameter name="Strategy">
|
||||
<para>The strategy of the queue.</para>
|
||||
</parameter>
|
||||
<parameter name="Calls">
|
||||
<para>The queue member's channel technology or location.</para>
|
||||
</parameter>
|
||||
<parameter name="Holdtime">
|
||||
<para>The queue's hold time.</para>
|
||||
</parameter>
|
||||
<parameter name="TalkTime">
|
||||
<para>The queue's talk time.</para>
|
||||
</parameter>
|
||||
<parameter name="Completed">
|
||||
<para>The queue's completion time.</para>
|
||||
</parameter>
|
||||
<parameter name="Abandoned">
|
||||
<para>The queue's call abandonment metric.</para>
|
||||
</parameter>
|
||||
<parameter name="ServiceLevelPerf">
|
||||
<para>Primary service level performance metric.</para>
|
||||
</parameter>
|
||||
<parameter name="ServiceLevelPerf2">
|
||||
<para>Secondary service level performance metric.</para>
|
||||
</parameter>
|
||||
</syntax>
|
||||
<see-also>
|
||||
<ref type="managerEvent">QueueMember</ref>
|
||||
<ref type="managerEvent">QueueEntry</ref>
|
||||
</see-also>
|
||||
</managerEventInstance>
|
||||
</managerEvent>
|
||||
<managerEvent language="en_US" name="QueueEntry">
|
||||
<managerEventInstance class="EVENT_FLAG_AGENT">
|
||||
<synopsis>Raised in response to the QueueStatus action.</synopsis>
|
||||
<syntax>
|
||||
<parameter name="Queue">
|
||||
<para>The name of the queue.</para>
|
||||
</parameter>
|
||||
<parameter name="Position">
|
||||
<para>The caller's position within the queue.</para>
|
||||
</parameter>
|
||||
<parameter name="Channel">
|
||||
<para>The name of the caller's channel.</para>
|
||||
</parameter>
|
||||
<parameter name="Uniqueid">
|
||||
<para>The unique ID of the channel.</para>
|
||||
</parameter>
|
||||
<parameter name="CallerIDNum">
|
||||
<para>The Caller ID number.</para>
|
||||
</parameter>
|
||||
<parameter name="CallerIDName">
|
||||
<para>The Caller ID name.</para>
|
||||
</parameter>
|
||||
<parameter name="ConnectedLineNum">
|
||||
<para>The bridged party's number.</para>
|
||||
</parameter>
|
||||
<parameter name="ConnectedLineName">
|
||||
<para>The bridged party's name.</para>
|
||||
</parameter>
|
||||
<parameter name="Wait">
|
||||
<para>The caller's wait time.</para>
|
||||
</parameter>
|
||||
<parameter name="Priority">
|
||||
<para>The caller's priority within the queue.</para>
|
||||
</parameter>
|
||||
</syntax>
|
||||
<see-also>
|
||||
<ref type="managerEvent">QueueParams</ref>
|
||||
<ref type="managerEvent">QueueMember</ref>
|
||||
</see-also>
|
||||
</managerEventInstance>
|
||||
</managerEvent>
|
||||
<managerEvent language="en_US" name="QueueMemberStatus">
|
||||
<managerEventInstance class="EVENT_FLAG_AGENT">
|
||||
<synopsis>Raised when a Queue member's status has changed.</synopsis>
|
||||
|
|
|
@ -6813,9 +6813,11 @@ int ast_channel_make_compatible(struct ast_channel *chan, struct ast_channel *pe
|
|||
static void __ast_change_name_nolink(struct ast_channel *chan, const char *newname)
|
||||
{
|
||||
/*** DOCUMENTATION
|
||||
<managerEventInstance>
|
||||
<synopsis>Raised when the name of a channel is changed.</synopsis>
|
||||
</managerEventInstance>
|
||||
<managerEvent language="en_US" name="Rename">
|
||||
<managerEventInstance class="EVENT_FLAG_CALL">
|
||||
<synopsis>Raised when the name of a channel is changed.</synopsis>
|
||||
</managerEventInstance>
|
||||
</managerEvent>
|
||||
***/
|
||||
ast_manager_event(chan, EVENT_FLAG_CALL, "Rename",
|
||||
"Channel: %s\r\n"
|
||||
|
|
|
@ -1222,14 +1222,16 @@ static int reload_logger(int rotate, const char *altconf)
|
|||
if (f->disabled) {
|
||||
f->disabled = 0; /* Re-enable logging at reload */
|
||||
/*** DOCUMENTATION
|
||||
<managerEventInstance>
|
||||
<synopsis>Raised when a logging channel is re-enabled after a reload operation.</synopsis>
|
||||
<syntax>
|
||||
<parameter name="Channel">
|
||||
<para>The name of the logging channel.</para>
|
||||
</parameter>
|
||||
</syntax>
|
||||
</managerEventInstance>
|
||||
<managerEvent language="en_US" name="LogChannel">
|
||||
<managerEventInstance class="EVENT_FLAG_SYSTEM">
|
||||
<synopsis>Raised when a logging channel is re-enabled after a reload operation.</synopsis>
|
||||
<syntax>
|
||||
<parameter name="Channel">
|
||||
<para>The name of the logging channel.</para>
|
||||
</parameter>
|
||||
</syntax>
|
||||
</managerEventInstance>
|
||||
</managerEvent>
|
||||
***/
|
||||
manager_event(EVENT_FLAG_SYSTEM, "LogChannel", "Channel: %s\r\nEnabled: Yes\r\n", f->filename);
|
||||
}
|
||||
|
|
|
@ -376,13 +376,15 @@ static void bridge_merge_cb(void *data, struct stasis_subscription *sub,
|
|||
}
|
||||
|
||||
/*** DOCUMENTATION
|
||||
<managerEventInstance>
|
||||
<synopsis>Raised when two bridges are merged.</synopsis>
|
||||
<syntax>
|
||||
<bridge_snapshot prefix="To"/>
|
||||
<bridge_snapshot prefix="From"/>
|
||||
</syntax>
|
||||
</managerEventInstance>
|
||||
<managerEvent language="en_US" name="BridgeMerge">
|
||||
<managerEventInstance class="EVENT_FLAG_CALL">
|
||||
<synopsis>Raised when two bridges are merged.</synopsis>
|
||||
<syntax>
|
||||
<bridge_snapshot prefix="To"/>
|
||||
<bridge_snapshot prefix="From"/>
|
||||
</syntax>
|
||||
</managerEventInstance>
|
||||
</managerEvent>
|
||||
***/
|
||||
manager_event(EVENT_FLAG_CALL, "BridgeMerge",
|
||||
"%s"
|
||||
|
|
|
@ -891,24 +891,26 @@ static void channel_dtmf_begin_cb(void *data, struct stasis_subscription *sub,
|
|||
}
|
||||
|
||||
/*** DOCUMENTATION
|
||||
<managerEventInstance>
|
||||
<synopsis>Raised when a DTMF digit has started on a channel.</synopsis>
|
||||
<syntax>
|
||||
<channel_snapshot/>
|
||||
<parameter name="Digit">
|
||||
<para>DTMF digit received or transmitted (0-9, A-E, # or *</para>
|
||||
</parameter>
|
||||
<parameter name="Direction">
|
||||
<enumlist>
|
||||
<enum name="Received"/>
|
||||
<enum name="Sent"/>
|
||||
</enumlist>
|
||||
</parameter>
|
||||
</syntax>
|
||||
<see-also>
|
||||
<ref type="managerEvent">DTMFEnd</ref>
|
||||
</see-also>
|
||||
</managerEventInstance>
|
||||
<managerEvent language="en_US" name="DTMFBegin">
|
||||
<managerEventInstance class="EVENT_FLAG_DTMF">
|
||||
<synopsis>Raised when a DTMF digit has started on a channel.</synopsis>
|
||||
<syntax>
|
||||
<channel_snapshot/>
|
||||
<parameter name="Digit">
|
||||
<para>DTMF digit received or transmitted (0-9, A-E, # or *</para>
|
||||
</parameter>
|
||||
<parameter name="Direction">
|
||||
<enumlist>
|
||||
<enum name="Received"/>
|
||||
<enum name="Sent"/>
|
||||
</enumlist>
|
||||
</parameter>
|
||||
</syntax>
|
||||
<see-also>
|
||||
<ref type="managerEvent">DTMFEnd</ref>
|
||||
</see-also>
|
||||
</managerEventInstance>
|
||||
</managerEvent>
|
||||
***/
|
||||
manager_event(EVENT_FLAG_DTMF, "DTMFBegin",
|
||||
"%s"
|
||||
|
@ -937,27 +939,29 @@ static void channel_dtmf_end_cb(void *data, struct stasis_subscription *sub,
|
|||
}
|
||||
|
||||
/*** DOCUMENTATION
|
||||
<managerEventInstance>
|
||||
<synopsis>Raised when a DTMF digit has ended on a channel.</synopsis>
|
||||
<syntax>
|
||||
<channel_snapshot/>
|
||||
<parameter name="Digit">
|
||||
<para>DTMF digit received or transmitted (0-9, A-E, # or *</para>
|
||||
</parameter>
|
||||
<parameter name="DurationMs">
|
||||
<para>Duration (in milliseconds) DTMF was sent/received</para>
|
||||
</parameter>
|
||||
<parameter name="Direction">
|
||||
<enumlist>
|
||||
<enum name="Received"/>
|
||||
<enum name="Sent"/>
|
||||
</enumlist>
|
||||
</parameter>
|
||||
</syntax>
|
||||
<see-also>
|
||||
<ref type="managerEvent">DTMFBegin</ref>
|
||||
</see-also>
|
||||
</managerEventInstance>
|
||||
<managerEvent language="en_US" name="DTMFEnd">
|
||||
<managerEventInstance class="EVENT_FLAG_DTMF">
|
||||
<synopsis>Raised when a DTMF digit has ended on a channel.</synopsis>
|
||||
<syntax>
|
||||
<channel_snapshot/>
|
||||
<parameter name="Digit">
|
||||
<para>DTMF digit received or transmitted (0-9, A-E, # or *</para>
|
||||
</parameter>
|
||||
<parameter name="DurationMs">
|
||||
<para>Duration (in milliseconds) DTMF was sent/received</para>
|
||||
</parameter>
|
||||
<parameter name="Direction">
|
||||
<enumlist>
|
||||
<enum name="Received"/>
|
||||
<enum name="Sent"/>
|
||||
</enumlist>
|
||||
</parameter>
|
||||
</syntax>
|
||||
<see-also>
|
||||
<ref type="managerEvent">DTMFBegin</ref>
|
||||
</see-also>
|
||||
</managerEventInstance>
|
||||
</managerEvent>
|
||||
***/
|
||||
manager_event(EVENT_FLAG_DTMF, "DTMFEnd",
|
||||
"%s"
|
||||
|
@ -979,6 +983,16 @@ static void channel_flash_cb(void *data, struct stasis_subscription *sub,
|
|||
return;
|
||||
}
|
||||
|
||||
/*** DOCUMENTATION
|
||||
<managerEvent language="en_US" name="Flash">
|
||||
<managerEventInstance class="EVENT_FLAG_CALL">
|
||||
<synopsis>Raised when a hook flash occurs on a channel.</synopsis>
|
||||
<syntax>
|
||||
<channel_snapshot/>
|
||||
</syntax>
|
||||
</managerEventInstance>
|
||||
</managerEvent>
|
||||
***/
|
||||
manager_event(EVENT_FLAG_CALL, "Flash",
|
||||
"%s",
|
||||
ast_str_buffer(channel_event_string));
|
||||
|
|
|
@ -103,33 +103,35 @@ static void mwi_update_cb(void *data, struct stasis_subscription *sub,
|
|||
}
|
||||
|
||||
/*** DOCUMENTATION
|
||||
<managerEventInstance>
|
||||
<synopsis>Raised when the state of messages in a voicemail mailbox
|
||||
has changed or when a channel has finished interacting with a
|
||||
mailbox.</synopsis>
|
||||
<syntax>
|
||||
<channel_snapshot/>
|
||||
<parameter name="Mailbox">
|
||||
<para>The mailbox with the new message, specified as <literal>mailbox</literal>@<literal>context</literal></para>
|
||||
</parameter>
|
||||
<parameter name="Waiting">
|
||||
<para>Whether or not the mailbox has messages waiting for it.</para>
|
||||
</parameter>
|
||||
<parameter name="New">
|
||||
<para>The number of new messages.</para>
|
||||
</parameter>
|
||||
<parameter name="Old">
|
||||
<para>The number of old messages.</para>
|
||||
</parameter>
|
||||
</syntax>
|
||||
<description>
|
||||
<note><para>The Channel related parameters are only present if a
|
||||
channel was involved in the manipulation of a mailbox. If no
|
||||
channel is involved, the parameters are not included with the
|
||||
event.</para>
|
||||
</note>
|
||||
</description>
|
||||
</managerEventInstance>
|
||||
<managerEvent language="en_US" name="MessageWaiting">
|
||||
<managerEventInstance class="EVENT_FLAG_CALL">
|
||||
<synopsis>Raised when the state of messages in a voicemail mailbox
|
||||
has changed or when a channel has finished interacting with a
|
||||
mailbox.</synopsis>
|
||||
<syntax>
|
||||
<channel_snapshot/>
|
||||
<parameter name="Mailbox">
|
||||
<para>The mailbox with the new message, specified as <literal>mailbox</literal>@<literal>context</literal></para>
|
||||
</parameter>
|
||||
<parameter name="Waiting">
|
||||
<para>Whether or not the mailbox has messages waiting for it.</para>
|
||||
</parameter>
|
||||
<parameter name="New">
|
||||
<para>The number of new messages.</para>
|
||||
</parameter>
|
||||
<parameter name="Old">
|
||||
<para>The number of old messages.</para>
|
||||
</parameter>
|
||||
</syntax>
|
||||
<description>
|
||||
<note><para>The Channel related parameters are only present if a
|
||||
channel was involved in the manipulation of a mailbox. If no
|
||||
channel is involved, the parameters are not included with the
|
||||
event.</para>
|
||||
</note>
|
||||
</description>
|
||||
</managerEventInstance>
|
||||
</managerEvent>
|
||||
***/
|
||||
manager_event(EVENT_FLAG_CALL, "MessageWaiting",
|
||||
"%s"
|
||||
|
|
Loading…
Reference in New Issue