User.notify
From Yate Documentation
(Difference between revisions)
(Created page with " The '''user.notify''' message is emitted by channels that support client registration to other servers. It is generated asynchronously every time the registration status of a...") |
(→Message parameters) |
||
| Line 9: | Line 9: | ||
:::account name that generated the notification | :::account name that generated the notification | ||
'''protocol''' | '''protocol''' | ||
| − | :::the protocol that handles the account - '''H323''', '''SIP''' or ''' | + | :::the protocol that handles the account - '''H323''', '''SIP''' or '''IAX''' |
'''registered''' | '''registered''' | ||
:::boolean value indicating the current registration status | :::boolean value indicating the current registration status | ||
Revision as of 13:56, 8 October 2012
The user.notify message is emitted by channels that support client registration to other servers. It is generated asynchronously every time the registration status of an account changes, either because of operating conditions (network failure, server configuration changes) or because of a local account update (an user.login message).
Since the message should be observed by multiple modules all handlers must return false.
Message parameters
account
- account name that generated the notification
protocol
- the protocol that handles the account - H323, SIP or IAX
registered
- boolean value indicating the current registration status
Optional parameters
username
- user name for the account where applicable
reason
- failure or deregistration reason if known
