Chan.hangup
From Yate Documentation
(Difference between revisions)
(Created page with " The chan.hangup message is sent by channel modules when a channel is hung up - typically this is the last message ever seen about that channel. Normally these messages are q...") |
(→Optional parameters) |
||
(2 intermediate revisions by one user not shown) | |||
Line 6: | Line 6: | ||
=== Mandatory parameters === | === Mandatory parameters === | ||
− | driver | + | '''driver''' |
:::name of the module that created the instance | :::name of the module that created the instance | ||
− | id | + | '''id''' |
− | :::unique channel identifier | + | :::unique channel identifier |
=== Optional parameters === | === Optional parameters === | ||
− | targetid | + | '''targetid''' |
:::the identifier of the other channel to which this one was connected to | :::the identifier of the other channel to which this one was connected to | ||
− | reason | + | '''reason''' |
:::textual hangup reason | :::textual hangup reason | ||
'''Note:''' that helper channels like Tone Generator and Wave File do not emit this message. External modules also have to emit it themselves. | '''Note:''' that helper channels like Tone Generator and Wave File do not emit this message. External modules also have to emit it themselves. | ||
+ | |||
+ | |||
+ | '''See also''' | ||
+ | |||
+ | *[[chan.masquerade]] |
Latest revision as of 18:10, 18 January 2013
The chan.hangup message is sent by channel modules when a channel is hung up - typically this is the last message ever seen about that channel.
Normally these messages are queued asynchronously and the module does not wait for them being dispatched. You cannot therefore make assumptions about the channel's state at the time the message is received.
[edit] Mandatory parameters
driver
- name of the module that created the instance
id
- unique channel identifier
[edit] Optional parameters
targetid
- the identifier of the other channel to which this one was connected to
reason
- textual hangup reason
Note: that helper channels like Tone Generator and Wave File do not emit this message. External modules also have to emit it themselves.
See also