User.login
From Yate Documentation
(Difference between revisions)
(Created page with " The '''user.login''' message is emitted by an authentication token - providing module (e.g. accfile or client). The message is targeted towards channel-providing modules (e.g...") |
Revision as of 15:50, 8 October 2012
The user.login message is emitted by an authentication token - providing module (e.g. accfile or client). The message is targeted towards channel-providing modules (e.g. h323chan or ysipchan).
The message is designed for asynchronous processing (broadcast). A channel module that receives it should immediately return true and initiate changes in local accounts. An user.notify message is later broadcasted to allow account status tracking.
Message parameters
account
- account name that should initiate status change
username
- username of this account
Optional parameters
protocol
- protocol that is to be used by this account; one of H323, SIP or IAX
password
- password that is to be used with this account
formats
- comma-separated list of formats (codecs) that is to be used by this account
number
- phone number that is to be associated with this account
Other protocol-specific parameters may follow.
